rmux-core 0.2.0

Core session, pane, layout, format, hook, and buffer model for the RMUX terminal multiplexer.
Documentation
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
use std::collections::HashMap;

use rmux_proto::types::OptionScopeSelector;
use rmux_proto::{OptionName, PaneTarget, SessionName, WindowTarget};

use super::mutation::{
    default_array_items, default_scalar_text, normalize_scalar_value, split_array_assignment,
};
use super::registry::{option_metadata, registry, resolve_option_name, DefaultValue, GlobalRoot};
use super::render::format_rendered_option_value;
use super::scope::{
    push_known_global_roots, scope_allows_pane, scope_allows_session, scope_allows_window,
    ResolveContext,
};
use super::storage::{OptionEntry, OptionNode};
use super::{OptionQuery, OptionStore};

impl OptionStore {
    /// Returns the exact explicit global value for the given known option.
    #[must_use]
    pub fn global_value(&self, option: OptionName) -> Option<&str> {
        let query = OptionQuery::known(option);
        self.node_for_global_root(option_metadata(option).global_root())
            .and_then(|node| node.value(query.canonical_name(), None))
    }

    /// Returns the exact session-local value for the given known option.
    #[must_use]
    pub fn session_value(&self, session_name: &SessionName, option: OptionName) -> Option<&str> {
        let query = OptionQuery::known(option);
        self.sessions
            .get(session_name)
            .and_then(|node| node.value(query.canonical_name(), None))
    }

    /// Returns the exact window-local value for the given known option.
    #[must_use]
    pub fn window_value(&self, target: &WindowTarget, option: OptionName) -> Option<&str> {
        let query = OptionQuery::known(option);
        self.windows
            .get(target)
            .and_then(|node| node.value(query.canonical_name(), None))
    }

    /// Returns the exact pane-local value for the given known option.
    #[must_use]
    pub fn pane_value(&self, target: &PaneTarget, option: OptionName) -> Option<&str> {
        let query = OptionQuery::known(option);
        self.panes
            .get(target)
            .and_then(|node| node.value(query.canonical_name(), None))
    }

