docs: Add support for generating a documentation site through Doxygen.

docs/doxygen/Doxyfile

@@ -0,0 +1,68 @@
+-------------------------------------------------------------
+# Project Information
+#-------------------------------------------------------------
+PROJECT_NAME           = "Log Surgeon"
+PROJECT_BRIEF          = "Test coverage and internal documentation"
+OUTPUT_DIRECTORY       = docs
+CREATE_SUBDIRS         = NO
+OUTPUT_LANGUAGE        = English
+
+#-------------------------------------------------------------
+# Input
+#-------------------------------------------------------------
+INPUT                  = ../../tests mainpage.dox groups.dox
+RECURSIVE              = YES
+FILE_PATTERNS          = *.cpp
+
+#-------------------------------------------------------------
+# Source Code Parsing
+#-------------------------------------------------------------
+EXTRACT_ALL            = YES
+EXTRACT_PRIVATE        = YES
+EXTRACT_STATIC         = YES
+EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_ANON_NSPACES   = YES
+
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = YES
+EXPAND_ONLY_PREDEF     = NO
+PREDEFINED             = TEST_CASE(x,y)=void x() /**< @testcase y */
+
+# If needed, fake out Catch2's SECTION to avoid warnings:
+PREDEFINED            += SECTION(x)=
+
+#-------------------------------------------------------------
+# Documentation Formatting
+#-------------------------------------------------------------
+TAB_SIZE               = 4
+OPTIMIZE_OUTPUT_FOR_C  = NO
+OPTIMIZE_OUTPUT_JAVA   = NO
+OPTIMIZE_FOR_FORTRAN   = NO
+OPTIMIZE_OUTPUT_VHDL   = NO
+EXTENSION_MAPPING      = cpp=C++
+HAVE_DOT = NO
+
+#-------------------------------------------------------------
+# HTML Output
+#-------------------------------------------------------------
+GENERATE_HTML          = YES
+HTML_OUTPUT            = html
+HTML_COLORSTYLE_HUE    = 220
+HTML_TIMESTAMP         = YES
+
+HTML_EXTRA_STYLESHEET  = compact-dark.css
+HTML_EXTRA_FILES       = toggleMode.js
+HTML_FOOTER            = footer.html
+
+#-------------------------------------------------------------
+# LaTeX / PDF Output
+#-------------------------------------------------------------
+GENERATE_LATEX         = NO
+
+#-------------------------------------------------------------
+# Misc
+#-------------------------------------------------------------
+QUIET                  = NO
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = NO
+INPUT_ENCODING         = UTF-8

docs/doxygen/compact-dark.css

@@ -0,0 +1,145 @@
+/* Global Reset */
+body {
+    font-family: "Segoe UI", sans-serif;
+    font-size: 14px;
+    background-color: #f8f9fa; /* Default Light */
+    color: #212529;
+    margin: 0;
+    padding: 0;
+}
+
+/* Dark Mode */
+body.dark {
+    background-color: #1e1e1e;
+    color: #e0e0e0;
+}
+
+/* Section Titles */
+h1, h2, h3, h4 {
+    color: #0056b3;
+    border-bottom: 1px solid #dee2e6;
+    padding-bottom: 0.25rem;
+    margin-top: 1.5rem;
+    font-size: 1.25rem;
+}
+
+/* Group & List Styling */
+dl, ul, ol {
+    margin-top: 0.75rem;
+    margin-bottom: 0.75rem;
+    padding-left: 1.5rem;
+}
+
+dt {
+    font-weight: bold;
+    margin-top: 0.75rem;
+}
+
+dd {
+    margin-left: 1rem;
+}
+
+/* Table Styling */
+table.directory, table.memberdecls, table {
+    border-collapse: collapse;
+    width: 100%;
+    margin-top: 1.25rem;
+}
+
+th, td {
+    border: 1px solid #dee2e6;
+    padding: 0.5rem;
+    font-size: 0.875rem;
+    text-align: left;
+}
+
+th {
+    background-color: #e9ecef;
+}
+
+/* Links */
+a {
+    color: #007bff;
+    text-decoration: none;
+}
+
+a:hover {
+    text-decoration: underline;
+}
+
+/* Code Blocks */
+pre.fragment {
+    background-color: #f1f3f5;
+    border-left: 3px solid #007bff;
+    padding: 0.75rem;
+    font-family: "Courier New", monospace;
+    color: #212529;
+    margin-top: 1rem;
+    overflow-x: auto;
+}
+
+/* Footer */
+div.footer {
+    background-color: #343a40;
+    color: #ffffff;
+    text-align: center;
+    padding: 0.75rem;
+    margin-top: 1.5rem;
+}
+
+/* Dark Mode Specific Styles */
+body.dark .header {
+    background-color: #333333;
+}
+
+body.dark .header h1, body.dark .header h2 {
+    color: #ffffff;
+}
+
+body.dark .contents {
+    background-color: #252525;
+    color: #e0e0e0;
+}
+
+body.dark h1, body.dark h2, body.dark h3, body.dark h4 {
+    color: #c5c5ff;
+}
+
+body.dark dl, body.dark ul, body.dark ol {
+    color: #e0e0e0;
+}
+
+body.dark pre.fragment {
+    background-color: #252525;
+    border-left: 3px solid #007bff;
+}
+
+body.dark a {
+    color: #4db8ff;
+}
+
+/* Navigation Bar (Main Tabs) */
+body.dark #top *,
+body.dark .header *{
+    background-color: #333333; /* Dark background for navbar */
+    border-bottom: 1px solid #555555; /* Dark border */
+}
+
+body.dark #top * a,
+body.dark .header * a {
+    color: #e0e0e0; /* Light color for links in navbar */
+}
+
+body.dark #main-nav a:hover {
+    color: #4db8ff; /* Light blue color when hovered */
+}
+
+/* Code doc */
+body.dark .memitem * {
+    background-color: #333333; /* Dark background for navbar */
+    border-bottom: 1px solid #555555; /* Dark border */
+}
+
+body.dark .memitem * a {
+    color: #e0e0e0; /* Light color for links in navbar */
+}

