feat: parser API (#208)

* feat: parser API Signed-off-by: peefy <[email protected]> * chore: bump kcl-go to v0.7.5 Signed-off-by: peefy <[email protected]> --------- Signed-off-by: peefy <[email protected]>
kcl-lang · Jan 14, 2024 · de70a20 · de70a20
1 parent e5c4ee1
commit de70a20
Show file tree

Hide file tree

Showing 59 changed files with 1,256 additions and 1,128 deletions.
diff --git a/bench_test.go b/bench_test.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kclvm
 

diff --git a/example_test.go b/example_test.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kclvm_test
 

diff --git a/go.mod b/go.mod
@@ -22,7 +22,7 @@ require (
 	google.golang.org/protobuf v1.30.0
 	gopkg.in/yaml.v3 v3.0.1
 	kcl-lang.io/kpm v0.4.6
-	kcl-lang.io/lib v0.7.4
+	kcl-lang.io/lib v0.7.5
 )
 
 require (

diff --git a/go.sum b/go.sum
@@ -794,8 +794,8 @@ honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9
 honnef.co/go/tools v0.0.1-2020.1.4/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k=
 kcl-lang.io/kpm v0.4.6 h1:yaQdRQMqByaxyUb3uEp27zI7xxcsnp1iIcgqU9hFVqI=
 kcl-lang.io/kpm v0.4.6/go.mod h1:Ba2ijUHQR/sMdB4S7982vOrajly4LdgshrqXd2SXBog=
-kcl-lang.io/lib v0.7.4 h1:D1mSGI6Ggb9B3lQqoscQuSOnaBpnkvucZA0WWWniLO0=
-kcl-lang.io/lib v0.7.4/go.mod h1:ubsalGXxJaa5II/EsHmsI/tL2EluYHIcW+BwzQPt+uY=
+kcl-lang.io/lib v0.7.5 h1:Gr4a6RZ9DmdNmJ8+VqT3IpkOjgySzGWYXzWZhQX+UK0=
+kcl-lang.io/lib v0.7.5/go.mod h1:ubsalGXxJaa5II/EsHmsI/tL2EluYHIcW+BwzQPt+uY=
 oras.land/oras-go v1.2.3 h1:v8PJl+gEAntI1pJ/LCrDgsuk+1PKVavVEPsYIHFE5uY=
 oras.land/oras-go v1.2.3/go.mod h1:M/uaPdYklze0Vf3AakfarnpoEckvw0ESbRdN8Z1vdJg=
 oras.land/oras-go/v2 v2.3.0 h1:lqX1aXdN+DAmDTKjiDyvq85cIaI4RkIKp/PghWlAGIU=

diff --git a/kclvm_test.go b/kclvm_test.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kclvm_test
 
@@ -520,9 +520,9 @@ func TestTestAPI(t *testing.T) {
 }
 
 func TestWithExternalpkg(t *testing.T) {
-	absPath1, err := filepath.Abs("./testdata_external/external_1/")
+	absPath1, err := filepath.Abs("./testdata/external/external_1/")
 	assert2.Equal(t, nil, err)
-	absPath2, err := filepath.Abs("./testdata_external/external_2/")
+	absPath2, err := filepath.Abs("./testdata/external/external_2/")
 	assert2.Equal(t, nil, err)
 	opt := kcl.WithExternalPkgs("external_1="+absPath1, "external_2="+absPath2)
 	result, err := kcl.Run("./testdata/import-external/main.k", opt)

diff --git a/kclvm_version.go b/kclvm_version.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kclvm
 

diff --git a/pkg/kcl/api.go b/pkg/kcl/api.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 // Package kcl defines the top-level interface for KCL.
 package kcl

diff --git a/pkg/kcl/api_test.go b/pkg/kcl/api_test.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kcl
 

diff --git a/pkg/kcl/opt.go b/pkg/kcl/opt.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kcl
 

diff --git a/pkg/kcl/opt_test.go b/pkg/kcl/opt_test.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kcl
 

diff --git a/pkg/kcl/testing_test.go b/pkg/kcl/testing_test.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kcl
 

diff --git a/pkg/kcl/utils.go b/pkg/kcl/utils.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kcl
 

diff --git a/pkg/kclvm_runtime/builtin_service_client.go b/pkg/kclvm_runtime/builtin_service_client.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kclvm_runtime
 

diff --git a/pkg/kclvm_runtime/init.go b/pkg/kclvm_runtime/init.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kclvm_runtime
 

diff --git a/pkg/kclvm_runtime/kclvm.go b/pkg/kclvm_runtime/kclvm.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kclvm_runtime
 

diff --git a/pkg/kclvm_runtime/proc.go b/pkg/kclvm_runtime/proc.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kclvm_runtime
 

diff --git a/pkg/kclvm_runtime/runtime.go b/pkg/kclvm_runtime/runtime.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package kclvm_runtime
 

diff --git a/pkg/logger/example_test.go b/pkg/logger/example_test.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package logger_test
 

diff --git a/pkg/logger/logger.go b/pkg/logger/logger.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package logger
 

diff --git a/pkg/parser/parser.go b/pkg/parser/parser.go
@@ -0,0 +1,43 @@
+package parser
+
+import (
+	"fmt"
+	"io"
+
+	"kcl-lang.io/kcl-go/pkg/service"
+	"kcl-lang.io/kcl-go/pkg/spec/gpyrpc"
+)
+
+// ParseFileASTJson parses the source code from the specified file or Reader
+// and returns the JSON representation of the Abstract Syntax Tree (AST).
+// The source code can be provided directly as a string or []byte,
+// or indirectly via a filename or an io.Reader.
+// If src is nil, the function reads the content from the provided filename.
+func ParseFileASTJson(filename string, src interface{}) (result string, err error) {
+	var code string
+	if src != nil {
+		switch src := src.(type) {
+		case []byte:
+			code = string(src)
+		case string:
+			code = string(src)
+		case io.Reader:
+			d, err := io.ReadAll(src)
+			if err != nil {
+				return "", err
+			}
+			code = string(d)
+		default:
+			return "", fmt.Errorf("unsupported src type: %T", src)
+		}
+	}
+	client := service.NewKclvmServiceClient()
+	resp, err := client.ParseFile(&gpyrpc.ParseFile_Args{
+		Path:   filename,
+		Source: code,
+	})
+	if err != nil {
+		return "", err
+	}
+	return resp.AstJson, nil
+}
diff --git a/pkg/parser/parser_test.go b/pkg/parser/parser_test.go
@@ -0,0 +1,52 @@
+package parser
+
+import (
+	"strings"
+	"testing"
+	"time"
+)
+
+// TestParseFileASTJson tests the ParseFileASTJson function with various input sources.
+func TestParseFileASTJson(t *testing.T) {
+	// Example: Test with string source
+	src := `schema Name:
+    name: str
+	
+n = Name {name = "name"}` // Sample KCL source code
+	astJson, err := ParseFileASTJson("", src)
+	if err != nil {
+		t.Errorf("ParseFileASTJson failed with string source: %v", err)
+	}
+	if astJson == "" {
+		t.Errorf("Expected non-empty AST JSON with string source")
+	}
+
+	// Example: Test with byte slice source
+	srcBytes := []byte(src)
+	astJson, err = ParseFileASTJson("", srcBytes)
+	if err != nil {
+		t.Errorf("ParseFileASTJson failed with byte slice source: %v", err)
+	}
+	if astJson == "" {
+		t.Errorf("Expected non-empty AST JSON with byte slice source")
+	}
+
+	startTime := time.Now()
+	// Example: Test with io.Reader source
+	srcReader := strings.NewReader(src)
+	astJson, err = ParseFileASTJson("", srcReader)
+	if err != nil {
+		t.Errorf("ParseFileASTJson failed with io.Reader source: %v", err)
+	}
+	if astJson == "" {
+		t.Errorf("Expected non-empty AST JSON with io.Reader source")
+	}
+	elapsed := time.Since(startTime)
+	t.Logf("ParseFileASTJson took %s", elapsed)
+	if !strings.Contains(astJson, "Schema") {
+		t.Errorf("Expected Schema Node AST JSON with io.Reader source")
+	}
+	if !strings.Contains(astJson, "Assign") {
+		t.Errorf("Expected Assign Node AST JSON with io.Reader source")
+	}
+}
diff --git a/pkg/service/client_builtin_service.go b/pkg/service/client_builtin_service.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package service
 

diff --git a/pkg/service/client_kclvm_service.go b/pkg/service/client_kclvm_service.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package service
 
@@ -53,6 +53,22 @@ func (p *KclvmServiceClient) ExecProgram(args *gpyrpc.ExecProgram_Args) (resp *g
 	return
 }
 
+func (p *KclvmServiceClient) ParseFile(args *gpyrpc.ParseFile_Args) (resp *gpyrpc.ParseFile_Result, err error) {
+	p.Runtime.DoTask(func(c *rpc.Client, stderr io.Reader) {
+		resp, err = p.getClient(c).ParseFile(args)
+		err = p.wrapErr(err, stderr)
+	})
+	return
+}
+
+func (p *KclvmServiceClient) ParseProgram(args *gpyrpc.ParseProgram_Args) (resp *gpyrpc.ParseProgram_Result, err error) {
+	p.Runtime.DoTask(func(c *rpc.Client, stderr io.Reader) {
+		resp, err = p.getClient(c).ParseProgram(args)
+		err = p.wrapErr(err, stderr)
+	})
+	return
+}
+
 func (p *KclvmServiceClient) FormatCode(args *gpyrpc.FormatCode_Args) (resp *gpyrpc.FormatCode_Result, err error) {
 	p.Runtime.DoTask(func(c *rpc.Client, stderr io.Reader) {
 		resp, err = p.getClient(c).FormatCode(args)

diff --git a/pkg/service/grpc_server.go b/pkg/service/grpc_server.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package service
 
@@ -43,6 +43,12 @@ func (p *_KclvmServiceImpl) Ping(ctx context.Context, args *gpyrpc.Ping_Args) (*
 func (p *_KclvmServiceImpl) ExecProgram(ctx context.Context, args *gpyrpc.ExecProgram_Args) (*gpyrpc.ExecProgram_Result, error) {
 	return p.c.ExecProgram(args)
 }
+func (p *_KclvmServiceImpl) ParseFile(ctx context.Context, args *gpyrpc.ParseFile_Args) (*gpyrpc.ParseFile_Result, error) {
+	return p.c.ParseFile(args)
+}
+func (p *_KclvmServiceImpl) ParseProgram(ctx context.Context, args *gpyrpc.ParseProgram_Args) (*gpyrpc.ParseProgram_Result, error) {
+	return p.c.ParseProgram(args)
+}
 func (p *_KclvmServiceImpl) FormatCode(ctx context.Context, args *gpyrpc.FormatCode_Args) (*gpyrpc.FormatCode_Result, error) {
 	return p.c.FormatCode(args)
 }

diff --git a/pkg/service/http_post.go b/pkg/service/http_post.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package service
 

diff --git a/pkg/service/kcl_error.go b/pkg/service/kcl_error.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package service
 

diff --git a/pkg/service/kclvm_service.go b/pkg/service/kclvm_service.go
@@ -5,6 +5,8 @@ import "kcl-lang.io/kcl-go/pkg/spec/gpyrpc"
 type KclvmService interface {
 	Ping(in *gpyrpc.Ping_Args) (out *gpyrpc.Ping_Result, err error)
 	ExecProgram(in *gpyrpc.ExecProgram_Args) (out *gpyrpc.ExecProgram_Result, err error)
+	ParseFile(in *gpyrpc.ParseFile_Args) (out *gpyrpc.ParseFile_Result, err error)
+	ParseProgram(in *gpyrpc.ParseProgram_Args) (out *gpyrpc.ParseProgram_Result, err error)
 	FormatCode(in *gpyrpc.FormatCode_Args) (out *gpyrpc.FormatCode_Result, err error)
 	FormatPath(in *gpyrpc.FormatPath_Args) (out *gpyrpc.FormatPath_Result, err error)
 	LintPath(in *gpyrpc.LintPath_Args) (out *gpyrpc.LintPath_Result, err error)

diff --git a/pkg/service/rest_server.go b/pkg/service/rest_server.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package service
 
@@ -60,6 +60,8 @@ func (p *restServer) initHttpRrouter() {
 	p.router.GET("/api:protorpc/BuiltinService.ListMethod", p.handle_ListMethod)
 
 	p.router.GET("/api:protorpc/KclvmService.ExecProgram", p.handle_ExecProgram)
+	p.router.GET("/api:protorpc/KclvmService.ParseFile", p.handle_ParseFile)
+	p.router.GET("/api:protorpc/KclvmService.ParseProgram", p.handle_ParseProgram)
 	p.router.GET("/api:protorpc/KclvmService.FormatCode", p.handle_FormatCode)
 	p.router.GET("/api:protorpc/KclvmService.FormatPath", p.handle_FormatPath)
 	p.router.GET("/api:protorpc/KclvmService.LintPath", p.handle_LintPath)
@@ -71,6 +73,8 @@ func (p *restServer) initHttpRrouter() {
 	p.router.POST("/api:protorpc/BuiltinService.ListMethod", p.handle_ListMethod)
 
 	p.router.POST("/api:protorpc/KclvmService.ExecProgram", p.handle_ExecProgram)
+	p.router.POST("/api:protorpc/KclvmService.ParseFile", p.handle_ParseFile)
+	p.router.POST("/api:protorpc/KclvmService.ParseProgram", p.handle_ParseProgram)
 	p.router.POST("/api:protorpc/KclvmService.FormatCode", p.handle_FormatCode)
 	p.router.POST("/api:protorpc/KclvmService.FormatPath", p.handle_FormatPath)
 	p.router.POST("/api:protorpc/KclvmService.LintPath", p.handle_LintPath)
@@ -140,6 +144,20 @@ func (p *restServer) handle_ExecProgram(w http.ResponseWriter, r *http.Request,
 	})
 }
 
+func (p *restServer) handle_ParseFile(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
+	var args = new(gpyrpc.ParseFile_Args)
+	p.handle(w, r, args, func() (proto.Message, error) {
+		return p.c.ParseFile(args)
+	})
+}
+
+func (p *restServer) handle_ParseProgram(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
+	var args = new(gpyrpc.ParseProgram_Args)
+	p.handle(w, r, args, func() (proto.Message, error) {
+		return p.c.ParseProgram(args)
+	})
+}
+
 func (p *restServer) handle_FormatCode(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
 	var args = new(gpyrpc.FormatCode_Args)
 	p.handle(w, r, args, func() (proto.Message, error) {

diff --git a/pkg/service/rest_server_test.go b/pkg/service/rest_server_test.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package service
 

diff --git a/pkg/service/testmain_test.go b/pkg/service/testmain_test.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package service
 

diff --git a/pkg/settings/a_test.go b/pkg/settings/a_test.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package settings
 

diff --git a/pkg/settings/utils_settings_yaml.go b/pkg/settings/utils_settings_yaml.go
@@ -1,4 +1,4 @@
-// Copyright 2021 The KCL Authors. All rights reserved.
+// Copyright The KCL Authors. All rights reserved.
 
 package settings