feat: add builtin io function modpath() (#1056)

* feat: add builtin io function modpath() Signed-off-by: zongz <zongzhe1024@163.com> * fix: fix test Signed-off-by: zongz <zongzhe1024@163.com> --------- Signed-off-by: zongz <zongzhe1024@163.com>
kcl-lang · Feb 20, 2024 · c047aa0 · c047aa0
1 parent 80168d7
commit c047aa0
Show file tree

Hide file tree

Showing 25 changed files with 131 additions and 9 deletions.
diff --git a/kclvm/api/src/service/service_impl.rs b/kclvm/api/src/service/service_impl.rs
@@ -172,9 +172,9 @@ impl KclvmServiceImpl {
     /// assert_eq!(result.type_errors.len(), 0);
     /// assert_eq!(result.symbols.len(), 12);
     /// assert_eq!(result.scopes.len(), 3);
-    /// assert_eq!(result.node_symbol_map.len(), 161);
-    /// assert_eq!(result.symbol_node_map.len(), 161);
-    /// assert_eq!(result.fully_qualified_name_map.len(), 169);
+    /// assert_eq!(result.node_symbol_map.len(), 162);
+    /// assert_eq!(result.symbol_node_map.len(), 162);
+    /// assert_eq!(result.fully_qualified_name_map.len(), 170);
     /// assert_eq!(result.pkg_scope_map.len(), 3);
     /// ```
     pub fn load_package(&self, args: &LoadPackageArgs) -> anyhow::Result<LoadPackageResult> {

diff --git a/kclvm/compiler/src/codegen/llvm/context.rs b/kclvm/compiler/src/codegen/llvm/context.rs
@@ -1320,6 +1320,14 @@ impl<'ctx> LLVMCodeGenContext<'ctx> {
                 self.pkgpath_stack.borrow_mut().push(pkgpath.clone());
             }
         }
+        // Set the kcl workdir to the runtime context
+        self.build_void_call(
+            &ApiFunc::kclvm_context_set_kcl_modpath.name(),
+            &[
+                self.current_runtime_ctx_ptr(),
+                self.native_global_string_value(&self.program.root),
+            ],
+        );
         if !self.import_names.is_empty() {
             let import_names = self.dict_value();
             for (k, v) in &self.import_names {

diff --git a/kclvm/loader/src/snapshots/kclvm_loader__tests__assign_stmt_0.snap b/kclvm/loader/src/snapshots/kclvm_loader__tests__assign_stmt_0.snap
@@ -38,7 +38,7 @@ expression: "format!(\"{:#?}\", p.symbols.values())"
         def: Some(
             SymbolRef {
                 id: Index {
-                    index: 149,
+                    index: 150,
                     generation: 0,
                 },
                 kind: Value,

diff --git a/kclvm/loader/src/snapshots/kclvm_loader__tests__assign_stmt_1.snap b/kclvm/loader/src/snapshots/kclvm_loader__tests__assign_stmt_1.snap
@@ -38,7 +38,7 @@ expression: "format!(\"{:#?}\", p.symbols.values())"
         def: Some(
             SymbolRef {
                 id: Index {
-                    index: 149,
+                    index: 150,
                     generation: 0,
                 },
                 kind: Value,

diff --git a/kclvm/loader/src/snapshots/kclvm_loader__tests__assign_stmt_2.snap b/kclvm/loader/src/snapshots/kclvm_loader__tests__assign_stmt_2.snap
@@ -38,7 +38,7 @@ expression: "format!(\"{:#?}\", p.symbols.values())"
         def: Some(
             SymbolRef {
                 id: Index {
-                    index: 149,
+                    index: 150,
                     generation: 0,
                 },
                 kind: Value,

diff --git a/kclvm/loader/src/snapshots/kclvm_loader__tests__import_stmt_0.snap b/kclvm/loader/src/snapshots/kclvm_loader__tests__import_stmt_0.snap
@@ -195,7 +195,7 @@ expression: "format!(\"{:#?}\", p.symbols.values())"
         def: Some(
             SymbolRef {
                 id: Index {
-                    index: 149,
+                    index: 150,
                     generation: 0,
                 },
                 kind: Value,

diff --git a/kclvm/loader/src/snapshots/kclvm_loader__tests__import_stmt_1.snap b/kclvm/loader/src/snapshots/kclvm_loader__tests__import_stmt_1.snap
@@ -38,7 +38,7 @@ expression: "format!(\"{:#?}\", p.symbols.values())"
         def: Some(
             SymbolRef {
                 id: Index {
-                    index: 149,
+                    index: 150,
                     generation: 0,
                 },
                 kind: Value,

diff --git a/kclvm/runtime/src/_kclvm.bc b/kclvm/runtime/src/_kclvm.bc
diff --git a/kclvm/runtime/src/_kclvm.h b/kclvm/runtime/src/_kclvm.h
@@ -230,6 +230,8 @@ void kclvm_context_set_kcl_line_col(kclvm_context_t* ctx, int32_t line, int32_t
 
 void kclvm_context_set_kcl_location(kclvm_context_t* p, char* filename, int32_t line, int32_t col);
 
+void kclvm_context_set_kcl_modpath(kclvm_context_t* p, char* module_path);
+
 void kclvm_context_set_kcl_pkgpath(kclvm_context_t* p, char* pkgpath);
 
 void kclvm_context_set_list_option_mode(kclvm_context_t* p, kclvm_bool_t v);
@@ -302,6 +304,8 @@ kclvm_value_ref_t* kclvm_dict_values(kclvm_context_t* ctx, kclvm_value_ref_t* p)
 
 kclvm_value_ref_t* kclvm_file_glob(kclvm_context_t* ctx, kclvm_value_ref_t* args, kclvm_value_ref_t* _kwargs);
 
+kclvm_value_ref_t* kclvm_file_modpath(kclvm_context_t* ctx, kclvm_value_ref_t* _args, kclvm_value_ref_t* _kwargs);
+
 kclvm_value_ref_t* kclvm_file_read(kclvm_context_t* ctx, kclvm_value_ref_t* args, kclvm_value_ref_t* _kwargs);
 
 kclvm_value_ref_t* kclvm_iterator_cur_key(kclvm_iterator_t* p);

diff --git a/kclvm/runtime/src/_kclvm.ll b/kclvm/runtime/src/_kclvm.ll
@@ -178,6 +178,8 @@ declare void @kclvm_context_set_kcl_line_col(%kclvm_context_t* %ctx, i32 %line,
 
 declare void @kclvm_context_set_kcl_location(%kclvm_context_t* %p, i8* %filename, i32 %line, i32 %col);
 
+declare void @kclvm_context_set_kcl_modpath(%kclvm_context_t* %p, i8* %module_path);
+
 declare void @kclvm_context_set_kcl_pkgpath(%kclvm_context_t* %p, i8* %pkgpath);
 
 declare void @kclvm_context_set_list_option_mode(%kclvm_context_t* %p, %kclvm_bool_t %v);
@@ -250,6 +252,8 @@ declare %kclvm_value_ref_t* @kclvm_dict_values(%kclvm_context_t* %ctx, %kclvm_va
 
 declare %kclvm_value_ref_t* @kclvm_file_glob(%kclvm_context_t* %ctx, %kclvm_value_ref_t* %args, %kclvm_value_ref_t* %_kwargs);
 
+declare %kclvm_value_ref_t* @kclvm_file_modpath(%kclvm_context_t* %ctx, %kclvm_value_ref_t* %_args, %kclvm_value_ref_t* %_kwargs);
+
 declare %kclvm_value_ref_t* @kclvm_file_read(%kclvm_context_t* %ctx, %kclvm_value_ref_t* %args, %kclvm_value_ref_t* %_kwargs);
 
 declare %kclvm_value_ref_t* @kclvm_iterator_cur_key(%kclvm_iterator_t* %p);

diff --git a/kclvm/runtime/src/_kclvm.rs b/kclvm/runtime/src/_kclvm.rs
@@ -101,6 +101,7 @@ pub enum ApiFunc {
     kclvm_context_set_kcl_filename,
     kclvm_context_set_kcl_line_col,
     kclvm_context_set_kcl_location,
+    kclvm_context_set_kcl_modpath,
     kclvm_context_set_kcl_pkgpath,
     kclvm_context_set_list_option_mode,
     kclvm_context_set_strict_range_check,
@@ -137,6 +138,7 @@ pub enum ApiFunc {
     kclvm_dict_update_key_value,
     kclvm_dict_values,
     kclvm_file_glob,
+    kclvm_file_modpath,
     kclvm_file_read,
     kclvm_iterator_cur_key,
     kclvm_iterator_cur_value,

diff --git a/kclvm/runtime/src/_kclvm_addr.rs b/kclvm/runtime/src/_kclvm_addr.rs
@@ -98,6 +98,7 @@ pub fn _kclvm_get_fn_ptr_by_name(name: &str) -> u64 {
         "kclvm_context_set_kcl_location" => {
             crate::kclvm_context_set_kcl_location as *const () as u64
         }
+        "kclvm_context_set_kcl_modpath" => crate::kclvm_context_set_kcl_modpath as *const () as u64,
         "kclvm_context_set_kcl_pkgpath" => crate::kclvm_context_set_kcl_pkgpath as *const () as u64,
         "kclvm_context_set_list_option_mode" => {
             crate::kclvm_context_set_list_option_mode as *const () as u64
@@ -144,6 +145,7 @@ pub fn _kclvm_get_fn_ptr_by_name(name: &str) -> u64 {
         "kclvm_dict_update_key_value" => crate::kclvm_dict_update_key_value as *const () as u64,
         "kclvm_dict_values" => crate::kclvm_dict_values as *const () as u64,
         "kclvm_file_glob" => crate::kclvm_file_glob as *const () as u64,
+        "kclvm_file_modpath" => crate::kclvm_file_modpath as *const () as u64,
         "kclvm_file_read" => crate::kclvm_file_read as *const () as u64,
         "kclvm_iterator_cur_key" => crate::kclvm_iterator_cur_key as *const () as u64,
         "kclvm_iterator_cur_value" => crate::kclvm_iterator_cur_value as *const () as u64,

diff --git a/kclvm/runtime/src/_kclvm_api_spec.rs b/kclvm/runtime/src/_kclvm_api_spec.rs
@@ -26,6 +26,10 @@
 // api-spec(c):    void kclvm_context_set_kcl_pkgpath(kclvm_context_t* p, char* pkgpath);
 // api-spec(llvm): declare void @kclvm_context_set_kcl_pkgpath(%kclvm_context_t* %p, i8* %pkgpath);
 
+// api-spec:       kclvm_context_set_kcl_modpath
+// api-spec(c):    void kclvm_context_set_kcl_modpath(kclvm_context_t* p, char* module_path);
+// api-spec(llvm): declare void @kclvm_context_set_kcl_modpath(%kclvm_context_t* %p, i8* %module_path);
+
 // api-spec:       kclvm_context_set_kcl_filename
 // api-spec(c):    void kclvm_context_set_kcl_filename(kclvm_context_t* ctx, char* filename);
 // api-spec(llvm): declare void @kclvm_context_set_kcl_filename(%kclvm_context_t* %ctx, i8* %filename);
@@ -1182,3 +1186,7 @@
 // api-spec(c):    kclvm_value_ref_t* kclvm_file_glob(kclvm_context_t* ctx, kclvm_value_ref_t* args, kclvm_value_ref_t* _kwargs);
 // api-spec(llvm): declare %kclvm_value_ref_t* @kclvm_file_glob(%kclvm_context_t* %ctx, %kclvm_value_ref_t* %args, %kclvm_value_ref_t* %_kwargs);
 
+// api-spec:       kclvm_file_modpath
+// api-spec(c):    kclvm_value_ref_t* kclvm_file_modpath(kclvm_context_t* ctx, kclvm_value_ref_t* _args, kclvm_value_ref_t* _kwargs);
+// api-spec(llvm): declare %kclvm_value_ref_t* @kclvm_file_modpath(%kclvm_context_t* %ctx, %kclvm_value_ref_t* %_args, %kclvm_value_ref_t* %_kwargs);
+
diff --git a/kclvm/runtime/src/api/kclvm.rs b/kclvm/runtime/src/api/kclvm.rs
@@ -360,6 +360,7 @@ pub struct Context {
     pub output: ContextOutput,
     pub panic_info: PanicInfo,
 
+    pub module_path: String,
     pub main_pkg_path: String,
     pub main_pkg_files: Vec<String>,
     pub backtrace: Vec<BacktraceFrame>,

diff --git a/kclvm/runtime/src/context/api.rs b/kclvm/runtime/src/context/api.rs
@@ -108,6 +108,18 @@ pub unsafe extern "C" fn kclvm_context_set_kcl_pkgpath(
     }
 }
 
+#[no_mangle]
+#[runtime_fn]
+pub unsafe extern "C" fn kclvm_context_set_kcl_modpath(
+    p: *mut kclvm_context_t,
+    module_path: *const c_char,
+) {
+    let p = mut_ptr_as_ref(p);
+    if !module_path.is_null() {
+        p.set_kcl_module_path(c2str(module_path));
+    }
+}
+
 #[no_mangle]
 #[runtime_fn]
 pub unsafe extern "C" fn kclvm_context_set_kcl_filename(

diff --git a/kclvm/runtime/src/context/mod.rs b/kclvm/runtime/src/context/mod.rs
@@ -109,6 +109,10 @@ impl crate::Context {
         self.panic_info.kcl_pkgpath = pkgpath.to_string();
     }
 
+    pub fn set_kcl_module_path(&mut self, module_path: &str) {
+        self.module_path = module_path.to_string();
+    }
+
     pub fn set_kcl_filename(&mut self, file: &str) {
         if !file.is_empty() {
             self.panic_info.kcl_file = file.to_string();

diff --git a/kclvm/runtime/src/file/mod.rs b/kclvm/runtime/src/file/mod.rs
@@ -54,3 +54,15 @@ pub extern "C" fn kclvm_file_glob(
 
     return ValueRef::list_str(matched_paths.as_slice()).into_raw(ctx);
 }
+
+#[no_mangle]
+#[runtime_fn]
+pub extern "C" fn kclvm_file_modpath(
+    ctx: *mut kclvm_context_t,
+    _args: *const kclvm_value_ref_t,
+    _kwargs: *const kclvm_value_ref_t,
+) -> *const kclvm_value_ref_t {
+    let ctx = mut_ptr_as_ref(ctx);
+    let s = ValueRef::str(&ctx.module_path.as_ref());
+    return s.into_raw(ctx);
+}
diff --git a/kclvm/sema/src/builtin/system_module.rs b/kclvm/sema/src/builtin/system_module.rs
@@ -1554,7 +1554,7 @@ register_collection_member! {
 // ------------------------------
 
 pub const FILE: &str = "file";
-pub const FILE_FUNCTION_NAMES: &[&str] = &["read", "glob"];
+pub const FILE_FUNCTION_NAMES: &[&str] = &["read", "glob", "modpath"];
 macro_rules! register_file_member {
     ($($name:ident => $ty:expr)*) => (
         pub const FILE_FUNCTION_TYPES: Lazy<IndexMap<String, Type>> = Lazy::new(|| {
@@ -1593,6 +1593,14 @@ register_file_member! {
         false,
         None,
     )
+    modpath => Type::function(
+        None,
+        Type::str_ref(),
+        &[],
+        r#"return the module root path (kcl.mod file path or a single *.k file path)"#,
+        false,
+        None,
+    )
 }
 
 pub const STANDARD_SYSTEM_MODULES: &[&str] = &[

diff --git a/test/grammar/builtins/file/mod_root/main.k b/test/grammar/builtins/file/mod_root/main.k
@@ -0,0 +1,8 @@
+import file
+import json
+
+data_string = json.decode(file.read(file.modpath()+"/test.json"))
+
+key1 = data_string.key1
+key2 = data_string.key2
+data = data_string.data
diff --git a/test/grammar/builtins/file/mod_root/stdout.golden b/test/grammar/builtins/file/mod_root/stdout.golden
@@ -0,0 +1,13 @@
+data_string:
+  key1: value1
+  key2: value2
+  data:
+  - 1
+  - 2
+  - 3
+key1: value1
+key2: value2
+data:
+- 1
+- 2
+- 3
diff --git a/test/grammar/builtins/file/mod_root/test.json b/test/grammar/builtins/file/mod_root/test.json
@@ -0,0 +1,5 @@
+{
+    "key1": "value1",
+    "key2": "value2",
+    "data": [1, 2, 3]
+}
diff --git a/test/grammar/builtins/file/mod_root_sub/kcl.mod b/test/grammar/builtins/file/mod_root_sub/kcl.mod
@@ -0,0 +1,5 @@
+[package]
+name = "workdir_sub"
+edition = "0.0.1"
+version = "0.0.1"
+
diff --git a/test/grammar/builtins/file/mod_root_sub/stdout.golden b/test/grammar/builtins/file/mod_root_sub/stdout.golden
@@ -0,0 +1,13 @@
+data_string:
+  key1: value1
+  key2: value2
+  data:
+  - 1
+  - 2
+  - 3
+key1: value1
+key2: value2
+data:
+- 1
+- 2
+- 3
diff --git a/test/grammar/builtins/file/mod_root_sub/sub/main.k b/test/grammar/builtins/file/mod_root_sub/sub/main.k
@@ -0,0 +1,8 @@
+import file
+import json
+
+data_string = json.decode(file.read(file.modpath()+"/test.json"))
+
+key1 = data_string.key1
+key2 = data_string.key2
+data = data_string.data
diff --git a/test/grammar/builtins/file/mod_root_sub/test.json b/test/grammar/builtins/file/mod_root_sub/test.json
@@ -0,0 +1,5 @@
+{
+    "key1": "value1",
+    "key2": "value2",
+    "data": [1, 2, 3]
+}