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
#[allow(unused)]
use super::{Sink, Source, SpectrumSource};

/// A macro that dynamically works out how to get a [`SpectrumSource`]-derived object
/// from a path or [`io::Read`](std::io::Read) + [`io::Seek`](std::io::Seek) boxed object.
/// This is meant to be a convenience for working with a scoped file reader
/// without penalty.
///
/// `$source` is coerced into a [`Source`] which the macro in turn probes to determine
/// the appropriate file reading type. This lets you interact with the concrete type intersection
/// without concern with object safety in an anonymous closure:
///
/// ```
/// # use std::io;
/// # use mzdata::prelude::*;
/// # use mzdata::Spectrum;
/// # fn main() -> io::Result<()> {
/// let spectra: Vec<Spectrum> = mzdata::mz_read!("./test/data/small.mzML".as_ref(), reader => { reader.collect() })?;
/// # Ok(())
/// # }
/// ```
/// The closure will return a `std::io::Result` whose success value is inferred from context. The
/// reader's lifetime is bound to the closure, and cannot be extracted without substantial type system
/// torture.
///
/// If you want to use peak types *other than* the simple defaults, pass them as additional parameters after
/// the closure.
#[macro_export]
macro_rules! mz_read {
    ($source:expr, $reader:ident => $impl:tt) => {
        $crate::mz_read!($source, $reader => $impl, mzpeaks::CentroidPeak, mzpeaks::DeconvolutedPeak)
    };
    ($source:expr, $reader:ident => $impl:tt, $C:ty, $D:ty) => {{
        let source = $crate::io::Source::<_, _>::from($source);
        match source {
            $crate::io::Source::PathLike(read_path) => {
                let (format, is_gzipped) = $crate::io::infer_format(&read_path)?;
                match format {
                    $crate::io::MassSpectrometryFormat::MGF => {
                        let handle = std::fs::File::open(read_path)?;
                        if is_gzipped {
                            let fh = $crate::io::RestartableGzDecoder::new(std::io::BufReader::new(handle));
                            #[allow(unused_mut)]
                            let mut $reader: $crate::io::StreamingSpectrumIterator<$C, $D, _, _> = $crate::io::StreamingSpectrumIterator::new($crate::io::mgf::MGFReaderType::<_, $C, $D>::new(fh));
                            Ok($impl)
                        } else {
                            #[allow(unused_mut)]
                            let mut $reader: $crate::io::mgf::MGFReaderType<_, $C, $D> = $crate::io::mgf::MGFReaderType::new_indexed(handle);
                            Ok($impl)
                        }
                    }
                    $crate::io::MassSpectrometryFormat::MzML => {
                        let handle = std::fs::File::open(read_path)?;

                        if is_gzipped {
                            let fh = $crate::io::RestartableGzDecoder::new(std::io::BufReader::new(handle));
                            #[allow(unused_mut)]
                            let mut $reader: $crate::io::StreamingSpectrumIterator<$C, $D, _, _> = $crate::io::StreamingSpectrumIterator::new($crate::io::mzml::MzMLReaderType::<_, $C, $D>::new(fh));
                            Ok($impl)
                        } else {
                            #[allow(unused_mut)]
                            let mut $reader: $crate::io::mzml::MzMLReaderType<_, $C, $D> = $crate::io::mzml::MzMLReaderType::<_, $C, $D>::new_indexed(handle);
                            Ok($impl)
                        }
                    }
                    #[cfg(feature = "mzmlb")]
                    $crate::io::MassSpectrometryFormat::MzMLb => {
                        #[allow(unused_mut)]
                        let mut $reader: $crate::io::mzmlb::MzMLbReaderType<$C, $D> = $crate::io::mzmlb::MzMLbReaderType::<$C, $D>::new(&read_path)?;
                        Ok($impl)
                    },
                    #[cfg(feature = "thermorawfilereader")]
                    $crate::io::MassSpectrometryFormat::ThermoRaw => {
                        #[allow(unused_mut)]
                        let mut $reader: $crate::io::thermo::ThermoRawReaderType<$C, $D> = $crate::io::thermo::ThermoRawReaderType::<$C, $D>::new(&read_path)?;
                        Ok($impl)
                    },
                    _ => Err(std::io::Error::new(
                        std::io::ErrorKind::Unsupported,
                        format!(
                            "Input file format for {} not supported",
                            read_path.display()
                        ),
                    )),
                }
            },
            $crate::io::Source::Reader(mut handle, format) => {
                let (format, is_gzipped) = if let Some(format) = format { (format, false) } else { $crate::io::infer_from_stream(&mut handle)? };
                match format {
                    $crate::io::MassSpectrometryFormat::MGF => {
                        let handle = std::io::BufReader::new(handle);
                        #[allow(unused_mut)]
                        if is_gzipped {
                            let fh = $crate::io::RestartableGzDecoder::new(std::io::BufReader::new(handle));
                            #[allow(unused_mut)]
                            let mut $reader: $crate::io::StreamingSpectrumIterator<$C, $D, _, _> = $crate::io::StreamingSpectrumIterator::new($crate::io::mgf::MGFReaderType::<_, $C, $D>::new(fh));
                            Ok($impl)
                        } else {
                            #[allow(unused_mut)]
                            let mut $reader: $crate::io::mgf::MGFReaderType<_, $C, $D> = $crate::io::mgf::MGFReaderType::new_indexed(handle);
                            Ok($impl)
                        }
                    },
                    $crate::io::MassSpectrometryFormat::MzML => {
                        let handle = std::io::BufReader::new(handle);
                        #[allow(unused_mut)]
                        if is_gzipped {
                            let fh = $crate::io::RestartableGzDecoder::new(std::io::BufReader::new(handle));
                            #[allow(unused_mut)]
                            let mut $reader: $crate::io::StreamingSpectrumIterator<$C, $D, _, _> = $crate::io::StreamingSpectrumIterator::new($crate::io::mzml::MzMLReaderType::<_, $C, $D>::new(fh));
                            Ok($impl)
                        } else {
                            #[allow(unused_mut)]
                            let mut $reader: $crate::io::mzml::MzMLReaderType<_, $C, $D> = $crate::io::mzml::MzMLReaderType::<_, $C, $D>::new_indexed(handle);
                            Ok($impl)
                        }
                    },
                    _ => Err(std::io::Error::new(
                        std::io::ErrorKind::Unsupported,
                        format!(
                            "Input file format for {:?} not supported from an io::Read",
                            format
                        ),
                    )),
                }
            },
            $crate::io::Source::Receiver(receiver) => {
                #[allow(unused_mut)]
                let mut $reader: $crate::io::StreamingSpectrumIterator<$C, $D, _, _> = $crate::io::StreamingSpectrumIterator::new(receiver);
                Ok($impl)
            },
            $crate::io::Source::Stdin => {
                let mut buffered =
                    $crate::io::PreBufferedStream::new_with_buffer_size(std::io::stdin(), 2usize.pow(20))?;
                let (ms_format, compressed) = $crate::io::infer_from_stream(&mut buffered)?;
                match ms_format {
                    $crate::io::MassSpectrometryFormat::MGF => {
                        if compressed {
                            #[allow(unused_mut)]
                            let mut $reader: $crate::io::StreamingSpectrumIterator<$C, $D, _, _> = $crate::io::StreamingSpectrumIterator::new(
                                $crate::io::mgf::MGFReaderType::new(
                                    $crate::io::RestartableGzDecoder::new(std::io::BufReader::new(buffered)),
                            ));
                            Ok($impl)
                        } else {
                            #[allow(unused_mut)]
                            let mut $reader: $crate::io::StreamingSpectrumIterator<$C, $D, _, _> = $crate::io::StreamingSpectrumIterator::new(
                                $crate::io::mgf::MGFReaderType::new(buffered));
                            Ok($impl)
                        }
                    }
                    $crate::io::MassSpectrometryFormat::MzML => {
                        if compressed {
                            #[allow(unused_mut)]
                            let mut $reader: $crate::io::StreamingSpectrumIterator<$C, $D, _, _> = $crate::io::StreamingSpectrumIterator::new(
                                $crate::io::mzml::MzMLReaderType::new($crate::io::RestartableGzDecoder::new(std::io::BufReader::new(buffered)),
                            ));
                            Ok($impl)
                        } else {
                            #[allow(unused_mut)]
                            let mut $reader: $crate::io::StreamingSpectrumIterator<$C, $D, _, _> = $crate::io::StreamingSpectrumIterator::new(
                                $crate::io::mzml::MzMLReaderType::new(buffered));
                            Ok($impl)
                        }
                    }
                    _ => {
                        return Err(std::io::Error::new(
                            std::io::ErrorKind::Unsupported,
                            "{ms_format:?} format is not supported over Stdin",
                        ).into())
                    }
                }
            },
        }
    }};
}

