perforce-cli 0.2.3

A type-safe builder library for spawning Perforce (p4) commands, with compile-time option state isolation and multi-version support.
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
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
use std::path::{Path, PathBuf};
use std::process::{Child, Command, Stdio};

use super::{ExclusiveOption, SubCommand, Unselected};

use crate::global::GlobalOpts;
use crate::spawn::ParameterizedSpawn;

/// The `-f`/`-l` output-format state of `p4 export`.
///
/// Selected with the `format_non_text` (`-f`) or `limit` (`-l`) builder
/// before choosing a checkpoint or journal. These options apply to both
/// checkpoint and journal exports, but not to raw journal output (`-r`).
#[derive(Debug, Clone, Copy, Default)]
pub struct Format {
    format_non_text: bool,

    limit: Option<u64>,
}

/// The `-r` raw-journal state of `p4 export`.
///
/// Selected with the `raw_journal` builder. Raw output applies to journals
/// only, so this state must be followed by a journal selection (`-j`) before
/// the command can be spawned.
#[derive(Debug, Clone, Copy, Default)]
pub struct RawJournal;

/// Checkpoint selection (`-c token`) of `p4 export`.
///
/// Wraps the output-format state `M` ([`Unselected`] or [`Format`]). Only
/// commands in this state, or in the [`Journal`] state, can be spawned.
#[derive(Debug, Clone, Default)]
pub struct CheckPoint<M = Unselected> {
    token: String,

    mode: M,
}

/// Journal selection (`-j token`) of `p4 export`.
///
/// Wraps the output-format state `M` ([`Unselected`], [`Format`], or
/// [`RawJournal`]). Only commands in this state, or in the [`CheckPoint`]
/// state, can be spawned.
#[derive(Debug, Clone, Default)]
pub struct Journal<M = Unselected> {
    token: String,

    mode: M,
}

/// Type-safe builder for `p4 export`.
///
/// # Syntax
///
/// ```text
/// p4 [g-opts] export -c token [-J prefix] [-f] [-l lines] [-F filter]
/// [-T tableexcludelist] [-P filterpattern]
///
/// p4 [g-opts] export -j token [-J prefix] [-f] [-l lines] [-F filter]
/// [-T tableexcludelist] [-P filterpattern]
///
/// p4 [g-opts] export -j token [-J prefix] -r [-F filter]
/// [-T tableexcludelist] [-P filterpattern]
/// ```
///
/// Extract journal or checkpoint records.
///
#[cfg_attr(
    feature = "lt2017_1",
    doc = "This command reports checkpoint and journal metadata from a Perforce server. With no options, the records are reported in tagged form."
)]
#[cfg_attr(
    all(feature = "lt2017_2", not(feature = "lt2017_1")),
    doc = "This command reports checkpoint and journal metadata from a Helix Core server. With no options, the records are reported in tagged form."
)]
#[cfg_attr(
    all(feature = "lt2019_1", not(feature = "lt2017_2")),
    doc = "This command reports checkpoint and journal metadata from a Helix Server server. With no options, the records are reported in tagged form."
)]
#[cfg_attr(
    all(feature = "lt2021_1", not(feature = "lt2019_1")),
    doc = "This command reports checkpoint and journal metadata from a Helix server server. With no options, the records are reported in tagged form."
)]
#[cfg_attr(
    all(feature = "lt2024_1", not(feature = "lt2021_1")),
    doc = "This command reports checkpoint and journal metadata from a Helix Server server. With no options, the records are reported in tagged form."
)]
#[cfg_attr(
    all(feature = "lt2024_2", not(feature = "lt2024_1")),
    doc = "This command reports checkpoint and journal metadata from a Helix Core Server server. With no options, the records are reported in tagged form."
)]
#[cfg_attr(
    not(feature = "lt2024_2"),
    doc = "This command reports checkpoint and journal metadata from a P4 Server server. With no options, the records are reported in tagged form."
)]
///
/// Some fields are added to the tagged output to indicate either
/// transactional consistency, or to indicate the end of the journal.
///
#[cfg_attr(
    feature = "lt2014_2",
    doc = "To filter database tables out of the exported data, use the `-T` flag with a list of tables whose data you wish to exclude. To exclude data from multiple tables, separate the table names by spaces or commas. The table names must begin with \"db.\", following the naming convention used for database files in the server root directory. If you separate the table exclusion list with spaces, you must enclose the list in quotes."
)]
#[cfg_attr(
    not(feature = "lt2014_2"),
    doc = "To filter database tables out of the exported data, use the `-T` option with a list of tables whose data you wish to exclude. To exclude data from multiple tables, separate the table names by spaces or commas. The table names must begin with \"db.\", following the naming convention used for database files in the server root directory. If you separate the table exclusion list with spaces, you must enclose the list in quotes."
)]
///
#[cfg_attr(feature = "lt2024_1", doc = "# Usage Notes")]
#[cfg_attr(not(feature = "lt2024_1"), doc = "# Usage notes")]
///
/// Can File Arguments Use Revision Specifier? N/A
///
/// Can File Arguments Use Revision Range? N/A
///
/// Minimal Access Level Required: `super`
#[cfg_attr(not(feature = "lt2022_2"), doc = "available to an service user")]
///
/// Compressed journals or checkpoints are not supported.
///
/// The `M` type parameter tracks the option state at compile time.
/// [`Unselected`] selects neither `-c` nor `-j`; `format_non_text` (`-f`) and
/// `limit` (`-l`) enter the [`Format`] state, and `raw_journal` (`-r`)
/// enters the [`RawJournal`] state. Only `checkpoint` (`-c`) and `journal`
/// (`-j`) enter the [`CheckPoint`] and [`Journal`] states, which are the
/// only states implementing [`ParameterizedSpawn`], so a partially
/// configured command cannot be spawned.
#[derive(Debug, Clone, Default)]
pub struct Export<M = Unselected> {
    bin: PathBuf,

