refactoring bar options
Vladimir Bauer
6 years ago
| 3 | 3 | "bytes" |
| 4 | 4 | "io" |
| 5 | 5 | |
| 6 | "github.com/vbauerster/mpb/v4/decor" | |
| 6 | "github.com/vbauerster/mpb/v5/decor" | |
| 7 | 7 | ) |
| 8 | 8 | |
| 9 | 9 | // BarOption is a function option which changes the default behavior of a bar. |
| 49 | 49 | } |
| 50 | 50 | } |
| 51 | 51 | |
| 52 | // BarReplaceOnComplete is deprecated. Use BarParkTo instead. | |
| 53 | func BarReplaceOnComplete(runningBar *Bar) BarOption { | |
| 54 | return BarParkTo(runningBar) | |
| 55 | } | |
| 56 | ||
| 57 | // BarParkTo parks constructed bar into the runningBar. In other words, | |
| 58 | // constructed bar will replace runningBar after it has been completed. | |
| 59 | func BarParkTo(runningBar *Bar) BarOption { | |
| 52 | // BarQueueAfter queues this (being constructed) bar to relplace | |
| 53 | // runningBar after it has been completed. | |
| 54 | func BarQueueAfter(runningBar *Bar) BarOption { | |
| 60 | 55 | if runningBar == nil { |
| 61 | 56 | return nil |
| 62 | 57 | } |
| 65 | 60 | } |
| 66 | 61 | } |
| 67 | 62 | |
| 68 | // BarRemoveOnComplete removes bar filler and decorators if any, on | |
| 69 | // complete event. | |
| 63 | // BarRemoveOnComplete removes both bar's filler and its decorators | |
| 64 | // on complete event. | |
| 70 | 65 | func BarRemoveOnComplete() BarOption { |
| 71 | 66 | return func(s *bState) { |
| 72 | 67 | s.dropOnComplete = true |
| 73 | 68 | } |
| 74 | 69 | } |
| 75 | 70 | |
| 76 | // BarClearOnComplete clears bar filler only, on complete event. | |
| 77 | func BarClearOnComplete() BarOption { | |
| 78 | return BarOnComplete("") | |
| 79 | } | |
| 80 | ||
| 81 | // BarOnComplete replaces bar filler with message, on complete event. | |
| 82 | func BarOnComplete(message string) BarOption { | |
| 83 | return func(s *bState) { | |
| 84 | s.filler = makeBarOnCompleteFiller(s.baseF, message) | |
| 85 | } | |
| 86 | } | |
| 87 | ||
| 88 | func makeBarOnCompleteFiller(filler Filler, message string) Filler { | |
| 89 | return FillerFunc(func(w io.Writer, width int, st *decor.Statistics) { | |
| 71 | // BarFillerClearOnComplete clears bar's filler on complete event. | |
| 72 | // It's shortcut for BarFillerOnComplete(""). | |
| 73 | func BarFillerClearOnComplete() BarOption { | |
| 74 | return BarFillerOnComplete("") | |
| 75 | } | |
| 76 | ||
| 77 | // BarFillerOnComplete replaces bar's filler with message, on complete event. | |
| 78 | func BarFillerOnComplete(message string) BarOption { | |
| 79 | return func(s *bState) { | |
| 80 | s.filler = makeBarFillerOnComplete(s.baseF, message) | |
| 81 | } | |
| 82 | } | |
| 83 | ||
| 84 | func makeBarFillerOnComplete(filler BarFiller, message string) BarFiller { | |
| 85 | return BarFillerFunc(func(w io.Writer, width int, st *decor.Statistics) { | |
| 90 | 86 | if st.Completed { |
| 91 | 87 | io.WriteString(w, message) |
| 92 | 88 | } else { |
| 106 | 102 | |
| 107 | 103 | // BarExtender is an option to extend bar to the next new line, with |
| 108 | 104 | // arbitrary output. |
| 109 | func BarExtender(extender Filler) BarOption { | |
| 105 | func BarExtender(extender BarFiller) BarOption { | |
| 110 | 106 | if extender == nil { |
| 111 | 107 | return nil |
| 112 | 108 | } |
| 115 | 111 | } |
| 116 | 112 | } |
| 117 | 113 | |
| 118 | func makeExtFunc(extender Filler) extFunc { | |
| 114 | func makeExtFunc(extender BarFiller) extFunc { | |
| 119 | 115 | buf := new(bytes.Buffer) |
| 120 | 116 | nl := []byte("\n") |
| 121 | 117 | return func(r io.Reader, tw int, st *decor.Statistics) (io.Reader, int) { |
| 174 | 170 | if len(frames) == 0 { |
| 175 | 171 | return nil |
| 176 | 172 | } |
| 177 | chk := func(filler Filler) (interface{}, bool) { | |
| 173 | chk := func(filler BarFiller) (interface{}, bool) { | |
| 178 | 174 | t, ok := filler.(*spinnerFiller) |
| 179 | 175 | return t, ok |
| 180 | 176 | } |
| 188 | 184 | // actual type. If you implement your own Filler, so most probably |
| 189 | 185 | // you'll need this. See BarStyle or SpinnerStyle for example. |
| 190 | 186 | func MakeFillerTypeSpecificBarOption( |
| 191 | typeChecker func(Filler) (interface{}, bool), | |
| 187 | typeChecker func(BarFiller) (interface{}, bool), | |
| 192 | 188 | cb func(interface{}), |
| 193 | 189 | ) BarOption { |
| 194 | 190 | return func(s *bState) { |