Diagnosticism.Go/debug.go at master · synesissoftware/Diagnosticism.Go · GitHub

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
100
101
102
103
104
105
106
107
108
109
110
// Copyright 2019-2026 Matthew Wilson and Synesis Information Systems. All
// rights reserved. Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

/*
 * Created: 22nd February 2025
 * Updated: 1st March 2026
 */

package diagnosticism

import (
	"github.com/synesissoftware/Diagnosticism.Go/internal"

	"errors"
)

var (
	errDepthCannotBeNegative = errors.New("depth cannot be negative")
)

// Obtains the file information for the calling context.
func File() string {

	return internal.File(1)
}

// Obtains the file and line information for the calling context.
func FileLine() string {

	return internal.FileLine(1)
}

// Obtains the file, line, and function information for the calling
// context.
func FileLineFunction() string {

	return internal.FileLineFunction(1)
}

// Obtains the function information for the calling context.
func Function() string {

	return internal.Function(1)
}

// Obtains the line information for the calling context.
func Line() int {

	return internal.Line(1)
}

// Obtains the line and function information for the calling context.
func LineFunction() string {

	return internal.LineFunction(1)
}

// Obtains the file information for the calling context at the given depth.
func GetFileFor(depth int) (string, error) {

	if depth < 0 {
		return "", errDepthCannotBeNegative
	}

	return internal.File(1 + depth), nil
}

// Obtains the file and line information for the calling context at the
// given depth.
func GetFileLineFor(depth int) (string, error) {

	if depth < 0 {
		return "", errDepthCannotBeNegative
	}

	return internal.FileLine(1 + depth), nil
}

// Obtains the file, line, and function information for the calling
// context at the given depth.
func GetFileLineFunctionFor(depth int) (string, error) {

	if depth < 0 {
		return "", errDepthCannotBeNegative
	}

	return internal.FileLineFunction(1 + depth), nil
}

// Obtains the function information for the calling context at the given
// depth.
func GetFunctionFor(depth int) (string, error) {

	if depth < 0 {
		return "", errDepthCannotBeNegative
	}

	return internal.Function(1 + depth), nil
}

// Obtains the line information for the calling context at the given depth.
func GetLineFor(depth int) (int, error) {

	if depth < 0 {
		return 0, errDepthCannotBeNegative
	}

	return internal.Line(1 + depth), nil
}