    global_opts: GlobalOpts,

    prefix: Option<String>,

    filter: Option<String>,

    excluded_tables: Option<Vec<String>>,

    filter_patterns: Option<Vec<String>>,

    mode: M,
}

// ---------------------------------------------------------------------------
// Mode selection
// ---------------------------------------------------------------------------

impl Export<Unselected> {
    /// Creates a new `p4 export` command.
    ///
    /// `bin` is the path to the Perforce command-line executable. The
    /// resulting command has neither `-c` nor `-j` selected and cannot be
    /// spawned until a checkpoint or journal is selected.
    pub fn new(bin: impl Into<PathBuf>, global_opts: GlobalOpts) -> Self {
        Self {
            bin: bin.into(),
            global_opts,
            prefix: None,
            filter: None,
            excluded_tables: None,
            filter_patterns: None,
            mode: Unselected,
        }
    }

    /// # Description
    ///
    /// `-c token`
    ///
    /// Specifies a checkpoint number or position token of the form
    /// `checkpointnum#byteoffset`.
    ///
    /// Transitions this command to the [`CheckPoint`] state, which spawns.
    pub fn checkpoint(self, token: impl Into<String>) -> Export<CheckPoint<Unselected>> {
        self.map_mode(|mode| CheckPoint {
            token: token.into(),
            mode,
        })
    }

    /// # Description
    ///
    /// `-j token`
    ///
    /// Specify a journal number or position token of the form
    /// `journalnum/byteoffset`.
    ///
    /// Transitions this command to the [`Journal`] state, which spawns.
    pub fn journal(self, token: impl Into<String>) -> Export<Journal<Unselected>> {
        self.map_mode(|mode| Journal {
            token: token.into(),
            mode,
        })
    }

    /// # Description
    ///
    /// `-f`
    ///
    /// Format the output so that non-textual datatypes are formatted
    /// appropriately.
    ///
    /// Transitions this command to the [`Format`] state; a checkpoint or
    /// journal must still be selected before spawning.
    pub fn format_non_text(self) -> Export<Format> {
        self.with_mode(Format {
            format_non_text: true,
            limit: None,
        })
    }

    /// # Description
    ///
    /// `-l lines`
    ///
    /// Limit output to the specified number of lines of journal records.
    ///
    /// Transitions this command to the [`Format`] state; a checkpoint or
    /// journal must still be selected before spawning.
    pub fn limit(self, lines: u64) -> Export<Format> {
        self.with_mode(Format {
            format_non_text: false,
            limit: Some(lines),
        })
    }

