Began work on parsing. Will do two pass parsing

Author: RPG-Alex

src/comments.rs

@@ -9,13 +9,12 @@ use crate::ast::ParsedSqlFile;
 
 /// Structure for holding a location in the file. Assumes file is first split by
 /// lines and then split by characters (column)
-#[derive(Debug,PartialEq,PartialOrd)]
+#[derive(Debug, Eq, PartialEq, PartialOrd)]
 pub struct Location {
     line: u64,
     column: u64,
 }
 
-
 impl Location {
     /// Method for instantiating a new [`Location`]
     ///
@@ -47,7 +46,7 @@ impl Default for Location {
 }
 
 /// A structure for holding the span of comments found
-#[derive(Debug,PartialEq)]
+#[derive(Debug, Eq, PartialEq)]
 pub struct Span {
     start: Location,
     end: Location,
@@ -84,10 +83,9 @@ impl Default for Span {
     }
 }
 
-
 /// Enum for holding the comment content, differentiated by single line `--` and
 /// multiline `/* */`
-#[derive(Clone, Debug,PartialEq)]
+#[derive(Clone, Debug, Eq, PartialEq)]
 pub enum CommentKind {
     /// Enum variant for Multiline Comments
     MultiLine(String),
@@ -223,7 +221,12 @@ impl Comments {
     }
 
     /// Build all leading comments from a parsed SQL file
-    #[must_use]
+    /// 
+    /// # Parameters
+    /// - `file`: the [`ParsedSqlFile`] that needs to be parsed for comments
+    /// 
+    /// # Errors
+    /// - Will return [`CommentError::UnmatchedBlockCommentStart`] if a comment does not have an opening `/*`
     pub fn parse_all_comments_from_file(file: &ParsedSqlFile) -> CommentResult<Self> {
         let src = file.content();
         let mut comments = Vec::new();
@@ -238,6 +241,46 @@ impl Comments {
     /// - `src` which is the `SQL` file content as a [`str`]
     fn scan_comments(src: &str) -> CommentResult<Self> {
         let mut comments = Vec::new();
+        let mut current_line = 0u64;
+        let mut current_column = 0u64;
+
+        let mut start_line = 0u64;
+        let mut start_column = 0u64;
+
+        let mut current_comment = String::new();
+        let mut src_state_machine = src.chars().peekable();
+        while let Some(c) = src_state_machine.next() {
+            match c {
+                '-' => {
+                    if current_column < 2 {
+                        current_comment.push(c);
+                    }
+                }
+                '/' => {
+                    if current_column == 0 || current_comment.contains("/*") {
+                        current_comment.push(c);
+                    }
+                }
+                '*' => {
+                    current_comment.push(c);
+                }
+                '\n' => {
+                    if !current_comment.is_empty() {
+                        current_comment.clear();
+                    }
+                    current_line += 1;
+                    current_column = 0;
+                }
+                _ => {
+                    if current_comment.contains("--") || current_comment.contains("/*") {
+                        current_comment.push(c);
+                    }
+                }
+            }
+            if c != '\n' {
+                current_column += 1;
+            }
+        }
 
         Ok(Self { comments })
     }
@@ -254,71 +297,60 @@ impl Comments {
 }
 
 #[cfg(test)]
-    use super::*;
+use super::*;
 
-    #[test]
-    fn location_new_and_default() {
-        let mut location = Location::new(2, 5);
-        location.column = 20;
-        location.line = 43;
+#[test]
+fn location_new_and_default() {
+    let mut location = Location::new(2, 5);
+    location.column = 20;
+    location.line = 43;
 
-        assert_eq!(
-            Location { column: 20, line: 43 },
-            location
-        );
-
-        let location2 = Location::default();
-        assert_eq!(location2, Location { line: 0, column: 0 });
-    }
+    assert_eq!(Location { column: 20, line: 43 }, location);
 
-    
-    #[test]
-    fn span_default_and_updates() {
-        let default = Span::default();
-        assert_eq!(default.start, Location::default());
-        assert_eq!(default.end, Location::default());
-
-        let mut span = Span::default();
-        span.end = Location::new(55, 100);
+    let location2 = Location::default();
+    assert_eq!(location2, Location { line: 0, column: 0 });
+}
 
-        assert_eq!(span.start, Location::default());
-        assert_eq!(span.end, Location { line: 55, column: 100 });
-    }
+#[test]
+fn span_default_and_updates() {
+    let default = Span::default();
+    assert_eq!(default.start, Location::default());
+    assert_eq!(default.end, Location::default());
 
+    let mut span = Span::default();
+    span.end = Location::new(55, 100);
 
-    #[test]
-    fn comments_with_comment_kind() {
-        let raw_comment = "-- a comment";
-        let len = raw_comment.len() as u64;
+    assert_eq!(span.start, Location::default());
+    assert_eq!(span.end, Location { line: 55, column: 100 });
+}
 
-        let singleline = CommentKind::SingleLine(raw_comment.to_string());
-        let mut span = Span::default();
-        span.end.column = len - 1;
+#[test]
+fn comments_with_comment_kind() {
+    let raw_comment = "-- a comment";
+    let len = raw_comment.len() as u64;
 
-        let comment = Comment::new(singleline.clone(), span);
+    let singleline = CommentKind::SingleLine(raw_comment.to_string());
+    let mut span = Span::default();
+    span.end.column = len - 1;
 
-        assert_eq!(comment.kind, singleline);
+    let comment = Comment::new(singleline.clone(), span);
 
-        let expected_span = Span::new(
-            Location { line: 0, column: 0 },
-            Location { line: 0, column: len - 1 },
-        );
+    assert_eq!(comment.kind, singleline);
 
-        assert_eq!(comment.span, expected_span);
-    }
+    let expected_span =
+        Span::new(Location { line: 0, column: 0 }, Location { line: 0, column: len - 1 });
 
-    #[test]
-    fn multiline_comment_span() {
-        let kind = CommentKind::MultiLine("/* hello\nworld */".to_string());
-        let span = Span::new(
-            Location { line: 1, column: 0 },
-            Location { line: 2, column: 9 },
-        );
+    assert_eq!(comment.span, expected_span);
+}
 
-        let comment = Comment::new(kind.clone(), span);
+#[test]
+fn multiline_comment_span() {
+    let kind = CommentKind::MultiLine("/* hello\nworld */".to_string());
+    let span = Span::new(Location { line: 1, column: 0 }, Location { line: 2, column: 9 });
 
-        assert_eq!(comment.kind, kind);
-        assert_eq!(comment.span.start.line, 1);
-        assert_eq!(comment.span.end.line, 2);
-    }
+    let comment = Comment::new(kind.clone(), span);
 
+    assert_eq!(comment.kind, kind);
+    assert_eq!(comment.span.start.line, 1);
+    assert_eq!(comment.span.end.line, 2);
+}