/// A macro that dynamically works out how to get a [`SpectrumWriter`](crate::io::SpectrumWriter) from a path
/// or [`io::Write`](std::io::Write) boxed object.
///
/// `$sink` is coerced to a [`Sink`] which in turn the macro probes in order to determine how
/// to create the appropriate writer type. Unlike other uses of [`Sink`], `Sender` and `SyncSender`
/// are not supported.  It lets you interact with the concrete type intersection in an anonymous closure:
///
/// ```ignore
/// # use std::io;
/// # use mzdata::prelude::*;
/// # fn main() -> io::Result<()> {
///     use mzdata::{mz_read, mz_write};
///     mzdata::mz_read!("./test/data/small.mzML".as_ref(), reader => {
///         mzdata::mz_write!("./tmp/test.mzML".as_ref(), writer => {
///             writer.copy_metadata_from(&reader);
///             for s in reader {
///                 writer.write_owned(s)?;
///             }
///         })?;
///     })?;
/// #   Ok(())
/// # }
/// ```
///
/// The closure will return a `std::io::Result` whose success value is inferred from context. The
/// writer's lifetime is bound to the closure, and cannot be extracted without substantial type system
/// torture.
///
/// If you want to use peak types *other than* the simple defaults, pass them as additional parameters after
/// the closure
#[macro_export]
macro_rules! mz_write {
    ($sink:expr, $writer:ident => $impl:tt) => {
        mz_write!($sink, $writer => $impl, mzpeaks::CentroidPeak, mzpeaks::DeconvolutedPeak)
    };
    ($sink:expr, $writer:ident => $impl:tt, $C:ty, $D:ty) => {{
        let sink = $crate::io::Sink::<$C, $D>::from($sink);
        match sink {
           $crate::io:: Sink::Sender(_) | $crate::io::Sink::SyncSender(_) =>  {
                Err(std::io::Error::new(std::io::ErrorKind::Unsupported, "Sender writers aren't supported by `mz_write`"))
            }
            $crate::io::Sink::PathLike(write_path) => {
                let (writer_format, is_gzip) = $crate::io::infer_from_path(&write_path);
                match writer_format {
                    $crate::io::MassSpectrometryFormat::MGF => {
                        let handle = std::io::BufWriter::new(std::fs::File::create(&write_path)?);
                        if is_gzip {
                            let handle = flate2::write::GzEncoder::new(handle, flate2::Compression::best());
                            let mut $writer: $crate::io::mgf::MGFWriterType<_, $C, $D> = $crate::io::mgf::MGFWriterType::new(
                                handle,
                            );
                            Ok($impl)
                        } else {
                            let mut $writer: $crate::io::mgf::MGFWriterType<_, $C, $D> = $crate::io::mgf::MGFWriterType::new(
                                handle,
                            );
                            Ok($impl)

                        }
                    }
                    $crate::io::MassSpectrometryFormat::MzML => {
                        let handle = std::io::BufWriter::new(std::fs::File::create(&write_path)?);
                        if is_gzip {
                            let handle = flate2::write::GzEncoder::new(handle, flate2::Compression::best());
                            let mut $writer: $crate::io::mzml::MzMLWriterType<_, $C, $D> = $crate::io::mzml::MzMLWriterType::new(
                                handle,
                            );
                            Ok($impl)
                        } else {
                            let mut $writer: $crate::io::mzml::MzMLWriterType<_, $C, $D> = $crate::io::mzml::MzMLWriterType::new(
                                handle,
                            );
                            Ok($impl)
                        }
                    }
                    #[cfg(feature = "mzmlb")]
                    $crate::io::MassSpectrometryFormat::MzMLb => {
                        let mut $writer = $crate::io::mzmlb::MzMLbWriterBuilder::<$C, $D>::new(&write_path)
                            .with_zlib_compression(9)
                            .create()?;
                        Ok($impl)
                    }
                    _ => Err(std::io::Error::new(
                        std::io::ErrorKind::Unsupported,
                        format!(
                            "Output file format {:?} for {} not supported",
                            writer_format,
                            write_path.display()
                        ),
                    )),
                }
            },
            $crate::io::Sink::Writer(handle, writer_format) => {
                match writer_format {
                    $crate::io::MassSpectrometryFormat::MGF => {
                        let handle = std::io::BufWriter::new(handle);
                        let mut $writer: $crate::io::mgf::MGFWriterType<_, $C, $D> = $crate::io::mgf::MGFWriterType::new(
                            handle,
                        );
                        Ok($impl)
                    }
                    $crate::io::MassSpectrometryFormat::MzML => {
                        let handle = std::io::BufWriter::new(handle);
                        let mut $writer: $crate::io::mzml::MzMLWriterType<_, $C, $D> = $crate::io::mzml::MzMLWriterType::new(
                            handle,
                        );
                        Ok($impl)
                    }
                    _ => {
                        Err(std::io::Error::new(
                                std::io::ErrorKind::Unsupported,
                                format!(
                                    "Output file format for {:?} not supported",
                                    writer_format
                                ),
                            ))
                    }
                }
            }
        }
    }};
}