    /// # Description
    ///
    /// `-r`
    ///
    /// Display raw journal output; this argument applies to journals only.
    ///
    /// Transitions this command to the [`RawJournal`] state; a journal must
    /// still be selected with `journal` (`-j`) before spawning.
    pub fn raw_journal(self) -> Export<RawJournal> {
        self.with_mode(RawJournal)
    }
}

impl Export<Format> {
    /// # Description
    ///
    /// `-f`
    ///
    /// Format the output so that non-textual datatypes are formatted
    /// appropriately.
    pub fn get_format_non_text(&self) -> bool {
        self.mode.format_non_text
    }

    /// # Description
    ///
    /// `-f`
    ///
    /// Format the output so that non-textual datatypes are formatted
    /// appropriately.
    pub fn set_format_non_text(&mut self, v: bool) -> &mut Self {
        self.mode.format_non_text = v;
        self
    }

    /// # Description
    ///
    /// `-f`
    ///
    /// Format the output so that non-textual datatypes are formatted
    /// appropriately.
    pub fn format_non_text(mut self, v: bool) -> Self {
        self.mode.format_non_text = v;
        self
    }

    /// # Description
    ///
    /// `-l lines`
    ///
    /// Limit output to the specified number of lines of journal records.
    pub fn get_limit(&self) -> Option<u64> {
        self.mode.limit
    }

    /// # Description
    ///
    /// `-l lines`
    ///
    /// Limit output to the specified number of lines of journal records.
    pub fn set_limit(&mut self, v: Option<u64>) -> &mut Self {
        self.mode.limit = v;
        self
    }

    /// # Description
    ///
    /// `-l lines`
    ///
    /// Limit output to the specified number of lines of journal records.
    pub fn limit(mut self, v: u64) -> Self {
        self.mode.limit = Some(v);
        self
    }

    /// # Description
    ///
    /// `-c token`
    ///
    /// Specifies a checkpoint number or position token of the form
    /// `checkpointnum#byteoffset`.
    ///
    /// Transitions this command to the [`CheckPoint`] state, which spawns.
    pub fn checkpoint(self, token: impl Into<String>) -> Export<CheckPoint<Format>> {
        self.map_mode(|mode| CheckPoint {
            token: token.into(),
            mode,
        })
    }

    /// # Description
    ///
    /// `-j token`
    ///
    /// Specify a journal number or position token of the form
    /// `journalnum/byteoffset`.
    ///
    /// Transitions this command to the [`Journal`] state, which spawns.
    pub fn journal(self, token: impl Into<String>) -> Export<Journal<Format>> {
        self.map_mode(|mode| Journal {
            token: token.into(),
            mode,
        })
    }
}

impl Export<RawJournal> {
    /// # Description
    ///
    /// `-j token`
    ///
    /// Specify a journal number or position token of the form
    /// `journalnum/byteoffset`.
    ///
    /// Transitions this command to the [`Journal`] state, which spawns.
    pub fn journal(self, token: impl Into<String>) -> Export<Journal<RawJournal>> {
        self.map_mode(|mode| Journal {
            token: token.into(),
            mode,
        })
    }
}

// ---------------------------------------------------------------------------
// Common options, command path, and state helpers
// ---------------------------------------------------------------------------

impl<M> Export<M> {
    fn with_mode<N>(self, mode: N) -> Export<N> {
        Export {
            bin: self.bin,
            global_opts: self.global_opts,
            prefix: self.prefix,
            filter: self.filter,
            excluded_tables: self.excluded_tables,
            filter_patterns: self.filter_patterns,
            mode,
        }
    }

    fn map_mode<N>(self, f: impl FnOnce(M) -> N) -> Export<N> {
        Export {
            bin: self.bin,
            global_opts: self.global_opts,
            prefix: self.prefix,
            filter: self.filter,
            excluded_tables: self.excluded_tables,
            filter_patterns: self.filter_patterns,
            mode: f(self.mode),
        }
    }

    /// Get the Perforce command path.
    pub fn get_bin(&self) -> &Path {
        &self.bin
    }

    /// Set the Perforce command path.
    pub fn set_bin(&mut self, bin: impl Into<PathBuf>) -> &mut Self {
        self.bin = bin.into();
        self
    }

    /// Set the Perforce command path.
    pub fn bin(mut self, bin: impl Into<PathBuf>) -> Self {
        self.set_bin(bin);
        self
    }

