├── .gitignore ├── LICENSE ├── README.md ├── buffered_disabled.go ├── buffered_enabled.go ├── buffered_uni.go ├── caller.go ├── consts.go ├── dlog_disabled.go ├── dlog_enabled.go ├── doc.go ├── state_disabled.go ├── state_enabled.go ├── withCaller_disabled.go ├── withCaller_enabled.go └── withCaller_uni.go /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files, Static and Dynamic libs (Shared Objects) 2 | *.o 3 | *.a 4 | *.so 5 | 6 | # Folders 7 | _obj 8 | _test 9 | 10 | # Architecture specific extensions/prefixes 11 | *.[568vq] 12 | [568vq].out 13 | 14 | *.cgo1.go 15 | *.cgo2.c 16 | _cgo_defun.c 17 | _cgo_gotypes.go 18 | _cgo_export.* 19 | 20 | _testmain.go 21 | 22 | *.exe 23 | *.test 24 | *.prof 25 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # dlog [![GoDoc](https://godoc.org/github.com/kirillDanshin/dlog?status.svg)](https://godoc.org/github.com/kirillDanshin/dlog) [![Go Report Card](https://goreportcard.com/badge/github.com/kirillDanshin/dlog)](https://goreportcard.com/report/github.com/kirillDanshin/dlog) 2 | Simple build-time controlled debug log 3 | 4 | # How to use 5 | ### Unbuffered 6 | ```go 7 | package main 8 | 9 | import "github.com/kirillDanshin/dlog" 10 | 11 | func main() { 12 | a := []int{2, 4, 8, 16, 32, 64, 128, 256, 512} 13 | b := "some string" 14 | 15 | dlog.D(a) // D'ump `a` 16 | dlog.P(b) // P'rint `b` 17 | dlog.F("%s format", b) // F'ormatted print 18 | dlog.Ln(b) // print'Ln `b` 19 | } 20 | ``` 21 | 22 | ### Buffered 23 | ```go 24 | package main 25 | 26 | import "github.com/kirillDanshin/dlog" 27 | 28 | func main() { 29 | log := dlog.NewBuffered() 30 | defer log.Release() 31 | 32 | log.D(a) // D'ump `a` 33 | log.P(b) // P'rint `b` 34 | log.F("%s format", b) // F'ormatted print 35 | log.Ln(b) // print'Ln `b` 36 | 37 | dlog.Ln(log) // or fmt.Println("log") etc. 38 | } 39 | ``` 40 | 41 | # Release 42 | To disable logging in release build just run 43 | ```bash 44 | go build 45 | ``` 46 | 47 | # Debug 48 | To enable logging in debug build run 49 | ```bash 50 | go build -tags "debug" 51 | ``` 52 | -------------------------------------------------------------------------------- /buffered_disabled.go: -------------------------------------------------------------------------------- 1 | // +build !debug 2 | 3 | package dlog 4 | 5 | // Ln is a build-time enabled println 6 | func (b *Buffered) Ln(v ...interface{}) {} 7 | 8 | // P is a build-time enabled print 9 | func (b *Buffered) P(v ...interface{}) {} 10 | 11 | // F is a build-time enabled printf 12 | func (b *Buffered) F(f string, v ...interface{}) {} 13 | 14 | // D dumps a value 15 | func (b *Buffered) D(v ...interface{}) {} 16 | 17 | func (b *Buffered) prepare() {} 18 | 19 | func (b *Buffered) String() string { 20 | return "" 21 | } 22 | -------------------------------------------------------------------------------- /buffered_enabled.go: -------------------------------------------------------------------------------- 1 | // +build debug 2 | 3 | package dlog 4 | 5 | import "fmt" 6 | 7 | // Ln is a build-time enabled println 8 | func (b *Buffered) Ln(v ...interface{}) { 9 | b.prepare() 10 | b.Lock() 11 | fmt.Fprintln(b.bb, v...) 12 | b.Unlock() 13 | } 14 | 15 | // P is a build-time enabled print 16 | func (b *Buffered) P(v ...interface{}) { 17 | b.prepare() 18 | b.Lock() 19 | fmt.Fprint(b.bb, v...) 20 | b.Unlock() 21 | } 22 | 23 | // F is a build-time enabled printf 24 | func (b *Buffered) F(f string, v ...interface{}) { 25 | b.prepare() 26 | b.Lock() 27 | fmt.Fprintf(b.bb, f+"\n", v...) 28 | b.Unlock() 29 | } 30 | 31 | // D dumps a value 32 | func (b *Buffered) D(v ...interface{}) { 33 | b.prepare() 34 | b.Lock() 35 | for _, v := range v { 36 | fmt.Fprintf(b.bb, "%+#v\n", v) 37 | } 38 | b.Unlock() 39 | } 40 | 41 | func (b *Buffered) prepare() { 42 | if b.bb == nil { 43 | b = NewBuffered() 44 | } 45 | } 46 | 47 | func (b *Buffered) String() string { 48 | return string(b.bb.Bytes()) 49 | } 50 | -------------------------------------------------------------------------------- /buffered_uni.go: -------------------------------------------------------------------------------- 1 | package dlog 2 | 3 | import ( 4 | "sync" 5 | 6 | "github.com/valyala/bytebufferpool" 7 | ) 8 | 9 | // Buffered thread-safe dlog 10 | type Buffered struct { 11 | bb *bytebufferpool.ByteBuffer 12 | sync.RWMutex 13 | } 14 | 15 | // NewBuffered dlog 16 | func NewBuffered() *Buffered { 17 | return &Buffered{ 18 | bb: bytebufferpool.Get(), 19 | } 20 | } 21 | 22 | // Release the buffer for dlog 23 | func (b *Buffered) Release() { 24 | if b.bb == nil { 25 | return 26 | } 27 | b.Lock() 28 | bytebufferpool.Put(b.bb) 29 | b.Unlock() 30 | } 31 | -------------------------------------------------------------------------------- /caller.go: -------------------------------------------------------------------------------- 1 | package dlog 2 | 3 | import "fmt" 4 | 5 | // Caller info 6 | type Caller struct { 7 | File string 8 | Line int 9 | FuncName string 10 | } 11 | 12 | func (c *Caller) String() string { 13 | return fmt.Sprintf("Called from %s:%d (%s)", c.File, c.Line, c.FuncName) 14 | } 15 | -------------------------------------------------------------------------------- /consts.go: -------------------------------------------------------------------------------- 1 | package dlog 2 | 3 | const ( 4 | // CallerUnknown returned when caller isn't determined 5 | CallerUnknown = "UNKNOWN" 6 | 7 | // StateEnabled is to check if dlog.State enabled 8 | StateEnabled = "enabled" 9 | // StateDisabled is to check if dlog.State disabled 10 | StateDisabled = "disabled" 11 | ) 12 | -------------------------------------------------------------------------------- /dlog_disabled.go: -------------------------------------------------------------------------------- 1 | // +build !debug 2 | 3 | package dlog 4 | 5 | // D dumps a value 6 | func D(v ...interface{}) {} 7 | 8 | // F is a build-time disabled printf 9 | func F(f string, v ...interface{}) {} 10 | 11 | // P is a build-time disabled print 12 | func P(v ...interface{}) {} 13 | 14 | // Ln is a build-time disabled println 15 | func Ln(v ...interface{}) {} 16 | -------------------------------------------------------------------------------- /dlog_enabled.go: -------------------------------------------------------------------------------- 1 | // +build debug 2 | 3 | package dlog 4 | 5 | import ( 6 | "fmt" 7 | "log" 8 | 9 | "github.com/davecgh/go-spew/spew" 10 | ) 11 | 12 | var spewInstance = spew.ConfigState{ 13 | Indent: "\t", 14 | } 15 | 16 | // D dumps a value 17 | func D(v ...interface{}) { 18 | for _, v := range v { 19 | spewInstance.Dump(v) 20 | } 21 | } 22 | 23 | // F is a build-time enabled printf 24 | func F(f string, v ...interface{}) { 25 | // log.Printf(f, v...) 26 | spewInstance.Printf(f+"\n", v...) 27 | } 28 | 29 | // P is a build-time enabled print 30 | func P(v ...interface{}) { 31 | log.Print(v...) 32 | fmt.Println() 33 | } 34 | 35 | // Ln is a build-time enabled println 36 | func Ln(v ...interface{}) { 37 | log.Println(v...) 38 | } 39 | -------------------------------------------------------------------------------- /doc.go: -------------------------------------------------------------------------------- 1 | // Package dlog is a build-time 2 | // enabled or disabled logger. 3 | // Godoc shows disabled state 4 | // because it built in by default. 5 | package dlog 6 | -------------------------------------------------------------------------------- /state_disabled.go: -------------------------------------------------------------------------------- 1 | // +build !debug 2 | 3 | package dlog 4 | 5 | // State handles dlog state. Can be "disabled" or "enabled". 6 | const State = "disabled" 7 | -------------------------------------------------------------------------------- /state_enabled.go: -------------------------------------------------------------------------------- 1 | // +build debug 2 | 3 | package dlog 4 | 5 | // State handles dlog state. Can be "disabled" or "enabled". 6 | const State = "enabled" 7 | -------------------------------------------------------------------------------- /withCaller_disabled.go: -------------------------------------------------------------------------------- 1 | // +build !debug 2 | 3 | package dlog 4 | 5 | // D dumps a value 6 | func (*WithCaller) D(v ...interface{}) {} 7 | 8 | // F is a build-time enabled printf 9 | func (*WithCaller) F(f string, v ...interface{}) {} 10 | 11 | // P is a build-time enabled print 12 | func (*WithCaller) P(v ...interface{}) {} 13 | 14 | // Ln is a build-time enabled println 15 | func (*WithCaller) Ln(v ...interface{}) {} 16 | 17 | // GetCaller is a build-time disabled caller determining. 18 | // Returns caller's file, line and func name 19 | func GetCaller(_ ...int) (*Caller, bool) { 20 | return &Caller{ 21 | File: CallerUnknown, 22 | Line: 0, 23 | FuncName: CallerUnknown, 24 | }, false 25 | } 26 | -------------------------------------------------------------------------------- /withCaller_enabled.go: -------------------------------------------------------------------------------- 1 | // +build debug 2 | 3 | package dlog 4 | 5 | import ( 6 | "log" 7 | "runtime" 8 | "strings" 9 | 10 | "github.com/kirillDanshin/myutils" 11 | ) 12 | 13 | // D dumps a value 14 | func (*WithCaller) D(v ...interface{}) { 15 | c, _ := GetCaller() 16 | log.Print(c, ": [") 17 | for _, v := range v { 18 | spewInstance.Dump(v) 19 | } 20 | log.Println("]") 21 | } 22 | 23 | // F is a build-time enabled printf 24 | func (*WithCaller) F(f string, v ...interface{}) { 25 | c, _ := GetCaller() 26 | // log.Printf(myutils.Concat(c.String(), "[\n\t", f, "\n]"), v...) 27 | spewInstance.Printf(myutils.Concat(c.String(), "[\n\t", f, "\n]"), v...) 28 | } 29 | 30 | // P is a build-time enabled print 31 | func (*WithCaller) P(v ...interface{}) { 32 | c, _ := GetCaller() 33 | log.Print(c, ": [\t") 34 | log.Print(v...) 35 | log.Println("]") 36 | } 37 | 38 | // Ln is a build-time enabled println 39 | func (*WithCaller) Ln(v ...interface{}) { 40 | c, _ := GetCaller() 41 | log.Print(c, ": [\t") 42 | log.Println(v...) 43 | log.Println("]") 44 | } 45 | 46 | // GetCaller returns caller's file, line and func name 47 | func GetCaller(stackBack ...int) (*Caller, bool) { 48 | sb := 2 49 | if len(stackBack) > 0 { 50 | sb = stackBack[0] + 1 51 | } 52 | pc, file, line, ok := runtime.Caller(sb) 53 | if !ok { 54 | return &Caller{ 55 | File: CallerUnknown, 56 | Line: 0, 57 | FuncName: CallerUnknown, 58 | }, false 59 | } 60 | 61 | if li := strings.LastIndex(file, "/"); li > 0 { 62 | file = file[li+1:] 63 | } 64 | 65 | return &Caller{ 66 | File: file, 67 | Line: line, 68 | FuncName: runtime.FuncForPC(pc).Name(), 69 | }, true 70 | } 71 | -------------------------------------------------------------------------------- /withCaller_uni.go: -------------------------------------------------------------------------------- 1 | package dlog 2 | 3 | // WithCaller is a dlog with caller info prefix 4 | type WithCaller struct{} 5 | --------------------------------------------------------------------------------