add access path for expr

Author: CppCXY

Cargo.lock

@@ -22,10 +22,6 @@ We welcome your feedback and contributions. Please feel free to submit pull requ
 - [Emmyrc Config](./docs/config/emmyrc_json_EN.md)
 - [Formatting Config](https://github.com/CppCXY/EmmyLuaCodeStyle/blob/master/README_EN.md)
 
-## Install
-
-TODO
-
 ## Build
 
 ```shell

README.md

@@ -2,12 +2,6 @@
 
 This is a command line tool for generating EmmyLua doc from Lua source code.
 
-## Install
-
-```shell
-cargo install emmylua_doc_cli
-```
-
 ## Usage
 
 ```shell

crates/emmylua_doc_cli/README.md

@@ -1,6 +1,6 @@
 [package]
 name = "emmylua_parser"
-version = "0.9.0"
+version = "0.9.1"
 edition = "2021"
 authors = ["CppCXY"]
 description = "A parser for EmmyLua and luals"

crates/emmylua_parser/Cargo.toml

@@ -8,7 +8,7 @@ use crate::{
     LuaAstToken, LuaIndexToken, LuaLiteralToken, LuaSyntaxNode, LuaSyntaxToken, LuaTokenKind,
 };
 
-use super::{LuaBlock, LuaCallArgList, LuaIndexKey, LuaParamList, LuaTableField};
+use super::{path_trait::PathTrait, LuaBlock, LuaCallArgList, LuaIndexKey, LuaParamList, LuaTableField};
 
 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
 pub enum LuaExpr {
@@ -221,6 +221,8 @@ impl LuaNameExpr {
     }
 }
 
+impl PathTrait for LuaNameExpr {}
+
 impl From<LuaNameExpr> for LuaVarExpr {
     fn from(expr: LuaNameExpr) -> Self {
         LuaVarExpr::NameExpr(expr)
@@ -312,6 +314,8 @@ impl LuaIndexExpr {
     }
 }
 
+impl PathTrait for LuaIndexExpr {}
+
 impl From<LuaIndexExpr> for LuaVarExpr {
     fn from(expr: LuaIndexExpr) -> Self {
         LuaVarExpr::IndexExpr(expr)
@@ -370,6 +374,8 @@ impl LuaCallExpr {
     }
 }
 
+impl PathTrait for LuaCallExpr {}
+
 impl From<LuaCallExpr> for LuaExpr {
     fn from(expr: LuaCallExpr) -> Self {
         LuaExpr::CallExpr(expr)

crates/emmylua_parser/src/syntax/node/lua/expr.rs

@@ -1,5 +1,7 @@
 mod expr;
 mod stat;
+mod path_trait;
+mod test;
 
 use crate::{
     kind::{LuaSyntaxKind, LuaTokenKind},
@@ -9,6 +11,7 @@ use crate::{
 
 pub use expr::*;
 pub use stat::*;
+pub use path_trait::*;
 
 use super::{LuaLiteralToken, LuaNameToken, LuaNumberToken, LuaStringToken};
 

crates/emmylua_parser/src/syntax/node/lua/mod.rs

@@ -0,0 +1,48 @@
+use crate::LuaAstNode;
+
+use super::{LuaExpr, LuaIndexKey};
+
+pub trait PathTrait : LuaAstNode {
+    fn get_access_path(&self) -> Option<String> {
+        let mut paths = Vec::new();
+        let mut current_node = self.syntax().clone();
+        loop {
+            match LuaExpr::cast(current_node)? {
+                LuaExpr::NameExpr(name_expr) => {
+                    let name = name_expr.get_name_text()?;
+                    if paths.is_empty() {
+                        return Some(name);
+                    } else {
+                        paths.push(name);
+                        paths.reverse();
+                        return Some(paths.join("."));
+                    }
+                }
+                LuaExpr::CallExpr(call_expr) => {
+                    let prefix_expr = call_expr.get_prefix_expr()?;
+                    current_node = prefix_expr.syntax().clone();
+                }
+                LuaExpr::IndexExpr(index_expr) => {
+                    match index_expr.get_index_key()? {
+                        LuaIndexKey::String(s) => {
+                            paths.push(s.get_value());
+                        }
+                        LuaIndexKey::Name(name) => {
+                            paths.push(name.get_name_text().to_string());
+                        }
+                        LuaIndexKey::Integer(i) => {
+                            paths.push(i.get_int_value().to_string());
+                        }
+                        LuaIndexKey::Expr(expr) => {
+                            let text = format!("[{}]", expr.syntax().text());
+                            paths.push(text);
+                        }
+                    }
+
+                    current_node = index_expr.get_prefix_expr()?.syntax().clone();
+                }
+                _ => return None,
+            }
+        }
+    }
+}

crates/emmylua_parser/src/syntax/node/lua/path_trait.rs

@@ -0,0 +1,56 @@
+#[cfg(test)]
+mod tests {
+    use crate::{LuaAstNode, LuaCallExpr, LuaIndexExpr, LuaNameExpr, LuaParser, LuaSyntaxTree, ParserConfig, PathTrait};
+
+    fn get_tree(code: &str) -> LuaSyntaxTree {
+        let config = ParserConfig::default();
+        let tree = LuaParser::parse(code, config);
+        tree
+    }
+
+
+    #[test]
+    fn test_call_access_path() {
+        let code = "call.ddd()";
+        let tree = get_tree(code);
+        let root = tree.get_chunk_node();
+        let call_expr = root.descendants::<LuaCallExpr>().next().unwrap();
+        assert_eq!(call_expr.get_access_path().unwrap(), "call.ddd");
+    }
+
+    #[test]
+    fn test_call_access_path2() {
+        let code = "call[1].aaa.bbb.ccc()";
+        let tree = get_tree(code);
+        let root = tree.get_chunk_node();
+        let call_expr = root.descendants::<LuaCallExpr>().next().unwrap();
+        assert_eq!(call_expr.get_access_path().unwrap(), "call.1.aaa.bbb.ccc");
+    }
+
+    #[test]
+    fn test_name_access_path() {
+        let code = "local a = name";
+        let tree = get_tree(code);
+        let root = tree.get_chunk_node();
+        let name_expr = root.descendants::<LuaNameExpr>().next().unwrap();
+        assert_eq!(name_expr.get_access_path().unwrap(), "name");
+    }
+
+    #[test]
+    fn test_index_expr_access_path() {
+        let code = "local a = name.bbb.ccc";
+        let tree = get_tree(code);
+        let root = tree.get_chunk_node();
+        let index_expr = root.descendants::<LuaIndexExpr>().next().unwrap();
+        assert_eq!(index_expr.get_access_path().unwrap(), "name.bbb.ccc");
+    }
+
+    #[test]
+    fn test_index_expr_access_path2() {
+        let code = "local a = name[okok.yes]";
+        let tree = get_tree(code);
+        let root = tree.get_chunk_node();
+        let index_expr = root.descendants::<LuaIndexExpr>().next().unwrap();
+        assert_eq!(index_expr.get_access_path().unwrap(), "name.[okok.yes]");
+    }
+}

crates/emmylua_parser/src/syntax/node/lua/test.rs

@@ -58,7 +58,7 @@ pub trait LuaAstNode {
             WalkEvent::Leave(node) => N::cast(node).map(WalkEvent::Leave),
         })
     }
-    
+
     fn ancestors<N: LuaAstNode>(&self) -> impl Iterator<Item = N> {
         self.syntax().ancestors().filter_map(N::cast)
     }
@@ -89,8 +89,8 @@ pub trait LuaAstNode {
         LuaSyntaxId::from_node(self.syntax())
     }
 
-    fn dump(&self) {
-        println!("{:#?}", self.syntax());
+    fn dump(&self) -> String {
+        format!("{:#?}", self.syntax())
     }
 }
 
@@ -158,8 +158,8 @@ pub trait LuaAstToken {
         self.syntax().parent_ancestors().filter_map(N::cast)
     }
 
-    fn dump(&self) {
-        println!("{:#?}", self.syntax());
+    fn dump(&self) -> String {
+        format!("{:#?}", self.syntax())
     }
 }