forked from srinathh/gooxml
-
Notifications
You must be signed in to change notification settings - Fork 1
/
result.go
205 lines (185 loc) · 5.34 KB
/
result.go
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
// Copyright 2017 Baliance. All rights reserved.
//
// Use of this source code is governed by the terms of the Affero GNU General
// Public License version 3.0 as published by the Free Software Foundation and
// appearing in the file LICENSE included in the packaging of this file. A
// commercial license can be purchased by contacting sales@baliance.com.
package formula
import (
"math"
"strconv"
)
// ResultType is the type of the result
//go:generate stringer -type=ResultType
type ResultType byte
// ResultType constants.
const (
ResultTypeUnknown ResultType = iota
ResultTypeNumber
ResultTypeString
ResultTypeList
ResultTypeArray
ResultTypeError
ResultTypeEmpty
)
// Result is the result of a formula or cell evaluation .
type Result struct {
ValueNumber float64
ValueString string
ValueList []Result
ValueArray [][]Result
ErrorMessage string
Type ResultType
Ref Reference
}
func (r Result) String() string {
return r.Value()
}
// Value returns a string version of the result.
func (r Result) Value() string {
switch r.Type {
case ResultTypeNumber:
n := strconv.FormatFloat(r.ValueNumber, 'f', -1, 64)
// HACK: currently only used for testing, need to write a better general
// number format function
if len(n) > 12 {
end := 12
for i := end; i > 0 && n[i] == '0'; i-- {
end--
}
n = n[0 : end+1]
}
return n
case ResultTypeError:
return r.ValueString
case ResultTypeString:
return r.ValueString
case ResultTypeList:
if len(r.ValueList) == 0 {
return ""
}
return r.ValueList[0].Value()
case ResultTypeArray:
if len(r.ValueArray) == 0 || len(r.ValueArray[0]) == 0 {
return ""
}
return r.ValueArray[0][0].Value()
case ResultTypeEmpty:
return ""
default:
return "unhandled result value"
}
}
// AsNumber attempts to intepret a string cell value as a number. Upon success,
// it returns a new number result, upon failure it returns the original result.
// This is used as functions return strings that can then act like number (e.g.
// LEFT(1.2345,3) + LEFT(1.2345,3) = 2.4)
func (r Result) AsNumber() Result {
if r.Type == ResultTypeString {
f, err := strconv.ParseFloat(r.ValueString, 64)
if err == nil {
return MakeNumberResult(f)
}
}
if r.Type == ResultTypeEmpty {
return MakeNumberResult(0)
}
return r
}
// ListValues converts an array to a list or returns a lists values. This is used
// for functions that can accept an array, but don't care about ordering to
// reuse the list function logic.
func (r Result) ListValues() []Result {
if r.Type == ResultTypeArray {
res := []Result{}
for _, row := range r.ValueArray {
for _, col := range row {
res = append(res, col)
}
}
return res
}
if r.Type == ResultTypeList {
return r.ValueList
}
return nil
}
func (r Result) AsString() Result {
switch r.Type {
case ResultTypeNumber:
return MakeStringResult(r.Value())
default:
return r
}
}
// MakeNumberResult constructs a number result.
func MakeNumberResult(v float64) Result {
// Excel doesn't use negative zero
if v == math.Copysign(0, -1) {
v = 0
}
return Result{Type: ResultTypeNumber, ValueNumber: v}
}
// MakeBoolResult constructs a boolean result (internally a number).
func MakeBoolResult(b bool) Result {
if b {
return Result{Type: ResultTypeNumber, ValueNumber: 1}
}
return Result{Type: ResultTypeNumber, ValueNumber: 0}
}
// MakeErrorResult constructs a #VALUE! error with a given extra error message.
// The error message is for debugging formula evaluation only and is not stored
// in the sheet.
func MakeErrorResult(msg string) Result {
return MakeErrorResultType(ErrorTypeValue, msg)
}
// ErrorType is a formula evaluation error type.
type ErrorType byte
// ErrorType constants.
const (
ErrorTypeValue ErrorType = iota
ErrorTypeNull
ErrorTypeRef
ErrorTypeName
ErrorTypeNum
ErrorTypeNA
ErrorTypeDivideByZero
)
// MakeErrorResultType makes an error result of a given type with a specified
// debug message
func MakeErrorResultType(t ErrorType, msg string) Result {
switch t {
case ErrorTypeNull:
return Result{Type: ResultTypeError, ValueString: "#NULL!", ErrorMessage: msg}
case ErrorTypeValue:
return Result{Type: ResultTypeError, ValueString: "#VALUE!", ErrorMessage: msg}
case ErrorTypeRef:
return Result{Type: ResultTypeError, ValueString: "#REF!", ErrorMessage: msg}
case ErrorTypeName:
return Result{Type: ResultTypeError, ValueString: "#NAME?", ErrorMessage: msg}
case ErrorTypeNum:
return Result{Type: ResultTypeError, ValueString: "#NUM!", ErrorMessage: msg}
case ErrorTypeNA:
return Result{Type: ResultTypeError, ValueString: "#N/A", ErrorMessage: msg}
case ErrorTypeDivideByZero:
return Result{Type: ResultTypeError, ValueString: "#DIV/0!", ErrorMessage: msg}
default:
return Result{Type: ResultTypeError, ValueString: "#VALUE!", ErrorMessage: msg}
}
}
// MakeStringResult constructs a string result.
func MakeStringResult(s string) Result {
return Result{Type: ResultTypeString, ValueString: s}
}
// MakeEmptyResult is ued when parsing an empty argument.
func MakeEmptyResult() Result {
return Result{Type: ResultTypeEmpty}
}
// MakeArrayResult constructs an array result (matrix).
func MakeArrayResult(arr [][]Result) Result {
return Result{Type: ResultTypeArray, ValueArray: arr}
}
// MakeListResult constructs a list result.
func MakeListResult(list []Result) Result {
return Result{Type: ResultTypeList, ValueList: list}
}