-
Notifications
You must be signed in to change notification settings - Fork 1
/
dsvparser-ahk2.ahk
247 lines (212 loc) · 7.4 KB
/
dsvparser-ahk2.ahk
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
; Simple DSV (e.g., CSV, TSV) parsing utilities.
; - https://github.com/jasonsparc/dsvparser-ahk2
;
; See also,
; - https://www.autohotkey.com/boards/viewtopic.php?t=70425
; - https://github.com/jasonsparc/DSVParser-AHK
; - `Loop parse _, "CSV"` from AutoHotkey v2.0 -- https://www.autohotkey.com/docs/v2/lib/LoopParse.htm
; - https://github.com/hi5/CSV
; - https://github.com/JnLlnd/ObjCSV
;
#Requires AutoHotkey v2.0
global CSVParser := DSVParser(",")
global TSVParser := DSVParser("`t")
class DSVParser {
; Creates a new DSVParser with the specified settings.
__New(Delimiters, Qualifiers:="`"") {
if (StrLen(Delimiters) <= 0)
throw Error("No delimiter specified.", -1)
this.___Delimiters := Delimiters
this.___Qualifiers := Qualifiers
this.___DefaultDelimiter := SubStr(this.___Delimiters, 1, 1)
this.___DefaultQualifier := SubStr(this.___Qualifiers, 1, 1)
}
; -------------------------------------------------------------------------
; Properties
Delimiters => this.___Delimiters
Ds => this.___Delimiters
Qualifiers => this.___Qualifiers
Qs => this.___Qualifiers
DefaultDelimiter => this.___DefaultDelimiter
D => this.___DefaultDelimiter
DefaultQualifier => this.___DefaultQualifier
Q => this.___DefaultQualifier
; -------------------------------------------------------------------------
; Methods
ToArray(InString, InitCapacity:=0) {
local dsvArr := []
if (InitCapacity)
dsvArr.Capacity := InitCapacity
local nextPos := 1
local maxCols := 0
local row
loop {
nextPos := this.NextRow(InString, &row, nextPos, maxCols)
local cols := row.Length
if (cols > maxCols)
maxCols := cols
dsvArr.Push(row)
} until !nextPos
local _ ; Needed to avoid warnings when `#Warn` enabled
for _, row in dsvArr {
local extraCols := maxCols - row.Length
if (extraCols) {
row.Capacity := maxCols
loop extraCols
row.Push("") ; Append an empty cell
}
}
return dsvArr
}
FromArray(DSVArray, LineSeparator:="`r`n", BlankLastLine:=true) {
; Supported line separators. See:
; - https://en.wikipedia.org/wiki/Newline#Representation
; - https://docs.python.org/3/library/stdtypes.html#str.splitlines
static ls := "S)`r`n|`n`r|[`r`n`v`f" chr(0x85) chr(0x1E) chr(0x1D) chr(0x1C) chr(0x2028) chr(0x2029) "]"
if not LineSeparator ~= ls
throw Error("Unsupported newline sequence.", -1)
local ret := ""
local rows := DSVArray.Length
loop rows - 1 {
ret .= this.FormatRow(DSVArray[A_Index])
ret .= LineSeparator
}
ret .= this.FormatRow(DSVArray[rows])
if (BlankLastLine)
ret .= LineSeparator
return ret
}
; Given a DSV string, parses a single DSV row from it, spits out to the
; specified "OutRow" output variable an array of DSV cell values, and then
; returns the next position in the input string where parsing may continue.
;
; The return value can be 0 to signal that the string was fully consumed and
; that there is nothing left to parse.
;
NextRow(InString, &OutRow:="", StartingPos:=1, InitCapacity:=0) {
OutRow := []
if (InitCapacity) {
OutRow.Capacity := InitCapacity
}
local cell, done
loop {
StartingPos := this.NextCell(InString, &cell, &done, StartingPos)
OutRow.Push(cell)
} until done
return StartingPos
}
FetchRow(InString, InOutPos:=1, InitCapacity:=0) {
if (not InOutPos is VarRef) {
local _InOutPos := InOutPos
InOutPos := &_InOutPos
}
local row
%InOutPos% := this.NextRow(InString, &row, %InOutPos%, InitCapacity)
return row
}
FormatRow(RowArray) {
local ret := ""
local d := this.___DefaultDelimiter
local cols := RowArray.Length
loop cols - 1
ret .= this.FormatCell(RowArray[A_Index]) . d
ret .= this.FormatCell(RowArray[cols])
return ret
}
; Given a DSV string, parses a single DSV cell from it, spits it out to the
; specified "OutCell" output variable, and then returns the next position in
; the input string where parsing may continue.
;
; The return value can be 0 to signal that the string was fully consumed and
; that there is nothing left to parse.
;
; The output variable "OutIsLastInRow" will be set to true if the current
; cell being parsed was detected to be the last cell of the current row.
;
NextCell(InString, &OutCell:="", &OutIsLastInRow:=false, StartingPos:=1) {
local regexNeedle
if (ObjHasOwnProp(this, "NextCell__regex")) {
regexNeedle := this.NextCell__regex
} else {
; Line break characters. See:
; - https://en.wikipedia.org/wiki/Newline#Unicode
; - https://docs.python.org/3/library/stdtypes.html#str.splitlines
static nl := "`r`n`v`f" chr(0x85) chr(0x1E) chr(0x1D) chr(0x1C) chr(0x2028) chr(0x2029)
local ds := RegExReplace(this.___Delimiters, "[\Q\.*?+[{|()^$}]\E]", "\$0")
local qs := RegExReplace(this.___Qualifiers, "[\Q\.*?+[{|()^$}]\E]", "\$0")
this.NextCell__regex := regexNeedle := "SsD)"
. (StrLen(this.___Qualifiers) > 1 ? "(?:"
. "(?P<Qualifier>[" qs "])"
. "(?P<Qualified>(?:(?!\1).|\1\1)*)"
. "\1"
. ")?" : (StrLen(qs) ? "(?:"
. "(?P<Qualifier>" qs ")"
. "(?P<Qualified>(?:[^" qs "]|" qs qs ")*)"
. qs
. ")?" : ""
. "(?P<Qualifier>)"
. "(?P<Qualified>)"
. ""))
. "(?P<Delimited>[^" ds nl "]*)"
. "(?:"
. "(?P<Delimiter>[" ds "])"
. "|`r`n?|`n`r?" ; -- https://en.wikipedia.org/wiki/Newline#Representation
. "|.|$"
. ")"
}
local match
local found := RegExMatch(InString, regexNeedle, &match, Max(StartingPos, 1))
local q := match.Qualifier
; According to the RFC, Implementors should:
; "be conservative in what you do, be liberal in what you accept from
; others" (RFC 793, Section 2.10) (RFC 4180, Page 4)
OutCell := StrReplace(match.Qualified, q q, q) . match.Delimited
; The above treatment is also the same as that of Microsoft Excel.
local nextPos := found + match.Len
if (StrLen(match.Delimiter)) {
; Found a delimiter. Therefore, there should be a next cell, even if
; it's an empty one.
OutIsLastInRow := false
return nextPos
}
OutIsLastInRow := true
; The last record in the file may or may not have an ending line break.
; (RFC 4180, Section 2.2)
return nextPos > StrLen(InString) ? 0 : nextPos
}
FetchCell(InString, &OutIsLastInRow:=false, InOutPos:=1) {
if (not InOutPos is VarRef) {
local _InOutPos := InOutPos
InOutPos := &_InOutPos
}
local cell
%InOutPos% := this.NextCell(InString, &cell, &OutIsLastInRow, %InOutPos%)
return cell
}
; Formats a string to be used as a single DSV cell.
FormatCell(InputString) {
local regexNeedle
if (ObjHasOwnProp(this, "FormatCell__regex")) {
regexNeedle := this.FormatCell__regex
} else {
static FormatCell__regex_presets := ",`"`t"
; Line break characters. See:
; - https://en.wikipedia.org/wiki/Newline#Unicode
; - https://docs.python.org/3/library/stdtypes.html#str.splitlines
. "`r`n`v`f" chr(0x85) chr(0x1E) chr(0x1D) chr(0x1C) chr(0x2028) chr(0x2029)
local qds := RegExReplace(this.___Qualifiers this.___Delimiters, "[\Q\.*?+[{|()^$}]\E]", "\$0")
this.FormatCell__regex := regexNeedle := "S)[" FormatCell__regex_presets qds "]"
}
if (InputString ~= regexNeedle) {
local q := this.___DefaultQualifier
return q . StrReplace(InputString, q, q q) . q
}
return InputString
}
; --
ToString() => ObjHasOwnProp(this, "___ToString")
? this.___ToString
: this.___ToString := Type(this) " { "
. "Ds '" RegExReplace(this.Delimiters, "['``]", "``$0") "' "
. "Qs '" RegExReplace(this.Qualifiers, "['``]", "``$0") "' }"
}