github.com/klaytn/klaytn@v1.12.1/common/debug.go (about)

     1  // Modifications Copyright 2018 The klaytn Authors
     2  // Copyright 2015 The go-ethereum Authors
     3  // This file is part of the go-ethereum library.
     4  //
     5  // The go-ethereum library is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Lesser General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // The go-ethereum library is distributed in the hope that it will be useful,
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    13  // GNU Lesser General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Lesser General Public License
    16  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    17  //
    18  // This file is derived from common/debug.go (2018/06/04).
    19  // Modified and improved for the klaytn development.
    20  
    21  package common
    22  
    23  import (
    24  	"fmt"
    25  	"os"
    26  	"runtime"
    27  	"runtime/debug"
    28  	"strings"
    29  )
    30  
    31  // Report gives off a warning requesting the user to submit an issue to the github tracker.
    32  func Report(extra ...interface{}) {
    33  	fmt.Fprintln(os.Stderr, "You've encountered a sought after, hard to reproduce bug. Please report this to the developers <3 https://github.com/klaytn/klaytn/issues")
    34  	fmt.Fprintln(os.Stderr, extra...)
    35  
    36  	_, file, line, _ := runtime.Caller(1)
    37  	fmt.Fprintf(os.Stderr, "%v:%v\n", file, line)
    38  
    39  	debug.PrintStack()
    40  
    41  	fmt.Fprintln(os.Stderr, "#### BUG! PLEASE REPORT ####")
    42  }
    43  
    44  // PrintDepricationWarning prinst the given string in a box using fmt.Println.
    45  func PrintDepricationWarning(str string) {
    46  	line := strings.Repeat("#", len(str)+4)
    47  	emptyLine := strings.Repeat(" ", len(str))
    48  	fmt.Printf(`
    49  %s
    50  # %s #
    51  # %s #
    52  # %s #
    53  %s
    54  
    55  `, line, emptyLine, str, emptyLine, line)
    56  }