symforge 8.10.5

SymForge — in-memory code intelligence MCP server for Claude Code, Codex, and Gemini CLI
Documentation
automod::dir!("src/parsing/config_extractors");

use crate::domain::{LanguageId, SymbolRecord};

// ---------------------------------------------------------------------------
// Constants
// ---------------------------------------------------------------------------

use std::ops::Range;

use crate::domain::ParseDiagnostic;

pub const MAX_DEPTH: u32 = 6;
pub const MAX_ARRAY_ITEMS: usize = 20;

// ---------------------------------------------------------------------------
// EditCapability
// ---------------------------------------------------------------------------

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum EditCapability {
    IndexOnly,
    TextEditSafe,
    StructuralEditSafe,
}

// ---------------------------------------------------------------------------
// ExtractionResult / ExtractionOutcome
// ---------------------------------------------------------------------------

pub struct ExtractionResult {
    pub symbols: Vec<SymbolRecord>,
    pub outcome: ExtractionOutcome,
}

pub enum ExtractionOutcome {
    Ok,
    Partial(ParseDiagnostic),
    Failed(ParseDiagnostic),
}

// ---------------------------------------------------------------------------
// ConfigExtractor trait
// ---------------------------------------------------------------------------

pub trait ConfigExtractor: Send + Sync {
    fn extract(&self, content: &[u8]) -> ExtractionResult;
    fn edit_capability(&self) -> EditCapability;
}

// ---------------------------------------------------------------------------
// Registry helpers
// ---------------------------------------------------------------------------

/// Returns true for config-style languages handled by this module.
pub fn is_config_language(language: &LanguageId) -> bool {
    matches!(
        language,
        LanguageId::Json
            | LanguageId::Toml
            | LanguageId::Yaml
            | LanguageId::Markdown
            | LanguageId::Env
    )
}

/// Returns a boxed extractor for the given language, or None for non-config languages.
pub fn extractor_for(language: &LanguageId) -> Option<Box<dyn ConfigExtractor>> {
    match language {
        LanguageId::Json => Some(Box::new(json::JsonExtractor)),
        LanguageId::Toml => Some(Box::new(toml_ext::TomlExtractor)),
        LanguageId::Yaml => Some(Box::new(yaml::YamlExtractor)),
        LanguageId::Markdown => Some(Box::new(markdown::MarkdownExtractor)),
        LanguageId::Env => Some(Box::new(env::EnvExtractor)),
        _ => None,
    }
}

/// Returns the edit capability for the given language by delegating to its extractor.
pub fn edit_capability_for(language: &LanguageId) -> Option<EditCapability> {
    extractor_for(language).map(|e| e.edit_capability())
}

/// Unified edit capability check for all languages (config + source).
/// Returns `None` for languages with no edit restrictions (mature tree-sitter languages).
pub fn edit_capability_for_language(language: &LanguageId) -> Option<EditCapability> {
    // Config languages — delegate to their extractor
    if let Some(cap) = edit_capability_for(language) {
        return Some(cap);
    }
    // Source languages with restricted editing
    match language {
        LanguageId::Html | LanguageId::Css | LanguageId::Scss => Some(EditCapability::TextEditSafe),
        // All other source languages → None (unrestricted)
        _ => None,
    }
}

// ---------------------------------------------------------------------------
// Line offset helpers (shared by json, yaml, toml_ext)
// ---------------------------------------------------------------------------

/// Build a table mapping line index → byte offset of line start.
pub(super) fn build_line_starts(content: &[u8]) -> Vec<u32> {
    let mut starts: Vec<u32> = vec![0];
    for (i, &b) in content.iter().enumerate() {
        if b == b'\n' {
            starts.push((i + 1) as u32);
        }
    }
    starts
}

/// Convert a byte offset into a 0-based line number.
pub(super) fn byte_to_line(line_starts: &[u32], offset: u32) -> u32 {
    match line_starts.binary_search(&offset) {
        Ok(idx) => idx as u32,
        Err(idx) => (idx.saturating_sub(1)) as u32,
    }
}

// ---------------------------------------------------------------------------
// Key escaping helpers
// ---------------------------------------------------------------------------

pub(crate) fn parse_diagnostic(
    parser: &str,
    message: impl Into<String>,
    line: Option<u32>,
    column: Option<u32>,
    byte_span: Option<(u32, u32)>,
    fallback_used: bool,
) -> ParseDiagnostic {
    ParseDiagnostic {
        parser: parser.to_string(),
        message: message.into(),
        line,
        column,
        byte_span,
        fallback_used,
    }
}

pub(crate) fn parse_diagnostic_from_span(
    parser: &str,
    message: impl Into<String>,
    content: &[u8],
    span: Option<Range<usize>>,
    fallback_used: bool,
) -> ParseDiagnostic {
    let byte_span = span.map(|range| {
        let start = range.start.min(content.len());
        let end = range.end.min(content.len()).max(start);
        (start as u32, end as u32)
    });
    let (line, column) = byte_span
        .map(|(start, _)| byte_offset_to_line_column(content, start as usize))
        .map(|(line, column)| (Some(line), Some(column)))
        .unwrap_or((None, None));
    parse_diagnostic(parser, message, line, column, byte_span, fallback_used)
}

