github.com/aigarnetwork/aigar@v0.0.0-20191115204914-d59a6eb70f8e/common/debug.go (about)

     1  //  Copyright 2018 The go-ethereum Authors
     2  //  Copyright 2019 The go-aigar Authors
     3  //  This file is part of the go-aigar library.
     4  //
     5  //  The go-aigar 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-aigar 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-aigar library. If not, see <http://www.gnu.org/licenses/>.
    17  
    18  package common
    19  
    20  import (
    21  	"fmt"
    22  	"os"
    23  	"runtime"
    24  	"runtime/debug"
    25  	"strings"
    26  )
    27  
    28  // Report gives off a warning requesting the user to submit an issue to the github tracker.
    29  func Report(extra ...interface{}) {
    30  	fmt.Fprintln(os.Stderr, "You've encountered a sought after, hard to reproduce bug. Please report this to the developers <3 https://github.com/AigarNetwork/aigar/issues")
    31  	fmt.Fprintln(os.Stderr, extra...)
    32  
    33  	_, file, line, _ := runtime.Caller(1)
    34  	fmt.Fprintf(os.Stderr, "%v:%v\n", file, line)
    35  
    36  	debug.PrintStack()
    37  
    38  	fmt.Fprintln(os.Stderr, "#### BUG! PLEASE REPORT ####")
    39  }
    40  
    41  // PrintDepricationWarning prinst the given string in a box using fmt.Println.
    42  func PrintDepricationWarning(str string) {
    43  	line := strings.Repeat("#", len(str)+4)
    44  	emptyLine := strings.Repeat(" ", len(str))
    45  	fmt.Printf(`
    46  %s
    47  # %s #
    48  # %s #
    49  # %s #
    50  %s
    51  
    52  `, line, emptyLine, str, emptyLine, line)
    53  }