    /// # Description
    ///
    /// `-J prefix`
    ///
    /// Specifies a filename prefix for the journal, such as that used with
    /// `p4d -jc prefix`.
    pub fn get_prefix(&self) -> Option<&str> {
        self.prefix.as_deref()
    }

    /// # Description
    ///
    /// `-J prefix`
    ///
    /// Specifies a filename prefix for the journal, such as that used with
    /// `p4d -jc prefix`.
    pub fn set_prefix(&mut self, v: impl Into<String>) -> &mut Self {
        self.prefix = Some(v.into());
        self
    }

    /// # Description
    ///
    /// `-J prefix`
    ///
    /// Specifies a filename prefix for the journal, such as that used with
    /// `p4d -jc prefix`.
    pub fn prefix(mut self, v: impl Into<String>) -> Self {
        self.set_prefix(v);
        self
    }

    /// # Description
    ///
    /// `-F filter`
    ///
    /// Limit output to records that match the specified filter pattern. For
    /// example, `-F "table = db.configure"`.
    pub fn get_filter(&self) -> Option<&str> {
        self.filter.as_deref()
    }

    /// # Description
    ///
    /// `-F filter`
    ///
    /// Limit output to records that match the specified filter pattern. For
    /// example, `-F "table = db.configure"`.
    pub fn set_filter(&mut self, v: impl Into<String>) -> &mut Self {
        self.filter = Some(v.into());
        self
    }

    /// # Description
    ///
    /// `-F filter`
    ///
    /// Limit output to records that match the specified filter pattern. For
    /// example, `-F "table = db.configure"`.
    pub fn filter(mut self, v: impl Into<String>) -> Self {
        self.set_filter(v);
        self
    }

    /// # Description
    ///
    /// `-T tableexcludelist`
    ///
    /// Supply a list of database tables (for example, `db.have` and
    /// `db.client`) to exclude from export. Limit output to records that
    /// match the specified filter pattern. For example,
    /// `-T db.have,db.client` or `-T "db.have db.client"`.
    pub fn get_excluded_tables(&self) -> Option<&[String]> {
        self.excluded_tables.as_deref()
    }

    /// # Description
    ///
    /// `-T tableexcludelist`
    ///
    /// Supply a list of database tables (for example, `db.have` and
    /// `db.client`) to exclude from export. Limit output to records that
    /// match the specified filter pattern. For example,
    /// `-T db.have,db.client` or `-T "db.have db.client"`.
    pub fn set_excluded_tables(&mut self, v: Vec<String>) -> &mut Self {
        self.excluded_tables = Some(v);
        self
    }

    /// # Description
    ///
    /// `-T tableexcludelist`
    ///
    /// Supply a list of database tables (for example, `db.have` and
    /// `db.client`) to exclude from export. Limit output to records that
    /// match the specified filter pattern. For example,
    /// `-T db.have,db.client` or `-T "db.have db.client"`.
    pub fn excluded_tables(mut self, v: Vec<String>) -> Self {
        self.set_excluded_tables(v);
        self
    }