/// Converts usize to Option<u32>. Returns None for 0 (convention: 0 means unavailable in
/// 1-based line/column APIs).
pub(crate) fn optional_u32(value: usize) -> Option<u32> {
    if value == 0 {
        None
    } else {
        u32::try_from(value).ok()
    }
}

pub(crate) fn byte_offset_to_line_column(content: &[u8], byte_offset: usize) -> (u32, u32) {
    let capped = byte_offset.min(content.len());
    let prefix = &content[..capped];
    let line = prefix.iter().filter(|&&byte| byte == b'\n').count() as u32 + 1;
    let line_start = prefix
        .iter()
        .rposition(|&byte| byte == b'\n')
        .map_or(0, |idx| idx + 1);
    let column = content[line_start..capped]
        .iter()
        .filter(|&&byte| byte != b'\r')
        .count() as u32
        + 1;
    (line, column)
}

/// Escapes a raw key segment:
/// - `~` → `~0`
/// - `.` → `~1`
/// - `[` → `~2`
/// - `]` → `~3`
pub fn escape_key_segment(raw: &str) -> String {
    let mut out = String::with_capacity(raw.len());
    for ch in raw.chars() {
        match ch {
            '~' => out.push_str("~0"),
            '.' => out.push_str("~1"),
            '[' => out.push_str("~2"),
            ']' => out.push_str("~3"),
            _ => out.push(ch),
        }
    }
    out
}

/// Joins a parent path and a child key segment with a dot, escaping the child.
pub fn join_key_path(parent: &str, child: &str) -> String {
    let escaped = escape_key_segment(child);
    if parent.is_empty() {
        escaped
    } else {
        format!("{}.{}", parent, escaped)
    }
}

/// Joins a parent path with an array index: `parent[index]`.
pub fn join_array_index(parent: &str, index: usize) -> String {
    format!("{}[{}]", parent, index)
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_escape_key_segment_plain() {
        assert_eq!(escape_key_segment("hello"), "hello");
    }

    #[test]
    fn test_escape_key_segment_tilde() {
        assert_eq!(escape_key_segment("a~b"), "a~0b");
    }

    #[test]
    fn test_escape_key_segment_dot() {
        assert_eq!(escape_key_segment("a.b"), "a~1b");
    }

    #[test]
    fn test_escape_key_segment_brackets() {
        assert_eq!(escape_key_segment("a[0]"), "a~20~3");
    }

    #[test]
    fn test_escape_key_segment_all_special() {
        assert_eq!(escape_key_segment("~.[]]"), "~0~1~2~3~3");
    }

    #[test]
    fn test_join_key_path_from_empty_parent() {
        assert_eq!(join_key_path("", "child"), "child");
    }

    #[test]
    fn test_join_key_path_with_parent() {
        assert_eq!(join_key_path("root", "child"), "root.child");
    }

    #[test]
    fn test_join_key_path_escapes_child() {
        assert_eq!(join_key_path("root", "a.b"), "root.a~1b");
    }

    #[test]
    fn test_join_key_path_escapes_child_tilde() {
        assert_eq!(join_key_path("parent", "x~y"), "parent.x~0y");
    }

    #[test]
    fn test_join_array_index() {
        assert_eq!(join_array_index("items", 3), "items[3]");
    }

    #[test]
    fn test_join_array_index_zero() {
        assert_eq!(join_array_index("arr", 0), "arr[0]");
    }

    #[test]
    fn test_is_config_language_json() {
        assert!(is_config_language(&LanguageId::Json));
    }

    #[test]
    fn test_is_config_language_toml() {
        assert!(is_config_language(&LanguageId::Toml));
    }

    #[test]
    fn test_is_config_language_yaml() {
        assert!(is_config_language(&LanguageId::Yaml));
    }

    #[test]
    fn test_is_config_language_markdown() {
        assert!(is_config_language(&LanguageId::Markdown));
    }

    #[test]
    fn test_is_config_language_env() {
        assert!(is_config_language(&LanguageId::Env));
    }

    #[test]
    fn test_is_config_language_rust_false() {
        assert!(!is_config_language(&LanguageId::Rust));
    }

    #[test]
    fn test_edit_capability_for_language_frontend() {
        use crate::domain::LanguageId;

        // Frontend languages should return TextEditSafe
        assert_eq!(
            edit_capability_for_language(&LanguageId::Html),
            Some(EditCapability::TextEditSafe)
        );
        assert_eq!(
            edit_capability_for_language(&LanguageId::Css),
            Some(EditCapability::TextEditSafe)
        );
        assert_eq!(
            edit_capability_for_language(&LanguageId::Scss),
            Some(EditCapability::TextEditSafe)
        );

        // Config languages delegate to their extractor
        // JSON delegates to its extractor — verify it returns Some (exact level varies)
        assert!(edit_capability_for_language(&LanguageId::Json).is_some());

        // Regular source languages return None (unrestricted)
        assert_eq!(edit_capability_for_language(&LanguageId::Rust), None);
        assert_eq!(edit_capability_for_language(&LanguageId::Python), None);
    }
}