/*

 * 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.

 *

 */

use std::cmp::max;

use crate::ast::SourceInfo;

use crate::text::{Format, Style, StyledString};

pub trait DisplaySourceError {

    fn source_info(&self) -> SourceInfo;

    fn description(&self) -> String;

    fn fixme(&self, content: &[&str]) -> StyledString;

    /// Returns the constructed message for the error

    ///

    /// It may include:

    ///

    /// - source line

    /// - column position and number of characters (with one or more carets)

    ///

    /// Examples:

    ///

    /// ```text

    /// GET abc

    ///     ^ expecting http://, https:// or {{

    /// ```

    ///

    /// ```text

    /// HTTP/1.0 200

    ///          ^^^ actual value is <404>

    /// ```

    ///

    /// ```text

    /// jsonpath "$.count" >= 5

    ///   actual:   int <2>

    ///   expected: greater than int <5>

    /// ```

    ///

    /// ```text

    /// {

    ///    "name": "John",

    ///-   "age": 27

    ///+   "age": 28

    /// }

    /// ```

    }

    /// Returns the string representation of an `error`, given `lines` of content and a `filename`.

    ///

    /// The source information where the error occurred can be retrieved in `error`; optionally,

    /// `entry_src_info` is the optional source information for the entry where the error happened.

    /// If `colored` is true, the string use ANSI escape codes to add color and improve the readability

    /// of the representation.

    ///

    /// Example:

    ///

    ///

    ///

    /// ```text

    /// Assert status code                        | > description()

    ///  --> test.hurl:2:10                       | > add_filename_with_sourceinfo()

    ///   |                                       |

    ///   | GET http://foo.com                    | > add_entry_line()

    ///   | ...                                   |

    /// 2 | HTTP/1.0 200                          | > message()

    ///   |          ^^^ actual value is <404>    | >

    ///   |                                       |

    /// ```

        }

    }

}

/// Show column position with carets

    // Error source info start and end can be on different lines, we insure a minimum width.

    } else {

    };

            }

        };

    }

}

/// Format used by to_string

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

pub enum OutputFormat {

    Plain,

    Terminal(bool), // Replace \r\n by \n

}

        } else {

        });

    }

    //  Appends additional empty line

    }

}

/// Generate carets for the given source_line/source_info

        }

    }

}

}

}

    }

    }

}

    } else {

    };

        OutputFormat::Terminal(_) => {

        }

    }

}

#[cfg(test)]

mod tests {

    use super::*;

    use crate::reader::Pos;

    use crate::text::{Format, Style};

    #[test]

    fn test_add_carets() {

        // `Hello World`

        // ^^^^^^^^^^^^^ actual value is <Hello World!>

        assert_eq!(

            add_carets(

                "actual value is <Hello World!>",

                SourceInfo::new(Pos::new(1, 1), Pos::new(1, 14)),

                &["`Hello World`"]

            ),

            " ^^^^^^^^^^^^^ actual value is <Hello World!>".to_string()

        );

    }

    #[test]

    fn test_get_carets() {

        // `Hello World`

        // ^^^^^^^^^^^^^ actual value is <Hello World!>

        assert_eq!(

            get_carets("`Hello World`", 1, 13),

            " ^^^^^^^^^^^^^ ".to_string()

        );

        // Content-Length: 200

        //                 ^^^ actual value is <12>

        assert_eq!(

            get_carets("Content-Length: 200", 17, 3),

            "                 ^^^ ".to_string()

        );

        // With a tab instead of a space

        // Content-Length:    200

        //                    ^^^ actual value is <12>

        assert_eq!(

            get_carets("Content-Length:\t200", 17, 3),

            "                    ^^^ ".to_string()

        );

    }

    #[test]

    fn test_diff_error() {

        crate::text::init_crate_colored();

        let content = r#"GET http://localhost:8000/failed/multiline/json

HTTP 200

```

{

  "name": "John",

  "age": 27

}

```

"#;

        let filename = "test.hurl";

        struct E;

        impl DisplaySourceError for E {

            fn source_info(&self) -> SourceInfo {

                SourceInfo::new(Pos::new(4, 1), Pos::new(4, 0))

            }

            fn description(&self) -> String {

                "Assert body value".to_string()

            }

            fn fixme(&self, _lines: &[&str]) -> StyledString {

                let mut diff = StyledString::new();

                diff.push(" {\n   \"name\": \"John\",\n");

                diff.push_with("-  \"age\": 27", Style::new().red());

                diff.push("\n");

                diff.push_with("+  \"age\": 28", Style::new().green());

                diff.push("\n }\n");

                diff

            }

            fn message(&self, lines: &[&str]) -> StyledString {

                let s = self.fixme(lines);

                add_line_info_prefix(&s, &[], 4)

            }

        }

        let error = E;

        let lines = content.lines().collect::<Vec<_>>();

        assert_eq!(

            error.message(&lines).to_string(Format::Plain),

            r#"

 4 | {

   |   "name": "John",

   |-  "age": 27

   |+  "age": 28

   | }

   |"#

        );

        assert_eq!(

            error.message(&lines).to_string(Format::Ansi),

            "\n\u{1b}[1;34m 4 |\u{1b}[0m {\n\u{1b}[1;34m   |\u{1b}[0m   \"name\": \"John\",\n\u{1b}[1;34m   |\u{1b}[0m\u{1b}[31m-  \"age\": 27\u{1b}[0m\n\u{1b}[1;34m   |\u{1b}[0m\u{1b}[32m+  \"age\": 28\u{1b}[0m\n\u{1b}[1;34m   |\u{1b}[0m }\n\u{1b}[1;34m   |\u{1b}[0m"

        );

        assert_eq!(

            error.to_string(filename, content, None, OutputFormat::Terminal(false)),

            r#"Assert body value

  --> test.hurl:4:1

   |

 4 | {

   |   "name": "John",

   |-  "age": 27

   |+  "age": 28

   | }

   |"#

        );

    }

}