    /// # Description
    ///
    /// `-P filterpattern`
    ///
    /// Limit output to records that match the specified filter pattern.
    #[cfg_attr(
        feature = "lt2014_2",
        doc = "Multiple filter patterns can be specified with multiple `-P` flags."
    )]
    #[cfg_attr(
        not(feature = "lt2014_2"),
        doc = "Multiple filter patterns can be specified with multiple `-P` options."
    )]
    ///
    /// Each `filterpattern` begins with two characters and a colon, and
    /// specifies either a client filter or a depot filter, as well as whether
    /// the pattern is to be included or excluded, using the syntax:
    ///
    /// ```text
    /// -Pic://client/pattern - client records to include
    /// -Pxc://client/pattern - client records to exclude
    /// -Pif://depot/pattern - depot records to include
    /// -Pxf://depot/pattern - depot records to exclude
    /// ```
    ///
    /// The first character specifies whether the records are included or
    /// excluded (`i` or `x`), the second character specifies whether the
    /// records are client workspace-related or depot-file related (`c` or
    /// `f`), the colon is a separator, and the remainder of the
    /// `filterpattern` denotes either a client workspace view or a depot file
    /// path.
    #[cfg_attr(
        feature = "lt2024_1",
        doc = "The mechanism by which this filtering is implemented is the same as that which is used by the `ClientDataFilter:` and `RevisionDataFilter:` fields in the `p4 server` form."
    )]
    #[cfg_attr(
        not(feature = "lt2024_1"),
        doc = "The mechanism by which this filtering is implemented is the same as that which is used by the `ClientDataFilter:` and `RevisionDataFilter` fields in the `p4 server` form."
    )]
    pub fn get_filter_patterns(&self) -> Option<&[String]> {
        self.filter_patterns.as_deref()
    }

    /// # Description
    ///
    /// `-P filterpattern`
    ///
    /// Limit output to records that match the specified filter pattern.
    /// This option can be specified more than once; each call appends
    /// another pattern.
    ///
    /// See `get_filter_patterns` for the pattern syntax.
    pub fn set_filter_pattern(&mut self, v: impl Into<String>) -> &mut Self {
        self.filter_patterns
            .get_or_insert_with(Vec::new)
            .push(v.into());
        self
    }

    /// # Description
    ///
    /// `-P filterpattern`
    ///
    /// Limit output to records that match the specified filter pattern.
    /// This option can be specified more than once; each call appends
    /// another pattern.
    ///
    /// See `get_filter_patterns` for the pattern syntax.
    pub fn filter_pattern(mut self, v: impl Into<String>) -> Self {
        self.set_filter_pattern(v);
        self
    }
}

impl<M> Export<CheckPoint<M>> {
    /// Get the checkpoint number or position token.
    pub fn get_token(&self) -> &str {
        &self.mode.token
    }

    /// Set the checkpoint number or position token.
    pub fn set_token(&mut self, v: impl Into<String>) -> &mut Self {
        self.mode.token = v.into();
        self
    }

    /// Set the checkpoint number or position token.
    pub fn token(mut self, v: impl Into<String>) -> Self {
        self.set_token(v);
        self
    }
}

impl<M> Export<Journal<M>> {
    /// Get the journal number or position token.
    pub fn get_token(&self) -> &str {
        &self.mode.token
    }

    /// Set the journal number or position token.
    pub fn set_token(&mut self, v: impl Into<String>) -> &mut Self {
        self.mode.token = v.into();
        self
    }

    /// Set the journal number or position token.
    pub fn token(mut self, v: impl Into<String>) -> Self {
        self.set_token(v);
        self
    }
}

// ---------------------------------------------------------------------------
// Argument injection
// ---------------------------------------------------------------------------

impl ExclusiveOption for Format {
    fn inject_args(&self, command: &mut Command) {
        if self.format_non_text {
            command.arg("-f");
        }

        if let Some(lines) = self.limit {
            command.arg("-l").arg(lines.to_string());
        }
    }
}

impl ExclusiveOption for RawJournal {
    fn inject_args(&self, command: &mut Command) {
        command.arg("-r");
    }
}

impl<M: ExclusiveOption> ExclusiveOption for CheckPoint<M> {
    fn inject_args(&self, command: &mut Command) {
        command.arg("-c").arg(&self.token);
        self.mode.inject_args(command);
    }
}

impl<M: ExclusiveOption> ExclusiveOption for Journal<M> {
    fn inject_args(&self, command: &mut Command) {
        command.arg("-j").arg(&self.token);
        self.mode.inject_args(command);
    }
}

impl<M: ExclusiveOption> SubCommand for Export<M> {
    fn name(&self) -> &str {
        "export"
    }

    fn inject_local_args(&self, command: &mut Command) {
        self.mode.inject_args(command);

        if let Some(prefix) = &self.prefix {
            command.arg("-J").arg(prefix);
        }

        if let Some(filter) = &self.filter {
            command.arg("-F").arg(filter);
        }

        if let Some(tables) = &self.excluded_tables {
            command.arg("-T").arg(tables.join(","));
        }

        if let Some(patterns) = &self.filter_patterns {
            for pattern in patterns {
                command.arg("-P").arg(pattern);
            }
        }
    }

    fn global_opts(&self) -> Option<&GlobalOpts> {
        Some(&self.global_opts)
    }
}

// ---------------------------------------------------------------------------
// Spawning
// ---------------------------------------------------------------------------

impl<M: ExclusiveOption> ParameterizedSpawn<()> for Export<CheckPoint<M>> {
    type Output = Child;
    type Error = std::io::Error;