docs/doxygen/footer.html

@@ -0,0 +1,5 @@
+<div class="footer">
+    <p>&copy; 2025 </p>
+    <button onclick="toggleMode()">Toggle Dark/Compact Mode</button>
+</div>
+<script src="toggleMode.js"></script>

docs/doxygen/groups.dox

@@ -0,0 +1,54 @@
+/** @file groups.dox
+ *  @brief Test group hierarchy for Doxygen documentation.
+ */
+
+/**
+ * @defgroup test_buffer_parser_no_capture Basic Variable Matching (No Capture Groups)
+ * @brief Tests covering variable matching without regex capture groups.
+ */
+
+/**
+ * @defgroup test_log_parser_capture Log Parser with Capture Groups
+ * @brief Tests LogParser behavior with named capture groups in variable schemas.
+ *
+ * @details
+ * Verifies:
+ * - Symbol registration for variables and capture groups
+ * - Correct association of tag positions
+ * - Proper assignment and lookup of tag registers
+ *
+ * Useful for validating advanced schema features like `(?<name>...)` integration.
+ *
+ * @see test_buffer_parser_no_capture for simpler variable matching.
+ */
+
+/**
+ * @defgroup test_log_parser_default_schema Log Parser: Default Schema
+ * @brief Tests for CLP's default variable schema: timestamp, int, float, hex, key-value pairs, etc.
+ *
+ * @details
+ * Validates token recognition across common variable types using a default schema definition.
+ */
+
+/**
+ * @defgroup test_log_parser_delimited_variables Log Parser: Variables with Delimiters Schema
+ * @brief Tests for LogParser using a schema where variables are defined with custom delimiters.
+ *
+ * @details
+ * This group contains tests that verify tokenization using:
+ * - Custom delimiters (`\n\r\[:,)`)
+ * - Variables that require delimiters to separate them properly in the input.
+ *
+ * These tests ensure the parser correctly handles and matches variables bounded by specified
+ * delimiters.
+ */
+
+/**
+ * @defgroup test_log_parser_newline_vars Variable Tokens on Newlines
+ * @brief Tests covering how LogParser categorizes variable tokens appearing at the start of new lines,
+ *        including interaction with static-text, delimiters, and capture group repetition.
+ *
+ * These tests verify correct tokenization and recognition of variables and delimiters
+ * when variables occur on new lines, especially following different token types.
+ */
+

docs/doxygen/mainpage.dox

@@ -0,0 +1,16 @@
+/** @mainpage
+ * # Use case examples of schema rules and parsing results:
+ * - @ref test_buffer_parser_no_capture "Use basic log parser"
+ * - @ref test_log_parser_capture "Use captures"
+ * - @ref test_log_parser_default_schema "Default CLP schema"
+ * - @ref test_log_parser_delimited_variables "Backtracking on delimited variables"
+ * - @ref test_log_parser_newline_vars "Identifying variables at the start of a line"
+ * # Unit-tests:
+ * - @ref test-schema.cpp "Schema creation tests"
+ * - @ref test-dfa.cpp "DFA tests"
+ * - @ref test-nfa.cpp "NFA tests"
+ * - @ref test-regex-ast.cpp "Regex AST tests"
+ * - @ref test-register-handler.cpp "Register handler tests"
+ * - @ref test-prefix-tree.cpp "Prefix tree tests"
+ * - @ref test-capture.cpp "Capture tests"
+ */

docs/doxygen/toggleMode.js

@@ -0,0 +1,19 @@
+function toggleMode() {
+    var body = document.body;
+
+    // Toggle classes for dark and compact mode
+    body.classList.toggle('dark');
+
+    // Store the modes in localStorage for persistence across page reloads
+    localStorage.setItem('darkMode', body.classList.contains('dark'));
+}
+
+// On page load, check localStorage and apply the saved modes if any
+window.onload = function() {
+    var body = document.body;
+
+    // Apply saved dark mode
+    if (localStorage.getItem('darkMode') === 'true') {
+        body.classList.add('dark');
+    }
+};

src/log_surgeon/Lexer.tpp

@@ -103,16 +103,14 @@ auto Lexer<TypedNfaState, TypedDfaState>::scan(ParserInputBuffer& input_buffer)
             m_line++;
             // The newline character itself needs to be treated as a match for non-timestamped logs.
             if (m_has_delimiters && false == m_match) {
-                auto const* dest_state{
-                        m_dfa->get_root()->get_transition(next_char)->get_dest_state()
-                };
                 m_state = m_dfa->get_root();
                 process_char(next_char, prev_byte_buf_pos);
                 m_match = true;
-                m_type_ids = &dest_state->get_matching_variable_ids();
+                m_type_ids = &m_state->get_matching_variable_ids();
                 m_start_pos = prev_byte_buf_pos;
                 m_match_pos = input_buffer.storage().pos();
                 m_match_line = m_line;
+                continue;
             }
         }