117683Spst##===-- sourcewin.py -----------------------------------------*- Python -*-===## 217683Spst## 339294Sfenner# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 417683Spst# See https://llvm.org/LICENSE.txt for license information. 517683Spst# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 617683Spst## 717683Spst##===----------------------------------------------------------------------===## 817683Spst 917683Spstimport cui 1017683Spstimport curses 1117683Spstimport lldb 1217683Spstimport lldbutil 1317683Spstimport re 1417683Spstimport os 1517683Spst 1617683Spst 1717683Spstclass SourceWin(cui.TitledWin): 1817683Spst 1917683Spst def __init__(self, driver, x, y, w, h): 2017683Spst super(SourceWin, self).__init__(x, y, w, h, "Source") 2156891Sfenner self.sourceman = driver.getSourceManager() 2256891Sfenner self.sources = {} 2317683Spst 2417683Spst self.filename = None 2517683Spst self.pc_line = None 26127667Sbms self.viewline = 0 27214518Srpaulo 2817683Spst self.breakpoints = {} 2917683Spst 3075110Sfenner self.win.scrollok(1) 3175110Sfenner 3275110Sfenner self.markerPC = ":) " 3375110Sfenner self.markerBP = "B> " 34214518Srpaulo self.markerNone = " " 35214518Srpaulo 36214518Srpaulo try: 37214518Srpaulo from pygments.formatters import TerminalFormatter 38214518Srpaulo self.formatter = TerminalFormatter() 39214518Srpaulo except ImportError: 40214518Srpaulo #self.win.addstr("\nWarning: no 'pygments' library found. Syntax highlighting is disabled.") 41214518Srpaulo self.lexer = None 42214518Srpaulo self.formatter = None 43214518Srpaulo pass 44214518Srpaulo 45214518Srpaulo # FIXME: syntax highlight broken 46214518Srpaulo self.formatter = None 47214518Srpaulo self.lexer = None 4817683Spst 4956891Sfenner def handleEvent(self, event): 5017683Spst if isinstance(event, int): 5117683Spst self.handleKey(event) 5217683Spst return 5317683Spst 5456891Sfenner if isinstance(event, lldb.SBEvent): 55127667Sbms if lldb.SBBreakpoint.EventIsBreakpointEvent(event): 56127667Sbms self.handleBPEvent(event) 57127667Sbms 58127667Sbms if lldb.SBProcess.EventIsProcessEvent(event) and \ 59235426Sdelphij not lldb.SBProcess.GetRestartedFromEvent(event): 60127667Sbms process = lldb.SBProcess.GetProcessFromEvent(event) 61127667Sbms if not process.IsValid(): 62127667Sbms return 63127667Sbms if process.GetState() == lldb.eStateStopped: 64127667Sbms self.refreshSource(process) 65127667Sbms elif process.GetState() == lldb.eStateExited: 6675110Sfenner self.notifyExited(process) 6775110Sfenner 6875110Sfenner def notifyExited(self, process): 6975110Sfenner self.win.erase() 7056891Sfenner target = lldbutil.get_description(process.GetTarget()) 71190225Srpaulo pid = process.GetProcessID() 7217683Spst ec = process.GetExitStatus() 7317683Spst self.win.addstr( 7417683Spst "\nProcess %s [%d] has exited with exit-code %d" % 7517683Spst (target, pid, ec)) 7617683Spst 7717683Spst def pageUp(self): 7817683Spst if self.viewline > 0: 7917683Spst self.viewline = self.viewline - 1 8017683Spst self.refreshSource() 8117683Spst 82235426Sdelphij def pageDown(self): 8326178Sfenner if self.viewline < len(self.content) - self.height + 1: 8475110Sfenner self.viewline = self.viewline + 1 8517683Spst self.refreshSource() 86214518Srpaulo pass 8775110Sfenner 8817683Spst def handleKey(self, key): 8917683Spst if key == curses.KEY_DOWN: 9017683Spst self.pageDown() 9117683Spst elif key == curses.KEY_UP: 9217683Spst self.pageUp() 9317683Spst 9417683Spst def updateViewline(self): 9517683Spst half = self.height / 2 9617683Spst if self.pc_line < half: 9717683Spst self.viewline = 0 98190225Srpaulo else: 9956891Sfenner self.viewline = self.pc_line - half + 1 10017683Spst 101172680Smlaier if self.viewline < 0: 102172680Smlaier raise Exception( 103172680Smlaier "negative viewline: pc=%d viewline=%d" % 104172680Smlaier (self.pc_line, self.viewline)) 105172680Smlaier 10675110Sfenner def refreshSource(self, process=None): 10717683Spst (self.height, self.width) = self.win.getmaxyx() 10856891Sfenner 10956891Sfenner if process is not None: 11056891Sfenner loc = process.GetSelectedThread().GetSelectedFrame().GetLineEntry() 11156891Sfenner f = loc.GetFileSpec() 11256891Sfenner self.pc_line = loc.GetLine() 11356891Sfenner 11456891Sfenner if not f.IsValid(): 11556891Sfenner self.win.addstr(0, 0, "Invalid source file") 11656891Sfenner return 11756891Sfenner 11856891Sfenner self.filename = f.GetFilename() 11956891Sfenner path = os.path.join(f.GetDirectory(), self.filename) 12056891Sfenner self.setTitle(path) 12156891Sfenner self.content = self.getContent(path) 12256891Sfenner self.updateViewline() 12356891Sfenner 12456891Sfenner if self.filename is None: 12556891Sfenner return 12656891Sfenner 12756891Sfenner if self.formatter is not None: 12856891Sfenner from pygments.lexers import get_lexer_for_filename 12956891Sfenner self.lexer = get_lexer_for_filename(self.filename) 13056891Sfenner 13156891Sfenner bps = [] if not self.filename in self.breakpoints else self.breakpoints[self.filename] 13256891Sfenner self.win.erase() 13356891Sfenner if self.content: 13456891Sfenner self.formatContent(self.content, self.pc_line, bps) 13556891Sfenner 13656891Sfenner def getContent(self, path): 13756891Sfenner content = [] 13856891Sfenner if path in self.sources: 13956891Sfenner content = self.sources[path] 14056891Sfenner else: 14156891Sfenner if os.path.exists(path): 14256891Sfenner with open(path) as x: 14356891Sfenner content = x.readlines() 14456891Sfenner self.sources[path] = content 14556891Sfenner return content 14656891Sfenner 14756891Sfenner def formatContent(self, content, pc_line, breakpoints): 14856891Sfenner source = "" 14956891Sfenner count = 1 15056891Sfenner self.win.erase() 15156891Sfenner end = min(len(content), self.viewline + self.height) 15256891Sfenner for i in range(self.viewline, end): 15356891Sfenner line_num = i + 1 15456891Sfenner marker = self.markerNone 15556891Sfenner attr = curses.A_NORMAL 15656891Sfenner if line_num == pc_line: 15756891Sfenner attr = curses.A_REVERSE 15856891Sfenner if line_num in breakpoints: 15956891Sfenner marker = self.markerBP 16056891Sfenner line = "%s%3d %s" % (marker, line_num, self.highlight(content[i])) 16156891Sfenner if len(line) >= self.width: 16256891Sfenner line = line[0:self.width - 1] + "\n" 16356891Sfenner self.win.addstr(line, attr) 16456891Sfenner source += line 16556891Sfenner count = count + 1 16656891Sfenner return source 16756891Sfenner 16856891Sfenner def highlight(self, source): 16956891Sfenner if self.lexer and self.formatter: 17056891Sfenner from pygments import highlight 17156891Sfenner return highlight(source, self.lexer, self.formatter) 17256891Sfenner else: 17356891Sfenner return source 17456891Sfenner 17556891Sfenner def addBPLocations(self, locations): 17656891Sfenner for path in locations: 17756891Sfenner lines = locations[path] 17856891Sfenner if path in self.breakpoints: 17956891Sfenner self.breakpoints[path].update(lines) 18056891Sfenner else: 18156891Sfenner self.breakpoints[path] = lines 18256891Sfenner 18356891Sfenner def removeBPLocations(self, locations): 18456891Sfenner for path in locations: 18556891Sfenner lines = locations[path] 186190225Srpaulo if path in self.breakpoints: 187190225Srpaulo self.breakpoints[path].difference_update(lines) 188190225Srpaulo else: 189190225Srpaulo raise "Removing locations that were never added...no good" 19017683Spst 19117683Spst def handleBPEvent(self, event): 19217683Spst def getLocations(event): 19317683Spst locs = {} 19417683Spst 195127667Sbms bp = lldb.SBBreakpoint.GetBreakpointFromEvent(event) 19617683Spst 19717683Spst if bp.IsInternal(): 19817683Spst # don't show anything for internal breakpoints 19998533Sfenner return 20017683Spst 20117683Spst for location in bp: 20217683Spst # hack! getting the LineEntry via SBBreakpointLocation.GetAddress.GetLineEntry does not work good for 20317683Spst # inlined frames, so we get the description (which does take 20417683Spst # into account inlined functions) and parse it. 20556891Sfenner desc = lldbutil.get_description( 20698533Sfenner location, lldb.eDescriptionLevelFull) 207235426Sdelphij match = re.search('at\ ([^:]+):([\d]+)', desc) 208147897Ssam try: 20917683Spst path = match.group(1) 21098533Sfenner line = int(match.group(2).strip()) 21198533Sfenner except ValueError as e: 21298533Sfenner # bp loc unparsable 21398533Sfenner continue 21498533Sfenner 21598533Sfenner if path in locs: 21698533Sfenner locs[path].add(line) 21798533Sfenner else: 21898533Sfenner locs[path] = set([line]) 21998533Sfenner return locs 22098533Sfenner 22198533Sfenner event_type = lldb.SBBreakpoint.GetBreakpointEventTypeFromEvent(event) 22298533Sfenner if event_type == lldb.eBreakpointEventTypeEnabled \ 22398533Sfenner or event_type == lldb.eBreakpointEventTypeAdded \ 22456891Sfenner or event_type == lldb.eBreakpointEventTypeLocationsResolved \ 22556891Sfenner or event_type == lldb.eBreakpointEventTypeLocationsAdded: 22656891Sfenner self.addBPLocations(getLocations(event)) 22717683Spst elif event_type == lldb.eBreakpointEventTypeRemoved \ 22875110Sfenner or event_type == lldb.eBreakpointEventTypeLocationsRemoved \ 22917683Spst or event_type == lldb.eBreakpointEventTypeDisabled: 23017683Spst self.removeBPLocations(getLocations(event)) 23117683Spst elif event_type == lldb.eBreakpointEventTypeCommandChanged \ 23217683Spst or event_type == lldb.eBreakpointEventTypeConditionChanged \ 23317683Spst or event_type == lldb.eBreakpointEventTypeIgnoreChanged \ 23417683Spst or event_type == lldb.eBreakpointEventTypeThreadChanged \ 23517749Spst or event_type == lldb.eBreakpointEventTypeInvalidType: 23617749Spst # no-op 23717749Spst pass 23817749Spst self.refreshSource() 23917749Spst