-
Notifications
You must be signed in to change notification settings - Fork 275
/
BasicTypesHelpers.scala
403 lines (362 loc) · 11.7 KB
/
BasicTypesHelpers.scala
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
/*
* Copyright 2006-2011 WorldWide Conferencing, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.liftweb
package util
import java.io.{InputStream, ByteArrayOutputStream, ByteArrayInputStream, Reader, File, FileInputStream, BufferedReader}
import scala.xml._
import common._
/**
* Generics on the JVM have an issues with Type Erasure. Basically, Generic types (e.g.,
* Function1[String, Int] and Function1[Double, Bool]) look like the same type to the JVM
* so that methods cannot be overloaded with generic types. This "marker" trait is used as
* a work-around to the issue. The marker is implicitly passed as a parameter to some overloaded
* methods. If you see this as an implicit parameter to an overloaded method, just ignore it.
*/
trait AvoidTypeErasureIssues1
/**
* The companion object that does the implicit vending of AvoidTypeErasureIssues1
*/
object AvoidTypeErasureIssues1 {
/**
* Automagically vend a AvoidTypeErasureIssues1
*/
implicit val vendOne: AvoidTypeErasureIssues1 = new AvoidTypeErasureIssues1 {}
}
/**
* This object adds functionality to Scala standard types.
*/
object BasicTypesHelpers extends BasicTypesHelpers with StringHelpers with ControlHelpers
/**
* This trait adds functionality to Scala standard types
*/
trait BasicTypesHelpers { self: StringHelpers with ControlHelpers =>
/**
* Allows an implicit transform from a Boolean to a Boolean2, allowing expressions such as:
* <code>(1 == 2) ? "a" | "b"</code> (This expression will return "b")
* @param b the predicate to be tested by the ternary operator.
*/
implicit def boolean2(b: => Boolean) = new Boolean2(b)
/**
* This decorator class adds a ternary operator to a Boolean value
* @param b the predicate to be tested by the ternary operator.
*/
class Boolean2(b: => Boolean) {
/**
* Ternary operator.
* @returns a BooleanSome containing the specified value
* if the decorated boolean is true, or a BooleanNone otherwise.
*/
def ? [A](first: => A): BooleanOption[A] = {
if (b) BooleanSome(() => first)
else BooleanNone
}
/**
* Class for return values from the Boolean2 ternary operator.
* This class provides the "|" operator that can be used to
* specify a default value (i.e. the RHS of the "or")
*/
sealed abstract class BooleanOption[+A] {
def |[B >: A](default: => B): B
}
/**
* The value returned by the ternary operator if the predicate is true.
*/
case class BooleanSome[+A](x: () => A) extends BooleanOption[A] {
def |[B >: A](default: => B): B = x()
}
/**
* The value returned by the ternary operator if the predicate is false.
*/
case object BooleanNone extends BooleanOption[Nothing] {
def |[B](default: => B): B = default
}
}
/**
* Compare two NodeSeq and return true if they are equal, even if
* attribute order of Elems is different
*/
def compareXml(left: NodeSeq, right: NodeSeq): Boolean = {
val ls: Seq[Node] = left.toSeq
val rs: Seq[Node] = right.toSeq
if (ls.length == rs.length) {
ls.zip(rs).foldLeft(true){case (b, (l, r)) => b && compareNode(l, r)}
} else {
false
}
}
/**
* Compare two Elems
*/
def compareElem(left: Elem, right: Elem): Boolean =
compareXml(left.child, right.child) &&
left.label == right.label &&
(((null eq left.prefix) && (null eq right.prefix)) || left.prefix == right.prefix) &&
left.scope == right.scope &&
compareMetaData(left.attributes.toList, right.attributes.toList)
private def findFilter(m: MetaData, lst: List[MetaData]): Box[List[MetaData]] = {
var found = false
val ret = lst.filter {
case PrefixedAttribute(pre, label, value, _) if !found =>
m match {
case PrefixedAttribute(p2, l2, v2, _) if p2 == pre && l2 == label && v2.text == value.text =>
found = true
false
case _ => true
}
case UnprefixedAttribute(label, value, _) if !found =>
m match {
case UnprefixedAttribute(l2, v2, _) if l2 == label && v2.text == value.text =>
found = true
false
case _ => true
}
case _ => true
}
if (found) Full(ret) else Empty
}
/**
* Compare the metadata of two attributes
*/
def compareMetaData(left: List[MetaData], right: List[MetaData]): Boolean =
(left, right) match {
case (Nil, Nil) => true
case (_, Nil) => false
case (Nil, _) => false
case (attr :: rl, right) => findFilter(attr, right) match {
case Full(rr) => compareMetaData(rl, rr)
case _ => false
}
case _ => false
}
/**
* Comparse two XML nodes
*/
def compareNode(left: Node, right: Node): Boolean = {
(left, right) match {
case (Group(gl), Group(gr)) => compareXml(gl, gr)
case (el: Elem, er: Elem) => compareElem(el, er)
case (Unparsed(tl), Unparsed(tr)) => tl == tr
case (Text(tl), Text(tr)) => tl == tr
case (el: EntityRef, er: EntityRef) => el === er
case (Comment(cl), Comment(cr)) => cl == cr
case (PCData(dl), PCData(dr)) => dl == dr
case (pl: ProcInstr, pr: ProcInstr) => pl === pr
case (a, b) => a.toString == b.toString
}
}
/**
* Implicit transformation from a Boolean expression to an OptionalCons object so
* that an element can be added to a list if the expression is true
*/
implicit def toOptiCons(expr: => Boolean): OptionalCons = new OptionalCons(expr)
/**
* promote a partial function such that we can invoke the guard method
* to wrap the guarded partial function with a guard
*/
implicit def pfToGuardable[A](in: PartialFunction[A, _]):
PartialFunctionWrapper[A] =
new PartialFunctionWrapper[A](in)
/**
* Convert any object to an "equivalent" Boolean depending on its value
*/
def toBoolean(in: Any): Boolean = {
in match {
case null => false
case b : Boolean => b
case i: Int => i != 0
case lo: Long => lo != 0
case n : Number => n.intValue != 0
case s : String => {
val sl = s.toLowerCase
if (sl.length == 0) false
else {
if (sl.charAt(0) == 't') true
else if (sl == "yes") true
else toInt(s) != 0
}
}
case None => false
case Empty | Failure(_, _, _) => false
case Full(n) => toBoolean(n)
case Some(n) => toBoolean(n)
case x :: xs => toBoolean(x)
case o => toBoolean(o.toString)
}
}
/**
* A helper that will convert the String to a Boolean if it's
* t, true, yes, 1, f, false, no, or 0
*/
def asBoolean(in: String): Box[Boolean] = AsBoolean.unapply(in)
/**
* A helpful Boolean extractor
*/
object AsBoolean {
def unapply(in: String): Option[Boolean] =
if (null eq in) None else
in.toLowerCase match {
case "t" | "true" | "yes" | "1" => Full(true)
case "f" | "false" | "no" | "0" => Full(false)
case _ => None
}
}
/**
* Safely convert the specified String to an Int.
*/
def asInt(in: String): Box[Int] = tryo{in.trim.toInt}
/**
* A helpful Int extractor
*/
object AsInt {
def unapply(in: String): Option[Int] = asInt(in)
}
/**
* Safely convert the specified String to a Double.
*/
def asDouble(in: String): Box[Double] = tryo{in.trim.toDouble}
/**
* A helpful Double extractor
*/
object AsDouble {
def unapply(in: String): Option[Double] = asDouble(in)
}
/**
* Safely convert the specified String to a Long.
*/
def asLong(in: String): Box[Long] = tryo(in.toLong)
/**
* A helpful Long extractor
*/
object AsLong {
def unapply(in: String): Option[Long] = asLong(in)
}
/**
* Convert any object to an "equivalent" Long depending on its value
*/
def asLong(in: Any): Box[Long] = {
in match {
case null => Empty
case i: Int => Full(i.toLong)
case n: Long => Full(n)
case d: java.util.Date => Full(d.getTime)
case n : Number => Full(n.longValue)
case (n: Number) :: _ => Full(n.longValue)
case Some(n) => asLong(n)
case Full(n) => asLong(n)
case None | Empty | Failure(_, _, _) => Empty
case s: String => asLong(s)
case x :: xs => asLong(x)
case o => asLong(o.toString)
}
}
/**
* Convert any object to an "equivalent" Int depending on its value
*/
def toInt(in: Any): Int = {
in match {
case null => 0
case n: Int => n
case lo: Long => lo.toInt
case n : Number => n.intValue
case (n: Number) :: _ => n.intValue
case Some(n) => toInt(n)
case Full(n) => toInt(n)
case None | Empty | Failure(_, _, _) => 0
case s: String => parseNumber(s).toInt
case d: java.util.Date => (d.getTime / 1000L).toInt
case x :: xs => toInt(x)
case o => toInt(o.toString)
}
}
/**
* Convert any object to an "equivalent" Long depending on its value
*/
def toLong(in: Any): Long = {
in match {
case null => 0L
case i: Int => i
case n: Long => n
case d: java.util.Date => d.getTime
case n : Number => n.longValue
case (n: Number) :: _ => n.longValue
case Some(n) => toLong(n)
case Full(n) => toLong(n)
case None | Empty | Failure(_, _, _) => 0L
case s: String => parseNumber(s)
case x :: xs => toLong(x)
case o => toLong(o.toString)
}
}
/**
* Convert any InputStream to a ByteArrayInputStream
*/
def toByteArrayInputStream(in: InputStream) = {
val ba = new Array[Byte](4096)
val bos = new ByteArrayOutputStream
var len = 0
while (len >= 0) {
len = in.read(ba)
if (len > 0) {
bos.write(ba, 0, len)
}
}
new ByteArrayInputStream(bos.toByteArray)
}
/**
* Compare two arrays of Byte for byte equality.
* @return true if two Byte arrays don't contain the same bytes
*/
def notEq(a: Array[Byte], b: Array[Byte]) = !isEq(a,b)
/**
* Compare two arrays of Byte for byte equality.
* @return true if two Byte arrays contain the same bytes
*/
def isEq(a: Array[Byte], b: Array[Byte]) = {
def eq(a: Array[Byte], b: Array[Byte], pos: Int, len: Int): Boolean = {
if (pos == len) true
else if (a(pos) != b(pos)) false
else eq(a , b, pos + 1, len)
}
a.length == b.length && eq(a, b, 0, a.length)
}
}
/**
* Optional cons that implements the expression: <code>expr ?> value ::: List</code>
* @param expr the predicate to evaluate
*/
final class OptionalCons(expr: => Boolean) {
/**
* Return the specified value in a single-element list if the predicate
* evaluates to true.
*/
def ?>[T](f: => T): List[T] = if (expr) List(f) else Nil
}
/**
* The helper class that facilitates wrapping of one PartialFunction
* around another
*/
final class PartialFunctionWrapper[A](around: PartialFunction[A, _]) {
/**
* Allows you to put a guard around a partial function
* such that the around's isDefinedMethod must return true
* before the other's isDefinedAt method is tested
*/
def guard[B](other: PartialFunction[A, B]): PartialFunction[A,B] =
new PartialFunction[A, B] {
def isDefinedAt(a: A) = around.isDefinedAt(a) && other.isDefinedAt(a)
def apply(a: A): B = other.apply(a)
}
}