    /// Spawns `p4 export -c token` as a child process with piped standard
    /// output and error streams; use the returned [`Child`] handle to wait
    /// for it or interact with it.
    fn spawn_with(&mut self, (): ()) -> Result<Self::Output, Self::Error> {
        self.setup_command(&self.bin)
            .stdout(Stdio::piped())
            .stderr(Stdio::piped())
            .spawn()
    }
}

impl<M: ExclusiveOption> ParameterizedSpawn<()> for Export<Journal<M>> {
    type Output = Child;
    type Error = std::io::Error;

    /// Spawns `p4 export -j token` as a child process with piped standard
    /// output and error streams; use the returned [`Child`] handle to wait
    /// for it or interact with it.
    fn spawn_with(&mut self, (): ()) -> Result<Self::Output, Self::Error> {
        self.setup_command(&self.bin)
            .stdout(Stdio::piped())
            .stderr(Stdio::piped())
            .spawn()
    }
}

// ---------------------------------------------------------------------------
// Global options
// ---------------------------------------------------------------------------

impl<M: ExclusiveOption> Export<M> {
    /// # Description
    ///
    /// g-opts
    ///
    #[cfg_attr(
        feature = "lt2014_2",
        doc = "See the [Global Options](GlobalOpts) section."
    )]
    #[cfg_attr(
        all(feature = "lt2015_1", not(feature = "lt2014_2")),
        doc = "See the [“Global Options”](GlobalOpts) section."
    )]
    #[cfg_attr(
        all(feature = "lt2017_1", not(feature = "lt2015_1")),
        doc = "See [“Global Options”](GlobalOpts)."
    )]
    #[cfg_attr(
        all(feature = "lt2018_2", not(feature = "lt2017_1")),
        doc = "See [Global Options](GlobalOpts)."
    )]
    #[cfg_attr(not(feature = "lt2018_2"), doc = "See [Global options](GlobalOpts).")]
    pub fn get_global_opts(&self) -> &GlobalOpts {
        &self.global_opts
    }

    /// # Description
    ///
    /// g-opts
    ///
    #[cfg_attr(
        feature = "lt2014_2",
        doc = "See the [Global Options](GlobalOpts) section."
    )]
    #[cfg_attr(
        all(feature = "lt2015_1", not(feature = "lt2014_2")),
        doc = "See the [“Global Options”](GlobalOpts) section."
    )]
    #[cfg_attr(
        all(feature = "lt2017_1", not(feature = "lt2015_1")),
        doc = "See [“Global Options”](GlobalOpts)."
    )]
    #[cfg_attr(
        all(feature = "lt2018_2", not(feature = "lt2017_1")),
        doc = "See [Global Options](GlobalOpts)."
    )]
    #[cfg_attr(not(feature = "lt2018_2"), doc = "See [Global options](GlobalOpts).")]
    pub fn set_global_opts(&mut self, v: GlobalOpts) -> &mut Self {
        self.global_opts = v;
        self
    }

    /// # Description
    ///
    /// g-opts
    ///
    #[cfg_attr(
        feature = "lt2014_2",
        doc = "See the [Global Options](GlobalOpts) section."
    )]
    #[cfg_attr(
        all(feature = "lt2015_1", not(feature = "lt2014_2")),
        doc = "See the [“Global Options”](GlobalOpts) section."
    )]
    #[cfg_attr(
        all(feature = "lt2017_1", not(feature = "lt2015_1")),
        doc = "See [“Global Options”](GlobalOpts)."
    )]
    #[cfg_attr(
        all(feature = "lt2018_2", not(feature = "lt2017_1")),
        doc = "See [Global Options](GlobalOpts)."
    )]
    #[cfg_attr(not(feature = "lt2018_2"), doc = "See [Global options](GlobalOpts).")]
    pub fn global_opts(mut self, v: GlobalOpts) -> Self {
        self.set_global_opts(v);
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::cmd::args_of;

    fn args(cmd: &impl SubCommand) -> Vec<String> {
        args_of(&cmd.setup_command("p4"))
    }

    /// Dry-run checks of the assembled `p4 export` command line; no process
    /// is spawned.
    #[test]
    fn without_selection_has_no_options() {
        let cmd = Export::new("p4", GlobalOpts::new());

        assert_eq!(args(&cmd), ["export"]);
    }

    #[test]
    fn format_state_injects_flags_before_selection() {
        assert_eq!(
            args(&Export::new("p4", GlobalOpts::new()).format_non_text()),
            ["export", "-f"]
        );
        assert_eq!(
            args(&Export::new("p4", GlobalOpts::new()).limit(12)),
            ["export", "-l", "12"]
        );
    }

    #[test]
    fn raw_journal_state_injects_flag_before_selection() {
        assert_eq!(
            args(&Export::new("p4", GlobalOpts::new()).raw_journal()),
            ["export", "-r"]
        );
    }

    #[test]
    fn bare_checkpoint_and_journal() {
        assert_eq!(
            args(&Export::new("p4", GlobalOpts::new()).checkpoint("3")),
            ["export", "-c", "3"]
        );
        assert_eq!(
            args(&Export::new("p4", GlobalOpts::new()).journal("7")),
            ["export", "-j", "7"]
        );
    }

    #[test]
    fn checkpoint_with_all_options() {
        let cmd = Export::new("p4", GlobalOpts::new())
            .prefix("backup")
            .format_non_text()
            .limit(10)
            .filter("table = db.configure")
            .excluded_tables(vec!["db.have".to_string(), "db.client".to_string()])
            .filter_pattern("ic://client/depot/main")
            .filter_pattern("xf://depot/secret")
            .checkpoint("3");

        assert_eq!(
            args(&cmd),
            [
                "export",
                "-c",
                "3",
                "-f",
                "-l",
                "10",
                "-J",
                "backup",
                "-F",
                "table = db.configure",
                "-T",
                "db.have,db.client",
                "-P",
                "ic://client/depot/main",
                "-P",
                "xf://depot/secret",
            ]
        );
    }

    #[test]
    fn raw_journal_with_options() {
        let cmd = Export::new("p4", GlobalOpts::new())
            .prefix("backup")
            .excluded_tables(vec!["db.have".to_string()])
            .filter_pattern("if://depot/main")
            .raw_journal()
            .journal("7");

        assert_eq!(
            args(&cmd),
            [
                "export",
                "-j",
                "7",
                "-r",
                "-J",
                "backup",
                "-T",
                "db.have",
                "-P",
                "if://depot/main",
            ]
        );
    }

    #[test]
    fn global_opts_are_injected_once() {
        let cmd = Export::new(
            "p4",
            GlobalOpts::new().port("localhost:1666").quiet_mode(true),
        )
        .journal("7");

        assert_eq!(
            args(&cmd),
            ["-p", "localhost:1666", "-q", "export", "-j", "7"]
        );
    }

    #[test]
    fn token_accessors_update_selection() {
        let mut cmd = Export::new("p4", GlobalOpts::new()).checkpoint("3");
        assert_eq!(cmd.get_token(), "3");

        cmd.set_token("12#4");
        assert_eq!(cmd.get_token(), "12#4");
        assert_eq!(args(&cmd), ["export", "-c", "12#4"]);

        let cmd = cmd.token("5");
        assert_eq!(args(&cmd), ["export", "-c", "5"]);
    }

    #[test]
    fn format_accessors_update_options() {
        let mut cmd = Export::new("p4", GlobalOpts::new()).format_non_text();
        assert!(cmd.get_format_non_text());
        assert_eq!(cmd.get_limit(), None);

        cmd.set_format_non_text(false);
        cmd.set_limit(Some(5));
        assert!(!cmd.get_format_non_text());
        assert_eq!(cmd.get_limit(), Some(5));
        assert_eq!(args(&cmd), ["export", "-l", "5"]);

        let cmd = cmd.limit(9).format_non_text(true);
        assert_eq!(args(&cmd), ["export", "-f", "-l", "9"]);
    }

    #[test]
    fn bin_accessors_update_executable_path() {
        let mut cmd = Export::new("p4", GlobalOpts::new()).journal("7");
        assert_eq!(cmd.get_bin(), Path::new("p4"));

        cmd.set_bin("/usr/local/bin/p4");
        assert_eq!(cmd.get_bin(), Path::new("/usr/local/bin/p4"));

        let cmd = cmd.bin("p4.exe");
        assert_eq!(cmd.get_bin(), Path::new("p4.exe"));
    }
}