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
|
/*
* Copyright 2018 Allan Wang
*
* 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.
*/
@file:Suppress("NOTHING_TO_INLINE")
package ca.allanwang.kau.logging
import android.util.Log
import ca.allanwang.kau.utils.kauIsMainThread
/**
* Created by Allan Wang on 2017-05-28.
*
* Base logger class with a predefined tag
* This may be extended by an object to effectively replace [Log]
* Only direct lazy logging is supported, as for best results,
* applications should extend this and use const/final flags to decide whether logging occurs
* That way, it will be stripped away by proguard
*
* Generally speaking, verbose log may contain private information,
* as it should be stripped away from production build
*
* Debug and info logs may contain sensitive info, and may be differentiated by creating a method such as
* inline fun _d(message: () -> Any?) {
* if (BuildConfig.DEBUG) d(message)
* }
* This use case allows for a constant boolean check, which should be caught and removed by proguard
* for production builds
*/
open class KauLogger(
/**
* Tag to be used for each log
*/
val tag: String,
/**
* Toggle to dictate whether a message should be logged
*/
var shouldLog: (priority: Int) -> Boolean = { true }
) {
inline fun v(message: () -> Any?) = log(Log.VERBOSE, message)
inline fun i(message: () -> Any?) = log(Log.INFO, message)
inline fun d(message: () -> Any?) = log(Log.DEBUG, message)
inline fun e(t: Throwable? = null, message: () -> Any?) = log(Log.ERROR, message, t)
inline fun eThrow(message: Any?) {
val msg = message?.toString() ?: return
log(Log.ERROR, { msg }, Throwable(msg))
}
inline fun log(priority: Int, message: () -> Any?, t: Throwable? = null) {
if (shouldLog(priority))
logImpl(priority, message()?.toString(), t)
}
open fun logImpl(priority: Int, message: String?, t: Throwable?) {
val msg = message ?: "null"
if (t != null)
Log.e(tag, msg, t)
else
Log.println(priority, tag, msg)
}
/**
* Log the looper
*/
inline fun checkThread(id: Int) {
d {
val name = Thread.currentThread().name
val status = if (kauIsMainThread) "is" else "is not"
"$id $status in the main thread - thread name: $name"
}
}
fun extend(tag: String) = KauLoggerExtension(tag, this)
}
/**
* Tag extender for [KauLogger]
* Will prepend [tag] to any expected log output by [logger]
* Note that if the parent logger is disabled, the extension logger will not output anything either
*/
class KauLoggerExtension(val tag: String, val logger: KauLogger) {
inline fun v(message: () -> Any?) = log(Log.VERBOSE, message)
inline fun i(message: () -> Any?) = log(Log.INFO, message)
inline fun d(message: () -> Any?) = log(Log.DEBUG, message)
inline fun e(t: Throwable? = null, message: () -> Any?) = log(Log.ERROR, message, t)
inline fun eThrow(message: Any?) {
val msg = message?.toString() ?: return
log(Log.ERROR, { msg }, Throwable(msg))
}
inline fun log(priority: Int, message: () -> Any?, t: Throwable? = null) =
logger.log(priority, {
val msg = message()?.toString()
if (msg == null) null
else "$tag: $msg"
}, t)
inline fun checkThread(id: Int) {
d {
val name = Thread.currentThread().name
val status = if (kauIsMainThread) "is" else "is not"
"$id $status in the main thread - thread name: $name"
}
}
}
|