    /// Resolves the effective value using the tmux-style parent chain for the known option.
    #[must_use]
    pub fn resolve<'a>(
        &'a self,
        session_name: Option<&'a SessionName>,
        option: OptionName,
    ) -> Option<&'a str> {
        let query = OptionQuery::known(option);
        let resolved = match session_name {
            Some(session_name) => self
                .resolve_query(&ResolveContext::Session(session_name), &query)
                .map(OptionEntry::rendered),
            None => self
                .resolve_query(&ResolveContext::Server, &query)
                .map(OptionEntry::rendered),
        };
        if let Some(resolved) = resolved {
            Some(resolved)
        } else {
            self.default_rendered_value(&query)
        }
    }

    /// Resolves the effective window value using the tmux-style parent chain.
    #[must_use]
    pub fn resolve_for_window<'a>(
        &'a self,
        session_name: &'a SessionName,
        window_index: u32,
        option: OptionName,
    ) -> Option<&'a str> {
        let query = OptionQuery::known(option);
        let resolved = self
            .resolve_query(&ResolveContext::Window(session_name, window_index), &query)
            .map(OptionEntry::rendered);
        if let Some(resolved) = resolved {
            Some(resolved)
        } else {
            self.default_rendered_value(&query)
        }
    }

    /// Resolves the effective pane value using the tmux-style parent chain.
    #[must_use]
    pub fn resolve_for_pane<'a>(
        &'a self,
        session_name: &'a SessionName,
        window_index: u32,
        pane_index: u32,
        option: OptionName,
    ) -> Option<&'a str> {
        let query = OptionQuery::known(option);
        let resolved = self
            .resolve_query(
                &ResolveContext::Pane(session_name, window_index, pane_index),
                &query,
            )
            .map(OptionEntry::rendered);
        if let Some(resolved) = resolved {
            Some(resolved)
        } else {
            self.default_rendered_value(&query)
        }
    }

    /// Resolves the effective array values for the known option.
    #[must_use]
    pub fn resolve_array_values(
        &self,
        session_name: Option<&SessionName>,
        option: OptionName,
    ) -> Vec<String> {
        let query = OptionQuery::known(option);
        if !query.is_array() {
            return Vec::new();
        }

        let resolved = match session_name {
            Some(session_name) => self
                .resolve_query(&ResolveContext::Session(session_name), &query)
                .map(OptionEntry::array_values),
            None => self
                .resolve_query(&ResolveContext::Server, &query)
                .map(OptionEntry::array_values),
        };
        if let Some(resolved) = resolved {
            return resolved;
        }

        match query.default_value() {
            Some(DefaultValue::Scalar(value)) => split_array_assignment(value, query.separator()),
            Some(DefaultValue::Array(values)) => {
                values.iter().map(|value| (*value).to_owned()).collect()
            }
            None => Vec::new(),
        }
    }

    /// Resolves a string-keyed option in a session context.
    #[must_use]
    pub fn resolve_name(&self, session_name: Option<&SessionName>, name: &str) -> Option<String> {
        let query = resolve_option_name(name).ok()?;
        match session_name {
            // tmux format.c::format_find checks server options first, then the
            // context-specific tree, then any wider parents for that context.
            Some(session_name) => self
                .resolve_name_from_nodes(
                    &query,
                    [
                        Some(&self.server_global),
                        self.sessions.get(session_name),
                        Some(&self.session_global),
                    ],
                )
                .or_else(|| self.default_value_as_string(&query)),
            None => self
                .resolve_name_from_nodes(&query, [Some(&self.server_global)])
                .or_else(|| self.default_value_as_string(&query)),
        }
    }

    /// Resolves a string-keyed option for tmux format evaluation in a session context.
    #[must_use]
    pub fn resolve_name_for_format(
        &self,
        session_name: Option<&SessionName>,
        name: &str,
    ) -> Option<String> {
        let query = resolve_option_name(name).ok()?;
        let value = match session_name {
            Some(session_name) => self
                .resolve_name_from_nodes(
                    &query,
                    [
                        Some(&self.server_global),
                        self.sessions.get(session_name),
                        Some(&self.session_global),
                    ],
                )
                .or_else(|| self.default_value_as_string(&query)),
            None => self
                .resolve_name_from_nodes(&query, [Some(&self.server_global)])
                .or_else(|| self.default_value_as_string(&query)),
        }?;
        Some(format_rendered_option_value(&query, value))
    }

    /// Resolves a string-keyed option in a window context.
    #[must_use]
    pub fn resolve_name_for_window(
        &self,
        session_name: &SessionName,
        window_index: u32,
        name: &str,
    ) -> Option<String> {
        let query = resolve_option_name(name).ok()?;
        let target = WindowTarget::with_window(session_name.clone(), window_index);
        self.resolve_name_from_nodes(
            &query,
            [
                Some(&self.server_global),
                self.windows.get(&target),
                Some(&self.window_global),
                self.sessions.get(session_name),
                Some(&self.session_global),
            ],
        )
        .or_else(|| self.default_value_as_string(&query))
    }

    /// Resolves a string-keyed option for tmux format evaluation in a window context.
    #[must_use]
    pub fn resolve_name_for_window_format(
        &self,
        session_name: &SessionName,
        window_index: u32,
        name: &str,
    ) -> Option<String> {
        let query = resolve_option_name(name).ok()?;
        let target = WindowTarget::with_window(session_name.clone(), window_index);
        let value = self
            .resolve_name_from_nodes(
                &query,
                [
                    Some(&self.server_global),
                    self.windows.get(&target),
                    Some(&self.window_global),
                    self.sessions.get(session_name),
                    Some(&self.session_global),
                ],
            )
            .or_else(|| self.default_value_as_string(&query))?;
        Some(format_rendered_option_value(&query, value))
    }

    /// Resolves a string-keyed option in a pane context.
    #[must_use]
    pub fn resolve_name_for_pane(
        &self,
        session_name: &SessionName,
        window_index: u32,
        pane_index: u32,
        name: &str,
    ) -> Option<String> {
        let query = resolve_option_name(name).ok()?;
        let pane_target = PaneTarget::with_window(session_name.clone(), window_index, pane_index);
        let window_target = WindowTarget::with_window(session_name.clone(), window_index);
        self.resolve_name_from_nodes(
            &query,
            [
                Some(&self.server_global),
                self.panes.get(&pane_target),
                self.windows.get(&window_target),
                Some(&self.window_global),
                self.sessions.get(session_name),
                Some(&self.session_global),
            ],
        )
        .or_else(|| self.default_value_as_string(&query))
    }

    /// Resolves a string-keyed option for tmux format evaluation in a pane context.
    #[must_use]
    pub fn resolve_name_for_pane_format(
        &self,
        session_name: &SessionName,
        window_index: u32,
        pane_index: u32,
        name: &str,
    ) -> Option<String> {
        let query = resolve_option_name(name).ok()?;
        let pane_target = PaneTarget::with_window(session_name.clone(), window_index, pane_index);
        let window_target = WindowTarget::with_window(session_name.clone(), window_index);
        let value = self
            .resolve_name_from_nodes(
                &query,
                [
                    Some(&self.server_global),
                    self.panes.get(&pane_target),
                    self.windows.get(&window_target),
                    Some(&self.window_global),
                    self.sessions.get(session_name),
                    Some(&self.session_global),
                ],
            )
            .or_else(|| self.default_value_as_string(&query))?;
        Some(format_rendered_option_value(&query, value))
    }

    /// Returns the option snapshot that future panes in a session should inherit.
    #[must_use]
    pub fn resolved(&self, session_name: &SessionName) -> HashMap<OptionName, String> {
        registry()
            .iter()
            .map(|metadata| {
                let query = OptionQuery::known(metadata.option());
                let value = self
                    .resolve(Some(session_name), metadata.option())
                    .map(str::to_owned)
                    .or_else(|| self.default_value_as_string(&query))
                    .unwrap_or_default();
                (metadata.option(), value)
            })
            .collect()
    }

    /// Returns the option snapshot for a pane after the full inheritance chain is applied.
    #[must_use]
    pub fn resolved_for_pane(
        &self,
        session_name: &SessionName,
        window_index: u32,
        pane_index: u32,
    ) -> HashMap<OptionName, String> {
        registry()
            .iter()
            .map(|metadata| {
                let query = OptionQuery::known(metadata.option());
                let value = self
                    .resolve_for_pane(session_name, window_index, pane_index, metadata.option())
                    .map(str::to_owned)
                    .or_else(|| self.default_value_as_string(&query))
                    .unwrap_or_default();
                (metadata.option(), value)
            })
            .collect()
    }

    pub(super) fn node_for_exact_scope_mut(
        &mut self,
        scope: &OptionScopeSelector,
    ) -> &mut OptionNode {
        match scope {
            OptionScopeSelector::ServerGlobal => &mut self.server_global,
            OptionScopeSelector::SessionGlobal => &mut self.session_global,
            OptionScopeSelector::WindowGlobal => &mut self.window_global,
            OptionScopeSelector::Session(session_name) => {
                self.sessions.entry(session_name.clone()).or_default()
            }
            OptionScopeSelector::Window(target) => self.windows.entry(target.clone()).or_default(),
            OptionScopeSelector::Pane(target) => self.panes.entry(target.clone()).or_default(),
        }
    }

    pub(super) fn node_for_exact_scope(&self, scope: &OptionScopeSelector) -> Option<&OptionNode> {
        match scope {
            OptionScopeSelector::ServerGlobal => Some(&self.server_global),
            OptionScopeSelector::SessionGlobal => Some(&self.session_global),
            OptionScopeSelector::WindowGlobal => Some(&self.window_global),
            OptionScopeSelector::Session(session_name) => self.sessions.get(session_name),
            OptionScopeSelector::Window(target) => self.windows.get(target),
            OptionScopeSelector::Pane(target) => self.panes.get(target),
        }
    }

    pub(super) fn resolve_query<'a>(
        &'a self,
        context: &ResolveContext<'a>,
        query: &OptionQuery,
    ) -> Option<&'a OptionEntry> {
        for node in self.chain_for_context(context, query) {
            if let Some(entry) = node.entry(query.canonical_name()) {
                if query.index().is_none() || entry.value(query.index()).is_some() {
                    return Some(entry);
                }
            }
        }
        None
    }

    pub(super) fn effective_value_for_scope(
        &self,
        scope: &OptionScopeSelector,
        query: &OptionQuery,
    ) -> Option<String> {
        match scope {
            OptionScopeSelector::ServerGlobal => self
                .resolve_query(&ResolveContext::Server, query)
                .and_then(|entry| entry.value(query.index()).map(str::to_owned)),
            OptionScopeSelector::SessionGlobal => self
                .resolve_query(&ResolveContext::SessionGlobal, query)
                .and_then(|entry| entry.value(query.index()).map(str::to_owned)),
            OptionScopeSelector::WindowGlobal => self
                .resolve_query(&ResolveContext::WindowGlobal, query)
                .and_then(|entry| entry.value(query.index()).map(str::to_owned)),
            OptionScopeSelector::Session(session_name) => self
                .resolve_query(&ResolveContext::Session(session_name), query)
                .and_then(|entry| entry.value(query.index()).map(str::to_owned)),
            OptionScopeSelector::Window(target) => self
                .resolve_query(
                    &ResolveContext::Window(target.session_name(), target.window_index()),
                    query,
                )
                .and_then(|entry| entry.value(query.index()).map(str::to_owned)),
            OptionScopeSelector::Pane(target) => self
                .resolve_query(
                    &ResolveContext::Pane(
                        target.session_name(),
                        target.window_index(),
                        target.pane_index(),
                    ),
                    query,
                )
                .and_then(|entry| entry.value(query.index()).map(str::to_owned)),
        }
    }

    pub(super) fn explicit_value_for_scope(
        &self,
        scope: &OptionScopeSelector,
        query: &OptionQuery,
    ) -> Option<String> {
        self.node_for_exact_scope(scope)
            .and_then(|node| node.value(query.canonical_name(), query.index()))
            .map(str::to_owned)
    }

    pub(super) fn default_entry_for_scope(
        &self,
        query: &OptionQuery,
        scope: OptionScopeSelector,
    ) -> Option<OptionEntry> {
        let default = query.default_value()?;

        if query.is_array() {
            let items = default_array_items(query, default).ok()?;
            Some(OptionEntry::new_array(query, scope, items))
        } else {
            let value =
                normalize_scalar_value(query, Some(default_scalar_text(default)), None).ok()?;
            Some(OptionEntry::new_scalar(query, scope, value))
        }
    }

    pub(super) fn default_value_as_string(&self, query: &OptionQuery) -> Option<String> {
        let default = query.default_value()?;
        match default {
            DefaultValue::Scalar(value) => Some(value.to_owned()),
            DefaultValue::Array(values) => Some(values.join(query.separator())),
        }
    }

    fn node_for_global_root(&self, root: GlobalRoot) -> Option<&OptionNode> {
        match root {
            GlobalRoot::Server => Some(&self.server_global),
            GlobalRoot::Session => Some(&self.session_global),
            GlobalRoot::Window => Some(&self.window_global),
        }
    }

    fn chain_for_context<'a>(
        &'a self,
        context: &ResolveContext<'a>,
        query: &OptionQuery,
    ) -> Vec<&'a OptionNode> {
        match context {
            ResolveContext::Server => vec![&self.server_global],
            // tmux global roots are independent; known options resolve to their
            // own global root only. User options cross all roots.
            ResolveContext::SessionGlobal => {
                if query.is_user() {
                    vec![&self.session_global, &self.server_global]
                } else {
                    vec![&self.session_global]
                }
            }
            ResolveContext::WindowGlobal => {
                if query.is_user() {
                    vec![
                        &self.window_global,
                        &self.session_global,
                        &self.server_global,
                    ]
                } else {
                    vec![&self.window_global]
                }
            }
            ResolveContext::Session(session_name) => {
                let mut chain = Vec::new();
                if scope_allows_session(query) {
                    if let Some(node) = self.sessions.get(*session_name) {
                        chain.push(node);
                    }
                }
                push_known_global_roots(&mut chain, self, query);
                chain
            }
            ResolveContext::Window(session_name, window_index) => {
                let mut chain = Vec::new();
                if scope_allows_window(query) {
                    let target = WindowTarget::with_window((*session_name).clone(), *window_index);
                    if let Some(node) = self.windows.get(&target) {
                        chain.push(node);
                    }
                }
                if scope_allows_session(query) {
                    if let Some(node) = self.sessions.get(*session_name) {
                        chain.push(node);
                    }
                }
                push_known_global_roots(&mut chain, self, query);
                chain
            }
            ResolveContext::Pane(session_name, window_index, pane_index) => {
                let mut chain = Vec::new();
                if scope_allows_pane(query) {
                    let pane_target = PaneTarget::with_window(
                        (*session_name).clone(),
                        *window_index,
                        *pane_index,
                    );
                    if let Some(node) = self.panes.get(&pane_target) {
                        chain.push(node);
                    }
                }
                if scope_allows_window(query) {
                    let window_target =
                        WindowTarget::with_window((*session_name).clone(), *window_index);
                    if let Some(node) = self.windows.get(&window_target) {
                        chain.push(node);
                    }
                }
                if scope_allows_session(query) {
                    if let Some(node) = self.sessions.get(*session_name) {
                        chain.push(node);
                    }
                }
                push_known_global_roots(&mut chain, self, query);
                chain
            }
        }
    }

    fn default_rendered_value(&self, query: &OptionQuery) -> Option<&'static str> {
        if query.index().is_some() {
            return None;
        }
        match query.default_value()? {
            DefaultValue::Scalar(value) => Some(value),
            // Array defaults with DefaultValue::Array require a computed join;
            // the static-str callers fall back to default_value_as_string for
            // those options. Currently all array options use Scalar defaults.
            DefaultValue::Array(_) => None,
        }
    }

    fn resolve_name_from_nodes<'a, I>(&self, query: &OptionQuery, nodes: I) -> Option<String>
    where
        I: IntoIterator<Item = Option<&'a OptionNode>>,
    {
        for node in nodes.into_iter().flatten() {
            if let Some(entry) = node.entry(query.canonical_name()) {
                if let Some(value) = entry.value(query.index()) {
                    return Some(value.to_owned());
                }
            }
        }
        None
    }
}