add package gdebug; improve gconv/gfile/gset

debug/gdebug/gdebug.go

@@ -0,0 +1,170 @@
+// Copyright 2019 gf Author(https://github.com/gogf/gf). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+// Package gdebug contains facilities for programs to debug themselves while they are running.
+package gdebug
+
+import (
+	"bytes"
+	"fmt"
+	"runtime"
+	"strings"
+)
+
+const (
+	gMAX_DEPTH  = 1000
+	gFILTER_KEY = "/gf/debug/gdebug/gdebug.go"
+)
+
+var (
+	// goRootForFilter is used for stack filtering purpose.
+	goRootForFilter = runtime.GOROOT()
+)
+
+func init() {
+	if goRootForFilter != "" {
+		goRootForFilter = strings.Replace(goRootForFilter, "\\", "/", -1)
+	}
+}
+
+// PrintStack prints to standard error the stack trace returned by runtime.Stack.
+func PrintStack(skip ...int) {
+	fmt.Print(Stack(skip...))
+}
+
+// Stack returns a formatted stack trace of the goroutine that calls it.
+// It calls runtime.Stack with a large enough buffer to capture the entire trace.
+func Stack(skip ...int) string {
+	return StackWithFilter("", skip...)
+}
+
+// StackWithFilter returns a formatted stack trace of the goroutine that calls it.
+// It calls runtime.Stack with a large enough buffer to capture the entire trace.
+//
+// The parameter <filter> is used to filter the path of the caller.
+func StackWithFilter(filter string, skip ...int) string {
+	number := 0
+	if len(skip) > 0 {
+		number = skip[0]
+	}
+	name := ""
+	space := "  "
+	index := 1
+	buffer := bytes.NewBuffer(nil)
+	for i := callerFromIndex(filter) + number; i < gMAX_DEPTH; i++ {
+		if pc, file, line, ok := runtime.Caller(i); ok {
+			if goRootForFilter != "" && len(file) >= len(goRootForFilter) && file[0:len(goRootForFilter)] == goRootForFilter {
+				continue
+			}
+			if filter != "" && strings.Contains(file, filter) {
+				continue
+			}
+			if strings.Contains(file, gFILTER_KEY) {
+				continue
+			}
+			if fn := runtime.FuncForPC(pc); fn == nil {
+				name = "unknown"
+			} else {
+				name = fn.Name()
+			}
+			if index > 9 {
+				space = " "
+			}
+			buffer.WriteString(fmt.Sprintf("%d.%s%s\n    %s:%d\n", index, space, name, file, line))
+			index++
+		} else {
+			break
+		}
+	}
+	return buffer.String()
+}
+
+// CallerPath returns the function name and the absolute file path along with its line number of the caller.
+func Caller(skip ...int) (function string, path string, line int) {
+	return CallerWithFilter("", skip...)
+}
+
+// CallerPathWithFilter returns the function name and the absolute file path along with its line number of the caller.
+//
+// The parameter <filter> is used to filter the path of the caller.
+func CallerWithFilter(filter string, skip ...int) (function string, path string, line int) {
+	number := 0
+	if len(skip) > 0 {
+		number = skip[0]
+	}
+	for i := callerFromIndex(filter) + number; i < gMAX_DEPTH; i++ {
+		if pc, file, line, ok := runtime.Caller(i); ok {
+			if filter != "" && strings.Contains(file, filter) {
+				continue
+			}
+			if strings.Contains(file, gFILTER_KEY) {
+				continue
+			}
+			function := ""
+			if fn := runtime.FuncForPC(pc); fn == nil {
+				function = "unknown"
+			} else {
+				function = fn.Name()
+			}
+			return function, file, line
+		} else {
+			break
+		}
+	}
+	return "", "", -1
+}
+
+// callerFromIndex returns the caller position exclusive of the debug package.
+func callerFromIndex(filter string) int {
+	for i := 0; i < gMAX_DEPTH; i++ {
+		if _, file, _, ok := runtime.Caller(i); ok {
+			if filter != "" && strings.Contains(file, filter) {
+				continue
+			}
+			if strings.Contains(file, gFILTER_KEY) {
+				continue
+			}
+			// exclude the depth from the function of current package.
+			return i - 1
+		}
+	}
+	return 0
+}
+
+// CallerPackage returns the package name of the caller.
+func CallerPackage() string {
+	function, _, _ := Caller()
+	indexSplit := strings.LastIndexByte(function, '/')
+	if indexSplit == -1 {
+		return function[:strings.IndexByte(function, '.')]
+	} else {
+		leftPart := function[:indexSplit+1]
+		rightPart := function[indexSplit+1:]
+		indexDot := strings.IndexByte(function, '.')
+		rightPart = rightPart[:indexDot-1]
+		return leftPart + rightPart
+	}
+}
+
+// CallerFunction returns the function name of the caller.
+func CallerFunction() string {
+	function, _, _ := Caller()
+	function = function[strings.LastIndexByte(function, '/')+1:]
+	function = function[strings.IndexByte(function, '.')+1:]
+	return function
+}
+
+// CallerFilePath returns the file path of the caller.
+func CallerFilePath() string {
+	_, path, _ := Caller()
+	return path
+}
+
+// CallerFileLine returns the file path along with the line number of the caller.
+func CallerFileLine() string {
+	_, path, line := Caller()
+	return fmt.Sprintf(`%s:%d`, path, line)
+}