cymbal 0.9.0

search for symbols in a codebase
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use std::collections::HashSet;
use std::path::Path;

use anyhow::Result;
use chrono::{DateTime, Utc};
use futures::{Stream, StreamExt};

use crate::cache::Cache;
use crate::channel::{FileTask, Receiver};
use crate::config::Config;
use crate::ext::{IntoExt, TryStreamExt};
use crate::parser::Parser;
use crate::symbol::Symbol;

pub struct Worker {
  cache: Option<Cache>,
  config: &'static Config,
  receiver: Receiver,
  delimiter: char,
  separator: char,
}

impl Worker {
  pub fn new(cache: Option<Cache>, config: &'static Config, receiver: Receiver, delimiter: char, separator: char) -> Self {
    Self {
      cache,
      config,
      receiver,
      delimiter,
      separator,
    }
  }

  async fn process_file_task(&self, file_task: FileTask) -> Result<()> {
    let FileTask {
      ref file_path,
      ref file_modified,
      language,
    } = file_task;

    if !self.config.contains_language(language) {
      return ().ok();
    }

    let Some(cache) = &self.cache else {
      let symbol_stream = Parser::new(file_path, language, self.config).symbol_stream().await?;
      self.emit_symbols(file_path, symbol_stream).await;

      return ().ok();
    };

    if cache.is_file_cached(file_path, file_modified).await? {
      let symbol_stream = cache.get_symbols(file_path).filter_ok();
      self.emit_symbols(file_path, symbol_stream).await;

      return ().ok();
    }

    let symbol_stream = Parser::new(file_path, language, self.config).symbol_stream().await?;

    self.cache_and_emit_symbols(cache, file_path, file_modified, symbol_stream).await
  }

  async fn emit_symbols(&self, file_path: &Path, symbol_stream: impl Stream<Item = Symbol>) {
    symbol_stream
      .unique_symbols()
      .map(|symbol| self.print_symbol(file_path, &symbol))
      .collect::<()>()
      .await;
  }

  async fn cache_and_emit_symbols(
    &self,
    cache: &Cache,
    file_path: &Path,
    file_modified: &DateTime<Utc>,
    symbol_stream: impl Stream<Item = Symbol>,
  ) -> Result<()> {
    let symbol_stream = symbol_stream.unique_symbols();
    let mut symbols = Vec::new();
    futures::pin_mut!(symbol_stream);

    while let Some(symbol) = symbol_stream.next().await {
      self.print_symbol(file_path, &symbol);

      symbols.push(symbol);
    }

    cache.insert_file(file_path, file_modified).await?;
    cache.insert_symbols(file_path, &symbols).await?;
    cache.set_file_is_fully_parsed(file_path).await?;

    ().ok()
  }

  fn print_symbol(&self, file_path: &Path, symbol: &Symbol) {
    print!(
      "{lang}{dlm}{kind}{dlm}{path}{dlm}{line}{dlm}{col}{dlm}{lead}{dlm}{text}{dlm}{trail}{end}",
      lang = symbol.language.colored_abbreviation(),
      kind = symbol.kind.colored_abbreviation(),
      path = file_path.display(),
      line = symbol.line,
      col = symbol.column,
      lead = symbol.leading_str(),
      text = symbol.content,
      trail = symbol.trailing_str(),
      dlm = self.delimiter,
      end = self.separator,
    );
  }

  pub async fn run(self) -> Result<()> {
    // TODO(enricozb): try using `self.receiver` as a `Stream`.
    while let Ok(file_task) = self.receiver.recv().await {
      self.process_file_task(file_task).await?;
    }

    ().ok()
  }
}

#[extend::ext]
impl<T: Stream<Item = Symbol>> T {
  fn unique_symbols(self) -> impl Stream<Item = Symbol> {
    let mut symbol_positions = HashSet::<(i64, i64)>::new();

    // TODO(enricozb): it looks like some symbols are appearing before others,
    // and precedence is not respected. Specifically in the rust language it
    // seems that methods, despite appearing before functions in the default
    // config, do not override the functions in the outputted symbols.
    self.filter_map(move |symbol| {
      let position = (symbol.line, symbol.column);
      if symbol_positions.contains(&position) {
        None.ready()
      } else {
        symbol_positions.insert(position);
        symbol.some().ready()
      }
    })
  }
}