/*

 * Hurl (https://hurl.dev)

 * Copyright (C) 2024 Orange

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 *          http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 *

 */

//! Represents a text reader.

/// The `Reader` implements methods to read a stream of text. A reader manages

/// an internal `cursor` : it's the current read index position within the reader's internal buffer.

///

/// Methods like [`Reader::read`], [`Reader::read_while`] do advance the internal reader's `cursor`.

/// Other methods, like [`Reader::peek`], [`Reader::peek_n`] allows to get the next chars in the

/// buffer without modifying the current reader cursor.

///

/// The cursor is composed of an offset, which is always related to the reader internal buffer.

/// Along the buffer offset, a position [`Pos`] is updated each time a char is read. This position

/// corresponds to the column and row index in the buffer document. In most of the case, the

/// position is initialized to the first char, but a reader instance can be created using

/// [`Reader::with_pos`] to set a given started position. This can be useful when a reader

/// is instantiated as a "sub reader" of a given reader, and we want to report position relatively

/// to the main reader (for errors but also for constructed structures).

///

/// # Example

/// ```

///  use hurl_core::reader::Reader;

///

///  let mut reader = Reader::new("hi");

///  assert_eq!(reader.cursor().index, 0);

///  assert!(!reader.is_eof());

///  assert_eq!(reader.peek_n(2), "hi".to_string());

///  assert_eq!(reader.read(), Some('h'));

///  assert_eq!(reader.cursor().index, 1);

/// ```

#[derive(Clone, Debug, PartialEq, Eq)]

pub struct Reader {

    buf: Vec<char>,

    cursor: Cursor,

}

/// Represents a line and column position in a reader.

///

/// Indices are 1-based.

#[derive(Copy, Clone, Debug, PartialEq, Eq)]

pub struct Pos {

    pub line: usize,

    pub column: usize,

}

impl Pos {

    /// Creates a new position.

    }

}

/// A position in a text buffer.

///

/// The position has two components: a char `offset` in the internal buffer of the reader, and

/// a column-row oriented position `pos`, used for human display. `pos` is usually initialized to

/// the first char of the buffer but it can also be set with a position inside another reader. This

/// allows the report of error of a sub-reader, relative to a parent reader.

#[derive(Copy, Clone, Debug, PartialEq, Eq)]

pub struct Cursor {

    pub index: usize,

    pub pos: Pos,

}

impl Reader {

    /// Creates a new reader, position of the index is at the first char.

        }

    }

    /// Creates a new reader, `pos` is position of the index: this allow to report created

    /// structures and error to be referenced from this position.

    ///

    /// Note: the `buffer` offset is still initialized to 0.

        }

    }

    /// Returns the current position of the read index.

    }

    /// Position the read index to a new position.

    }

    /// Returns true if the reader has read all the buffer, false otherwise.

    }

    /// Returns the next char from the buffer advancing the internal state.

                }

                }

            }

        }

    }

    /// Returns `count` chars from the buffer advancing the internal state.

    /// This methods can returns less than `count` chars if there is not enough chars in the buffer.

            }

        }

    }

    /// Returns chars from the buffer while `predicate` is true, advancing the internal state.

        loop {

                    }

                }

            }

        }

    }

    /// Reads a string from a `start` position to the current position (excluded).

    ///

    /// This method doesn't modify the read index since we're reading "backwards" to the current

    /// read index.

    }

    /// Peeks the next char from the buffer without advancing the internal state.

    }

    /// Peeks the next char that meet a `predicate`.

        loop {

            }

        }

    }

    /// Peeks a string of `count` char without advancing the internal state.

    /// This methods can return less than `count` chars if there is not enough chars in the buffer.

    }

}

}

#[cfg(test)]

mod tests {

    use super::*;

    #[test]

    fn basic_reader() {

        let mut reader = Reader::new("hi");

        assert_eq!(reader.cursor().index, 0);

        assert!(!reader.is_eof());

        assert_eq!(reader.peek_n(2), "hi".to_string());

        assert_eq!(reader.cursor().index, 0);

        assert_eq!(reader.read().unwrap(), 'h');

        assert_eq!(reader.cursor().index, 1);

        assert_eq!(reader.peek().unwrap(), 'i');

        assert_eq!(reader.cursor().index, 1);

        assert_eq!(reader.read().unwrap(), 'i');

        assert!(reader.is_eof());

        assert_eq!(reader.read(), None);

    }

    #[test]

    fn peek_back() {

        let mut reader = Reader::new("abcdefgh");

        assert_eq!(reader.read(), Some('a'));

        assert_eq!(reader.read(), Some('b'));

        assert_eq!(reader.read(), Some('c'));

        assert_eq!(reader.read(), Some('d'));

        assert_eq!(reader.read(), Some('e'));

        assert_eq!(reader.peek(), Some('f'));

        assert_eq!(reader.read_from(3), "de");

    }

    #[test]

    fn read_while() {

        let mut reader = Reader::new("123456789");

        assert_eq!(reader.read_while(|c| c.is_numeric()), "123456789");

        assert_eq!(reader.cursor().index, 9);

        assert!(reader.is_eof());

        let mut reader = Reader::new("123456789abcde");

        assert_eq!(reader.read_while(|c| c.is_numeric()), "123456789");

        assert_eq!(reader.cursor().index, 9);

        assert!(!reader.is_eof());

        let mut reader = Reader::new("abcde123456789");

        assert_eq!(reader.read_while(|c| c.is_numeric()), "");

        assert_eq!(reader.cursor().index, 0);

    }

    #[test]

    fn reader_create_with_from_pos() {

        let mut main_reader = Reader::new("aaabb");

        _ = main_reader.read();

        _ = main_reader.read();

        _ = main_reader.read();

        let pos = main_reader.cursor().pos;

        let s = main_reader.read_while(|_| true);

        let mut sub_reader = Reader::with_pos(&s, pos);

        assert_eq!(

            sub_reader.cursor,

            Cursor {

                index: 0,

                pos: Pos::new(1, 4)

            }

        );

        _ = sub_reader.read();

        assert_eq!(

            sub_reader.cursor,

            Cursor {

                index: 1,

                pos: Pos::new(1, 5)

            }

        );

    }

    #[test]

    fn peek_ignoring_whitespace() {

        fn is_whitespace(c: char) -> bool {

            c == ' ' || c == '\t'

        }

        let reader = Reader::new("\t\t\tabc");

        assert_eq!(reader.peek_if(|c| !is_whitespace(c)), Some('a'));

        let reader = Reader::new("foo");

        assert_eq!(reader.peek_if(|c| !is_whitespace(c)), Some('f'));

    }

}