cymbal 0.13.0

search for symbols in a codebase
Documentation 
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

use chrono::{DateTime, Utc};
use serde::Deserialize;
use sqlx::Type as SqlxType;

use crate::{color, config::Language};

#[derive(sqlx::FromRow)]
pub struct FileInfo {
  pub modified: DateTime<Utc>,
  pub is_fully_parsed: bool,
}

#[derive(sqlx::FromRow, Debug)]
pub struct Symbol {
  pub kind: Kind,
  pub language: Language,
  pub line: i64,
  pub column: i64,
  pub content: String,
  pub leading: Option<String>,
  pub trailing: Option<String>,
}

impl Symbol {
  pub fn leading_str(&self) -> &str {
    self.leading.as_deref().unwrap_or("")
  }

  pub fn trailing_str(&self) -> &str {
    self.trailing.as_deref().unwrap_or("")
  }
}

#[derive(Clone, Copy, Debug, Deserialize, PartialEq, Eq, Hash, SqlxType)]
#[serde(rename_all = "lowercase")]
#[repr(u8)]
pub enum Kind {
  Module,
  Macro,
  Global,
  Constant,
  Define,

  Class,
  Struct,
  Enum,
  Union,

  Alias,
  Interface,
  Trait,
  Type,

  Function,
  Method,
  Impl,
  Field,

  Variant,

  Mode,
  Hook,
}

impl Kind {
  #[rustfmt::skip]
  pub fn colored(self) -> &'static str {
    // TODO(enricozb): have some macro generate this to automatically pad all
    // symbols.
    // Note: these strings must all have the same printable length.
    match self {
      Self::Module    => color!("module ", yellow),
      Self::Macro     => color!("macro  ", yellow),
      Self::Global    => color!("global ", yellow),
      Self::Constant  => color!("const  ", yellow),
      Self::Define    => color!("define ", yellow),

      Self::Class     => color!("class  ", cyan),
      Self::Struct    => color!("struct ", cyan),
      Self::Enum      => color!("enum   ", cyan),
      Self::Union     => color!("union  ", cyan),

      Self::Alias     => color!("alias  ", blue),
      Self::Interface => color!("inter  ", blue),
      Self::Trait     => color!("trait  ", blue),
      Self::Type      => color!("type   ", blue),

      Self::Function  => color!("func   ", magenta),
      Self::Method    => color!("method ", magenta),
      Self::Impl      => color!("impl   ", magenta),
      Self::Field     => color!("field  ", magenta),

      Self::Variant   => color!("variant", green),

      Self::Mode      => color!("mode   ", blue),
      Self::Hook      => color!("hook   ", green),
    }
  }
}