#[cfg(test)]
mod test {
    use crate::prelude::*;
    use std::io;

    #[test]
    fn test_mz_read() -> io::Result<()> {
        let val: Vec<_> =
            mz_read!("./test/data/small.mzML".as_ref(), reader => { reader.collect() })?;
        assert_eq!(val.len(), 48);
        let val: Vec<_> =
            mz_read!("./test/data/small.mgf".as_ref(), reader => { reader.collect() })?;
        assert_eq!(val.len(), 34);
        let val = mz_read!("./test/data/small.mzML".as_ref(), reader => { reader.file_description().clone() })?;
        assert_eq!(val.source_files.len(), 1);
        Ok(())
    }

    #[test]
    fn test_mz_read_nested() -> io::Result<()> {
        mz_read!("./test/data/small.mzML".as_ref(), reader => {
            mz_read!("./test/data/small.mzML".as_ref(), reader2 => {
                assert_eq!(reader.len(), reader2.len());
            })?;
        })?;

        Ok(())
    }

    #[test]
    fn test_mz_write() -> io::Result<()> {
        let tmpdir = tempfile::tempdir()?;
        let path = tmpdir.path().join("test.mzML");
        mz_read!("./test/data/small.mzML".as_ref(), reader => {
            mz_write!(path.as_ref(), writer => {
                writer.copy_metadata_from(&reader);
                for s in reader {
                    writer.write_owned(s)?;
                }
            })?;
        })?;
        Ok(())
    }
}