// +build debug package goparsify import ( "bytes" "flag" "fmt" "io" "os" "sort" "strconv" "strings" "time" "github.com/vektah/goparsify/debug" ) var log io.Writer = nil var parsers []*debugParser var pendingOpenLog = "" var activeParsers []*debugParser var longestLocation = 0 type debugParser struct { Match string Var string Location string Next Parser Time time.Duration Calls int } func (dp *debugParser) Name() string { if len(activeParsers) > 2 && activeParsers[len(activeParsers)-2].Var == dp.Var { return dp.Match } return dp.Var } func (dp *debugParser) logf(ps *State, result *Result, format string, args ...interface{}) string { buf := &bytes.Buffer{} buf.WriteString(fmt.Sprintf("%"+strconv.Itoa(longestLocation)+"s | ", dp.Location)) buf.WriteString(fmt.Sprintf("%-15s", ps.Preview(15))) buf.WriteString(" | ") output := "" if ps.Errored() { output = "fail" } else if result != nil { output = result.Token } buf.WriteString(fmt.Sprintf("%-10s | ", output)) buf.WriteString(strings.Repeat(" ", len(activeParsers)-1)) buf.WriteString(fmt.Sprintf(format, args...)) buf.WriteRune('\n') return buf.String() } func (dp *debugParser) logStart(ps *State) { if log != nil { if pendingOpenLog != "" { fmt.Fprint(log, pendingOpenLog) pendingOpenLog = "" } pendingOpenLog = dp.logf(ps, nil, dp.Name()) } } func (dp *debugParser) logEnd(ps *State, result *Result) { if log != nil { if pendingOpenLog != "" { fmt.Fprintf(log, dp.logf(ps, result, dp.Name())) pendingOpenLog = "" } } } func (dp *debugParser) Parse(ps *State) Result { activeParsers = append(activeParsers, dp) start := time.Now() dp.logStart(ps) ret := dp.Next(ps) dp.logEnd(ps, &ret) dp.Time = dp.Time + time.Since(start) dp.Calls++ activeParsers = activeParsers[0 : len(activeParsers)-1] return ret } func init() { logs := flag.Bool("parselogs", false, "print detailed parsing logs") flag.Parse() if *logs { EnableLogging(os.Stdout) } } // NewParser should be called around the creation of every Parser. // It does nothing normally and should incur no runtime overhead, but when building with -tags debug // it will instrument every parser to collect valuable timing and debug information. func NewParser(name string, p Parser) Parser { description, location := debug.GetDefinition() dp := &debugParser{ Match: name, Var: description, Location: location, Next: p, } if len(dp.Location) > longestLocation { longestLocation = len(dp.Location) } parsers = append(parsers, dp) return dp.Parse } // EnableLogging will write logs to the given writer as the next parse happens func EnableLogging(w io.Writer) { log = w } // DisableLogging will stop writing logs func DisableLogging() { log = nil } // DumpDebugStats will print out the curring timings for each parser if built with -tags debug func DumpDebugStats() { sort.Slice(parsers, func(i, j int) bool { return parsers[i].Time >= parsers[j].Time }) fmt.Println("Parser stats:") for _, parser := range parsers { fmt.Printf("%20s\t%10s\t%10d\tcalls\t%s\n", parser.Name(), parser.Time.String(), parser.Calls, parser.Location) } }