def __init__(self, name="Demo", icon="cwicon"):
super(MainChip, self).__init__()
self.manageTraces = TraceManagerDialog(self)
# self.manageTraces.tracesChanged.
self.name = name
self.filename = None
self.dirty = True
self.projEditWidget = ProjectTextEditor(self)
self.projectChanged.connect(self.projEditWidget.setProject)
pg.setConfigOption('background', 'w')
pg.setConfigOption('foreground', 'k')
self.lastMenuActionSection = None
self.initUI(icon)
self.paramTrees = []
self.originalStdout = None
self.helpbrowser = HelpBrowser()
#Fake widget for dock
#TODO: Would be nice if this auto-resized to keep small, but not amount of playing
#with size policy or min/max sizes has worked.
fake = QWidget()
self.setCentralWidget(fake)
self.paramScripting = self.addConsole("Script Commands", visible=False)
self.addPythonConsole()
def __init__(self, name="Demo", icon="cwicon"):
super(MainChip, self).__init__()
self.manageTraces = TraceManagerDialog(self)
# self.manageTraces.tracesChanged.
self.name = name
self.filename = None
self.dirty = True
self.projEditWidget = ProjectTextEditor(self)
self.projectChanged.connect(self.projEditWidget.setProject)
pg.setConfigOption('background', 'w')
pg.setConfigOption('foreground', 'k')
self.lastMenuActionSection = None
self.initUI(icon)
self.paramTrees = []
self.originalStdout = None
#Fake widget for dock
#TODO: Would be nice if this auto-resized to keep small, but not amount of playing
#with size policy or min/max sizes has worked.
fake = QWidget()
self.setCentralWidget(fake)
self.paramScripting = self.addConsole("Script Commands", visible=False)
self.addPythonConsole()
class MainChip(QMainWindow):
"""
This is the base GUI class, used for both the Analyzer and Capture software. It defines a number of
useful features such as the ability to add docks, setting windows, consoles for logging errors, etc.
You can run a demo which shows the basic features, which would look like this:
.. image:: /images/mainchip-demo.png
"""
settings_docks = []
MaxRecentFiles = 4
#Be sure to set things with:
#QApplication()
#app.setOrganizationName()
#app.setApplicationName()
#app.setWindowIcon()
openFile = Signal(str)
saveFile = Signal()
newFile = Signal()
projectChanged = Signal(object)
def __init__(self, name="Demo", icon="cwicon"):
super(MainChip, self).__init__()
self.manageTraces = TraceManagerDialog(self)
# self.manageTraces.tracesChanged.
self.name = name
self.filename = None
self.dirty = True
self.projEditWidget = ProjectTextEditor(self)
self.projectChanged.connect(self.projEditWidget.setProject)
pg.setConfigOption('background', 'w')
pg.setConfigOption('foreground', 'k')
self.lastMenuActionSection = None
self.initUI(icon)
self.paramTrees = []
self.originalStdout = None
#Fake widget for dock
#TODO: Would be nice if this auto-resized to keep small, but not amount of playing
#with size policy or min/max sizes has worked.
fake = QWidget()
self.setCentralWidget(fake)
self.paramScripting = self.addConsole("Script Commands", visible=False)
self.addPythonConsole()
def restoreDockGeometry(self):
"""
Call after any class-specific setup (e.g. making docks), as this will then
restore everything using saved QSettings()
"""
#Settings
settings = QSettings()
self.restoreGeometry(settings.value("geometry"))
self.restoreState(settings.value("state"))
def addWindowMenuAction(self, action, section):
"""
When you add a dock, this function also adds
an option to show/hide it form the 'Window' menu
:param action: Action to take when clicking item form 'Window' menu
:type action: QAction
:param section: Name of section used to group together
:type section: str
"""
#TODO: Should this be done with submenus?
if section != self.lastMenuActionSection:
self.windowMenu.addSeparator()
self.lastMenuActionSection = section
self.windowMenu.addAction(action)
def addDock(self, dockWidget, name="Settings", area=Qt.LeftDockWidgetArea,
allowedAreas=Qt.TopDockWidgetArea | Qt.BottomDockWidgetArea | Qt.RightDockWidgetArea | Qt.LeftDockWidgetArea,
visible=True, addToWindows=True):
"""Add a dockwidget to the main window, which also adds it to the 'Windows' menu"""
#Configure dock
dock = QDockWidget(name)
dock.setAllowedAreas(allowedAreas)
dock.setWidget(dockWidget)
dock.setObjectName(name)
self.addDockWidget(area, dock)
if visible == False:
dock.toggleViewAction()
#Add to "Windows" menu
if addToWindows:
self.addWindowMenuAction(dock.toggleViewAction(), None)
self.enforceMenuOrder()
return dock
def addSettings(self, tree, name):
"""Adds a dockwidget designed to store a ParameterTree, also adds to 'Windows' menu"""
self.paramTrees.append(tree)
dock = self.addDock(tree, name=name, area=Qt.LeftDockWidgetArea)
self.settings_docks.append(dock)
return dock
def dockifySettings(self):
if len(self.settings_docks) > 1:
for index in range(0, len(self.settings_docks) - 1):
self.tabifyDockWidget(self.settings_docks[index], self.settings_docks[index + 1])
self.settings_docks[0].raise_()
def addTraceDock(self, name):
"""Add a new GraphWidget in a dock, you can get the GW with .widget() property of returned QDockWidget"""
gw = GraphWidget()
return self.addDock(gw, name=name, area=Qt.RightDockWidgetArea)
def addConsole(self, name="Debug Logging", visible=True, redirectStdOut=True):
"""Add a QTextBrowser, used as a console/debug window"""
console = QTextBrowser()
self.addDock(console, name, area=Qt.BottomDockWidgetArea, visible=visible)
if redirectStdOut:
if self.originalStdout is None:
self.originalStdout = sys.stdout
sys.stdout = OutLog(console, sys.stdout, origStdout=self.originalStdout)
sys.stderr = OutLog(console, sys.stderr, QColor(255, 0, 0), origStdout=self.originalStdout)
return console
def addPythonConsole(self, name="Python Console", visible=False):
"""Add a python console, inside which you can access the Python interpreter"""
wid = PythonConsole.QPythonConsole(self, locals())
self.addDock(wid, name, area=Qt.BottomDockWidgetArea, visible=visible)
return wid
def clearAllSettings(self):
"""Clear all saved QSettings(), such as window location etc"""
QSettings().remove("")
def closeEvent(self, event):
"""Called when window is closed, attempts to save state/geometry"""
settings = QSettings()
settings.setValue("geometry", self.saveGeometry())
settings.setValue("state", self.saveState())
if self.okToContinue():
QMainWindow.closeEvent(self, event)
else:
event.ignore()
def createFileActions(self):
"""Add the file actions (open/save/new)"""
self.openAct = QAction(QIcon('open.png'), '&Open Project', self,
shortcut=QKeySequence.Open,
statusTip='Open Project File',
triggered=self._openProject)
self.saveAct = QAction(QIcon('save.png'), '&Save Project', self,
shortcut=QKeySequence.Save,
statusTip='Save current project to Disk',
triggered=self._saveProject)
self.newAct = QAction(QIcon('new.png'), '&New Project', self,
shortcut=QKeySequence.New,
statusTip='Create new Project',
triggered=self._newProject)
for i in range(MainChip.MaxRecentFiles):
self.recentFileActs.append(QAction(self, visible=False, triggered=self.openRecentFile))
def helpdialog(self):
"""Helps the User"""
QMessageBox.about(self, 'Link to Documentation', 'See <a href="http://www.newae.com/sidechannel/cwdocs">newae.com/sidechannel/cwdocs</a> for Tutorials and '
'Documentation. If you are using an official release, this documentation should have also been present with '
'your release.<br><br>'
'See <a href="http://www.chipwhisperer.com">chipwhisperer.com</a> for Wiki, GIT Code, community information.'
'<br><br>See the About dialog for Copyright, Trademark, and Authorship information'
)
def aboutdialog(self):
"""Tells the User"""
QMessageBox.about(self, 'About', '<h3>ChipWhisperer' + u'\u2122' + '</h3>'
'<h4>Copyright Information</h4>'
'Copyright ' + u'\u00A9' + ' NewAE Technology Inc., 2013-2014. <br>'
'Copyright ' + u'\u00A9' + ' Colin O\'Flynn, 2012-2014.'
'<h4>License Information</h4>'
'Released under the GPLv3 License, see <a href="http://www.gnu.org/copyleft/gpl.html">License Details</a>.<br>'
'Various parts of this project may be released under additional open-source licenses such as the BSD License '
'or LGPL license. See source code for details of specific licenses.'
'<h4>Projects used in ChipWhisperer</h4>'
'ChipWhisperer is built on or otherwise uses a number of open-source projects. Many thanks are given to the following '
'projects, which may also have additional license restrictions or information: '
'<ul>'
'<li><a href="https://www.python.org/">Python</a></li>'
'<li><a href="http://qt-project.org/">Qt</a></li>'
'<li><a href="http://qt-project.org/wiki/pyside">PySide</a></li>'
'<li><a href="http://www.pyqtgraph.org/">PyQtGraph</a></li>'
'<li><a href="http://www.numpy.org/">NumPy</a></li>'
'<li><a href="http://www.scipy.org/">SciPy</a></li>'
'<li><a href="http://sourceforge.net/apps/trac/pyusb/">PyUSB</a></li>'
'<li><a href="http://www.fourwalledcubicle.com/LUFA.php">LUFA USB Library</a></li>'
'<li><a href="http://www.ztex.de/downloads/#firmware_kit">ZTEX EZ-USB SDK</a></li>'
'<li><a href="http://www.libusb.org/wiki/libusb-1.0">libusb-1.0</a></li>'
'<li><a href="http://winavr.sourceforge.net/">WinAVR</a></li>'
'</ul>'
'Some projects may be missing from the above list - please let us know, any omission is a mistake!'
'<h4>Trademark Information</h4>'
'ChipWhisperer is a Trademark of NewAE Technology Inc.'
''
)
def createMenus(self):
"""Create all menus (File, Window, etc)"""
self.fileMenu= self.menuBar().addMenu("&File")
self.fileMenu.addAction(self.newAct)
self.fileMenu.addAction(self.openAct)
self.fileMenu.addAction(self.saveAct)
# self.fileMenu.addAction(self.importAct)
self.separatorAct = self.fileMenu.addSeparator()
for i in range(MainChip.MaxRecentFiles):
self.fileMenu.addAction(self.recentFileActs[i])
self.projectMenu = self.menuBar().addMenu("&Project")
self.traceManageAct = QAction('&Manage Traces', self, statusTip='Add/Remove Traces from Project', triggered=self.manageTraces.show)
self.projectMenu.addAction(self.traceManageAct)
self.showProjFileAct = QAction('&Project File Editor (Text)', self, statusTip='Edit Project File', triggered=self.projEditDock.show)
self.projectMenu.addAction(self.showProjFileAct)
self.toolMenu= self.menuBar().addMenu("&Tools")
self.windowMenu = self.menuBar().addMenu("&Windows")
self.helpMenu = self.menuBar().addMenu("&Help")
self.helpManualAct = QAction('&Tutorial/User Manual', self, statusTip='Everything you need to know', triggered=self.helpdialog)
self.helpListAct = QAction('&List Enabled/Disable Modules', self, statusTip="Check if you're missing modules", triggered=self.listModulesShow)
self.helpAboutAct = QAction('&About', self, statusTip='About Dialog', triggered=self.aboutdialog)
self.helpMenu.addAction(self.helpManualAct)
self.helpMenu.addAction(self.helpListAct)
self.helpMenu.addAction(self.helpAboutAct)
def enforceMenuOrder(self):
"""Makes sure menus appear in correct order, required as they get reordered when we add a new item to one"""
fakeAction = QAction('Does Nothing', self, visible=False)
self.projectMenu.addAction(fakeAction)
fakeAction = QAction('Does Nothing', self, visible=False)
self.toolMenu.addAction(fakeAction)
fakeAction = QAction('Does Nothing', self, visible=False)
self.windowMenu.addAction(fakeAction)
fakeAction = QAction('Does Nothing', self, visible=False)
self.helpMenu.addAction(fakeAction)
def initUI(self, icon="cwicon"):
"""Setup the UI, creating statusbar, setting title, menus, etc"""
self.statusBar()
self.setWindowTitle(self.name)
self.setWindowIcon(QIcon(":/images/%s.png" % icon))
#Project editor dock
self.projEditDock = self.addDock(self.projEditWidget, name="Project Text Editor", area=Qt.RightDockWidgetArea, visible=False, addToWindows=False)
self.recentFileActs = []
self.createFileActions()
self.createMenus()
self.updateRecentFileActions()
self.show()
def updateTitleBar(self):
"""Update filename shown in title bar"""
if self.filename is not None:
fname = os.path.basename(self.filename)
else:
fname = "Untitled"
self.setWindowTitle("%s - %s[*]" %(self.name, fname))
self.setWindowModified(self.dirty)
def listModulesShow(self):
"""Opens the Dialog which shows loaded/unloaded modules"""
ml = ModuleListDialog(self.listModules)
ml.exec_()
def listModules(self):
"""Should return a list of all possible imports, used to test which modules are missing"""
return [["MainChip", True, ""]]
def setCurrentFile(self, fname):
"""Set current project filename, adds it to recent file list"""
self.filename = fname
self.updateTitleBar()
if fname is None:
return
settings = QSettings()
files = settings.value('recentFileList', [" ", " ", " ", " "])
try:
files.remove(fname)
except ValueError:
pass
except AttributeError:
pass
files.insert(0, fname)
del files[MainChip.MaxRecentFiles:]
settings = QSettings()
settings.setValue('recentFileList', files)
for widget in QApplication.topLevelWidgets():
if isinstance(widget, MainChip):
widget.updateRecentFileActions()
def updateRecentFileActions(self):
"""Update & Load the list of recent files"""
settings = QSettings()
files = settings.value('recentFileList')
files_no = 0
if files:
files_no = len(files)
numRecentFiles = min(files_no, MainChip.MaxRecentFiles)
for i in range(numRecentFiles):
text = "&%d %s" % (i + 1, self.strippedName(files[i]))
self.recentFileActs[i].setText(text)
self.recentFileActs[i].setData(files[i])
self.recentFileActs[i].setVisible(True)
for j in range(numRecentFiles, MainChip.MaxRecentFiles):
self.recentFileActs[j].setVisible(False)
self.separatorAct.setVisible((numRecentFiles > 0))
def strippedName(self, fullFileName):
(filepath, filename) = os.path.split(fullFileName)
(base, toplevel) = os.path.split(filepath)
return toplevel + "/" + filename
#return QFileInfo(fullFileName).fileName()
def _openProject(self, fname=None):
#TODO: close etc
if fname is None:
fname, _ = QFileDialog.getOpenFileName(self, 'Open file','.','*.cwp')
if fname is not None:
self.openFile.emit(fname)
self.setCurrentFile(fname)
def _newProject(self):
self.newFile.emit()
def _saveProject(self):
self.saveFile.emit()
def project(self):
return self._project
def setProject(self, proj):
self._project = proj
self.projEditWidget.setFilename(self._project.filename)
self._project.valueChanged.connect(self.projEditWidget.projectChangedGUI)
self.projectChanged.emit(self._project)
self._project.filenameChanged.connect(self.projEditWidget.setFilename)
def openRecentFile(self):
action = self.sender()
if action:
self.openFile.emit(action.data())
def okToContinue(self):
# reply = QMessageBox.question(self, "%s - Unsaved Changes"%self.name, "Save unsaved changes?",QMessageBox.Yes|QMessageBox.No|QMessageBox.Cancel)
savedialog = saveProjectDialog(self)
savedialog.exec_()
reply = savedialog.value()
if reply == QDialogButtonBox.RejectRole:
return False
elif reply == QDialogButtonBox.AcceptRole:
self.saveProject()
return True
def _setParameter_children(self, top, path, value, echo):
"""Descends down a given path, looking for value to set"""
#print top.name()
if top.name() == path[0]:
if len(path) > 1:
for c in top.children():
self._setParameter_children(c, path[1:], value, echo)
else:
#Check if this is a dictionary/list
if "values" in top.opts:
try:
if isinstance(top.opts["values"], dict):
value = top.opts["values"][value]
except TypeError:
pass
if echo == False:
top.opts["echooff"] = True
if top.opts["type"] == "action":
top.activate()
else:
top.setValue(value)
raise ValueError()
def setParameter(self, parameter, echo=False):
"""Sets a parameter based on a list, used for scripting in combination with showScriptParameter"""
path = parameter[:-1]
value = parameter[-1]
try:
for t in self.paramTrees:
for i in range(0, t.invisibleRootItem().childCount()):
self._setParameter_children(t.invisibleRootItem().child(i).param, path, value, echo)
print "Parameter not found: %s"%str(parameter)
except ValueError:
#A little klunky: we use exceptions to tell us the system DID work as intended
pass
except IndexError:
raise IndexError("IndexError Setting Parameter %s\n%s"%(str(parameter), traceback.format_exc()))
#User might be calling these in a row, need to process all events
QCoreApplication.processEvents()
def showScriptParameter(self, param, changes, topParam):
"""
This function is used to tell the user what they should pass to setParameter
in order to recreate a system. This will automatically be called if the module
has done the following:
When calling ExtendedParameter.setupParameter(), have passed a reference to 'self' like this::
ExtendedParameter.setupExtended(self.params, self)
Have a function called paramTreeChanged in the class which calls showScriptParameter (this function).
Typically done like the following, where self.showScriptParameter is setup in the setupExtended() call. You
might need to pass the reference to this instance down to lower modules.::
def paramTreeChanged(self, param, changes):
if self.showScriptParameter is not None:
self.showScriptParameter(param, changes, self.params)
"""
for param, change, data in changes:
ppath = topParam.childPath(param)
if ppath is None:
name = [param.name()]
else:
ppath.insert(0, topParam.name())
name = ppath
#Don't pollute script output with readonly things
if param.opts["readonly"] == True:
continue
if "echooff" in param.opts:
if param.opts["echooff"] == True:
param.opts["echooff"] = False
continue
if "values" in param.opts:
if not hasattr(param.opts["values"], 'iteritems'):
name.append(data)
else:
for k, v in param.opts["values"].iteritems():
if v == data:
name.append(k)
else:
name.append(data)
self.paramScripting.append(str(name))
def macWorkArounds(self):
# There is some odd error on Mac OS X where you get little rectangles near close buttons
# Calling this gets rid of them - reference to errors with modal system on QT Mac build have been found
# but haven't chased down actual cause yet
test = saveProjectDialog(self)
class MainChip(QMainWindow):
"""
This is the base GUI class, used for both the Analyzer and Capture software. It defines a number of
useful features such as the ability to add docks, setting windows, consoles for logging errors, etc.
You can run a demo which shows the basic features, which would look like this:
.. image:: /images/mainchip-demo.png
"""
settings_docks = []
MaxRecentFiles = 4
#Be sure to set things with:
#QApplication()
#app.setOrganizationName()
#app.setApplicationName()
#app.setWindowIcon()
openFile = Signal(str)
saveFile = Signal()
newFile = Signal()
projectChanged = Signal(object)
def __init__(self, name="Demo", icon="cwicon"):
super(MainChip, self).__init__()
self.manageTraces = TraceManagerDialog(self)
# self.manageTraces.tracesChanged.
self.name = name
self.filename = None
self.dirty = True
self.projEditWidget = ProjectTextEditor(self)
self.projectChanged.connect(self.projEditWidget.setProject)
pg.setConfigOption('background', 'w')
pg.setConfigOption('foreground', 'k')
self.lastMenuActionSection = None
self.initUI(icon)
self.paramTrees = []
self.originalStdout = None
self.helpbrowser = HelpBrowser()
#Fake widget for dock
#TODO: Would be nice if this auto-resized to keep small, but not amount of playing
#with size policy or min/max sizes has worked.
fake = QWidget()
self.setCentralWidget(fake)
self.paramScripting = self.addConsole("Script Commands", visible=False)
self.addPythonConsole()
def restoreDockGeometry(self):
"""
Call after any class-specific setup (e.g. making docks), as this will then
restore everything using saved QSettings()
"""
#Settings
settings = QSettings()
self.restoreGeometry(settings.value("geometry"))
self.restoreState(settings.value("state"))
def addWindowMenuAction(self, action, section):
"""
When you add a dock, this function also adds
an option to show/hide it form the 'Window' menu
:param action: Action to take when clicking item form 'Window' menu
:type action: QAction
:param section: Name of section used to group together
:type section: str
"""
#TODO: Should this be done with submenus?
if section != self.lastMenuActionSection:
self.windowMenu.addSeparator()
self.lastMenuActionSection = section
self.windowMenu.addAction(action)
def addDock(self,
dockWidget,
name="Settings",
area=Qt.LeftDockWidgetArea,
allowedAreas=Qt.TopDockWidgetArea | Qt.BottomDockWidgetArea
| Qt.RightDockWidgetArea | Qt.LeftDockWidgetArea,
visible=True,
addToWindows=True):
"""Add a dockwidget to the main window, which also adds it to the 'Windows' menu"""
#Configure dock
dock = QDockWidget(name)
dock.setAllowedAreas(allowedAreas)
dock.setWidget(dockWidget)
dock.setObjectName(name)
self.addDockWidget(area, dock)
if visible == False:
dock.toggleViewAction()
#Add to "Windows" menu
if addToWindows:
self.addWindowMenuAction(dock.toggleViewAction(), None)
self.enforceMenuOrder()
return dock
def addSettings(self, tree, name):
"""Adds a dockwidget designed to store a ParameterTree, also adds to 'Windows' menu"""
self.paramTrees.append(tree)
dock = self.addDock(tree, name=name, area=Qt.LeftDockWidgetArea)
self.settings_docks.append(dock)
return dock
def dockifySettings(self):
if len(self.settings_docks) > 1:
for index in range(0, len(self.settings_docks) - 1):
self.tabifyDockWidget(self.settings_docks[index],
self.settings_docks[index + 1])
self.settings_docks[0].raise_()
def addTraceDock(self, name):
"""Add a new GraphWidget in a dock, you can get the GW with .widget() property of returned QDockWidget"""
gw = GraphWidget()
return self.addDock(gw, name=name, area=Qt.RightDockWidgetArea)
def addConsole(self,
name="Debug Logging",
visible=True,
redirectStdOut=True):
"""Add a QTextBrowser, used as a console/debug window"""
console = QTextBrowser()
self.addDock(console,
name,
area=Qt.BottomDockWidgetArea,
visible=visible)
if redirectStdOut:
if self.originalStdout is None:
self.originalStdout = sys.stdout
sys.stdout = OutLog(console,
sys.stdout,
origStdout=self.originalStdout)
sys.stderr = OutLog(console,
sys.stderr,
QColor(255, 0, 0),
origStdout=self.originalStdout)
return console
def addPythonConsole(self, name="Python Console", visible=False):
"""Add a python console, inside which you can access the Python interpreter"""
wid = PythonConsole.QPythonConsole(self, locals())
self.addDock(wid, name, area=Qt.BottomDockWidgetArea, visible=visible)
return wid
def clearAllSettings(self):
"""Clear all saved QSettings(), such as window location etc"""
QSettings().remove("")
def closeEvent(self, event):
"""Called when window is closed, attempts to save state/geometry"""
settings = QSettings()
settings.setValue("geometry", self.saveGeometry())
settings.setValue("state", self.saveState())
if self.okToContinue():
QMainWindow.closeEvent(self, event)
else:
event.ignore()
def createFileActions(self):
"""Add the file actions (open/save/new)"""
self.openAct = QAction(QIcon('open.png'),
'&Open Project',
self,
shortcut=QKeySequence.Open,
statusTip='Open Project File',
triggered=self._openProject)
self.saveAct = QAction(QIcon('save.png'),
'&Save Project',
self,
shortcut=QKeySequence.Save,
statusTip='Save current project to Disk',
triggered=self._saveProject)
self.newAct = QAction(QIcon('new.png'),
'&New Project',
self,
shortcut=QKeySequence.New,
statusTip='Create new Project',
triggered=self._newProject)
for i in range(MainChip.MaxRecentFiles):
self.recentFileActs.append(
QAction(self, visible=False, triggered=self.openRecentFile))
def helpdialog(self):
"""Helps the User"""
QMessageBox.about(
self, 'Link to Documentation',
'See <a href="http://www.newae.com/sidechannel/cwdocs">newae.com/sidechannel/cwdocs</a> for Tutorials and '
'Documentation. If you are using an official release, this documentation should have also been present with '
'your release.<br><br>'
'See <a href="http://www.chipwhisperer.com">chipwhisperer.com</a> for Wiki, GIT Code, community information.'
'<br><br>See the About dialog for Copyright, Trademark, and Authorship information'
)
def aboutdialog(self):
"""Tells the User"""
QMessageBox.about(
self, 'About', '<h3>ChipWhisperer' + u'\u2122' + '</h3>'
'<h4>Copyright Information</h4>'
'Copyright ' + u'\u00A9' +
' NewAE Technology Inc., 2013-2014. <br>'
'Copyright ' + u'\u00A9' + ' Colin O\'Flynn, 2012-2014.'
'<h4>License Information</h4>'
'Released under the GPLv3 License, see <a href="http://www.gnu.org/copyleft/gpl.html">License Details</a>.<br>'
'Various parts of this project may be released under additional open-source licenses such as the BSD License '
'or LGPL license. See source code for details of specific licenses.'
'<h4>Projects used in ChipWhisperer</h4>'
'ChipWhisperer is built on or otherwise uses a number of open-source projects. Many thanks are given to the following '
'projects, which may also have additional license restrictions or information: '
'<ul>'
'<li><a href="https://www.python.org/">Python</a></li>'
'<li><a href="http://qt-project.org/">Qt</a></li>'
'<li><a href="http://qt-project.org/wiki/pyside">PySide</a></li>'
'<li><a href="http://www.pyqtgraph.org/">PyQtGraph</a></li>'
'<li><a href="http://www.numpy.org/">NumPy</a></li>'
'<li><a href="http://www.scipy.org/">SciPy</a></li>'
'<li><a href="http://sourceforge.net/apps/trac/pyusb/">PyUSB</a></li>'
'<li><a href="http://www.fourwalledcubicle.com/LUFA.php">LUFA USB Library</a></li>'
'<li><a href="http://www.ztex.de/downloads/#firmware_kit">ZTEX EZ-USB SDK</a></li>'
'<li><a href="http://www.libusb.org/wiki/libusb-1.0">libusb-1.0</a></li>'
'<li><a href="http://winavr.sourceforge.net/">WinAVR</a></li>'
'</ul>'
'Some projects may be missing from the above list - please let us know, any omission is a mistake!'
'<h4>Trademark Information</h4>'
'ChipWhisperer is a Trademark of NewAE Technology Inc.'
'')
def createMenus(self):
"""Create all menus (File, Window, etc)"""
self.fileMenu = self.menuBar().addMenu("&File")
self.fileMenu.addAction(self.newAct)
self.fileMenu.addAction(self.openAct)
self.fileMenu.addAction(self.saveAct)
# self.fileMenu.addAction(self.importAct)
self.separatorAct = self.fileMenu.addSeparator()
for i in range(MainChip.MaxRecentFiles):
self.fileMenu.addAction(self.recentFileActs[i])
self.projectMenu = self.menuBar().addMenu("&Project")
self.traceManageAct = QAction(
'&Manage Traces',
self,
statusTip='Add/Remove Traces from Project',
triggered=self.manageTraces.show)
self.projectMenu.addAction(self.traceManageAct)
self.showProjFileAct = QAction('&Project File Editor (Text)',
self,
statusTip='Edit Project File',
triggered=self.projEditDock.show)
self.projectMenu.addAction(self.showProjFileAct)
self.toolMenu = self.menuBar().addMenu("&Tools")
self.windowMenu = self.menuBar().addMenu("&Windows")
self.helpMenu = self.menuBar().addMenu("&Help")
self.helpManualAct = QAction('&Tutorial/User Manual',
self,
statusTip='Everything you need to know',
triggered=self.helpdialog)
self.helpListAct = QAction('&List Enabled/Disable Modules',
self,
statusTip="Check if you're missing modules",
triggered=self.listModulesShow)
self.helpAboutAct = QAction('&About',
self,
statusTip='About Dialog',
triggered=self.aboutdialog)
self.helpMenu.addAction(self.helpManualAct)
self.helpMenu.addAction(self.helpListAct)
self.helpMenu.addAction(self.helpAboutAct)
def enforceMenuOrder(self):
"""Makes sure menus appear in correct order, required as they get reordered when we add a new item to one"""
fakeAction = QAction('Does Nothing', self, visible=False)
self.projectMenu.addAction(fakeAction)
fakeAction = QAction('Does Nothing', self, visible=False)
self.toolMenu.addAction(fakeAction)
fakeAction = QAction('Does Nothing', self, visible=False)
self.windowMenu.addAction(fakeAction)
fakeAction = QAction('Does Nothing', self, visible=False)
self.helpMenu.addAction(fakeAction)
def initUI(self, icon="cwicon"):
"""Setup the UI, creating statusbar, setting title, menus, etc"""
self.statusBar()
self.setWindowTitle(self.name)
self.setWindowIcon(QIcon(":/images/%s.png" % icon))
#Project editor dock
self.projEditDock = self.addDock(self.projEditWidget,
name="Project Text Editor",
area=Qt.RightDockWidgetArea,
visible=False,
addToWindows=False)
self.recentFileActs = []
self.createFileActions()
self.createMenus()
self.updateRecentFileActions()
self.show()
def updateTitleBar(self):
"""Update filename shown in title bar"""
if self.filename is not None:
fname = os.path.basename(self.filename)
else:
fname = "Untitled"
self.setWindowTitle("%s - %s[*]" % (self.name, fname))
self.setWindowModified(self.dirty)
def listModulesShow(self):
"""Opens the Dialog which shows loaded/unloaded modules"""
ml = ModuleListDialog(self.listModules)
ml.exec_()
def listModules(self):
"""Should return a list of all possible imports, used to test which modules are missing"""
return [["MainChip", True, ""]]
def setCurrentFile(self, fname):
"""Set current project filename, adds it to recent file list"""
self.filename = fname
self.updateTitleBar()
if fname is None:
return
settings = QSettings()
files = settings.value('recentFileList', [" ", " ", " ", " "])
try:
files.remove(fname)
except ValueError:
pass
except AttributeError:
pass
files.insert(0, fname)
del files[MainChip.MaxRecentFiles:]
settings = QSettings()
settings.setValue('recentFileList', files)
for widget in QApplication.topLevelWidgets():
if isinstance(widget, MainChip):
widget.updateRecentFileActions()
def updateRecentFileActions(self):
"""Update & Load the list of recent files"""
settings = QSettings()
files = settings.value('recentFileList')
files_no = 0
if files:
files_no = len(files)
numRecentFiles = min(files_no, MainChip.MaxRecentFiles)
for i in range(numRecentFiles):
text = "&%d %s" % (i + 1, self.strippedName(files[i]))
self.recentFileActs[i].setText(text)
self.recentFileActs[i].setData(files[i])
self.recentFileActs[i].setVisible(True)
for j in range(numRecentFiles, MainChip.MaxRecentFiles):
self.recentFileActs[j].setVisible(False)
self.separatorAct.setVisible((numRecentFiles > 0))
def strippedName(self, fullFileName):
(filepath, filename) = os.path.split(fullFileName)
(base, toplevel) = os.path.split(filepath)
return toplevel + "/" + filename
#return QFileInfo(fullFileName).fileName()
def _openProject(self, fname=None):
#TODO: close etc
if fname is None:
fname, _ = QFileDialog.getOpenFileName(self, 'Open file', '.',
'*.cwp')
if fname is not None:
self.openFile.emit(fname)
self.setCurrentFile(fname)
def _newProject(self):
self.newFile.emit()
def _saveProject(self):
self.saveFile.emit()
def project(self):
return self._project
def setProject(self, proj):
self._project = proj
self.projEditWidget.setFilename(self._project.filename)
self._project.valueChanged.connect(
self.projEditWidget.projectChangedGUI)
self.projectChanged.emit(self._project)
self._project.filenameChanged.connect(self.projEditWidget.setFilename)
def openRecentFile(self):
action = self.sender()
if action:
self.openFile.emit(action.data())
def okToContinue(self):
# reply = QMessageBox.question(self, "%s - Unsaved Changes"%self.name, "Save unsaved changes?",QMessageBox.Yes|QMessageBox.No|QMessageBox.Cancel)
savedialog = saveProjectDialog(self)
savedialog.exec_()
reply = savedialog.value()
if reply == QDialogButtonBox.RejectRole:
return False
elif reply == QDialogButtonBox.AcceptRole:
self.saveProject()
return True
def _setParameter_children(self, top, path, value, echo):
"""Descends down a given path, looking for value to set"""
#print top.name()
if top.name() == path[0]:
if len(path) > 1:
for c in top.children():
self._setParameter_children(c, path[1:], value, echo)
else:
#Check if this is a dictionary/list
if "values" in top.opts:
try:
if isinstance(top.opts["values"], dict):
value = top.opts["values"][value]
except TypeError:
pass
if echo == False:
top.opts["echooff"] = True
if top.opts["type"] == "action":
top.activate()
else:
top.setValue(value)
raise ValueError()
def setParameter(self, parameter, echo=False):
"""Sets a parameter based on a list, used for scripting in combination with showScriptParameter"""
path = parameter[:-1]
value = parameter[-1]
try:
for t in self.paramTrees:
for i in range(0, t.invisibleRootItem().childCount()):
self._setParameter_children(
t.invisibleRootItem().child(i).param, path, value,
echo)
print "Parameter not found: %s" % str(parameter)
except ValueError:
#A little klunky: we use exceptions to tell us the system DID work as intended
pass
except IndexError:
raise IndexError("IndexError Setting Parameter %s\n%s" %
(str(parameter), traceback.format_exc()))
#User might be calling these in a row, need to process all events
QCoreApplication.processEvents()
def showScriptParameter(self, param, changes, topParam):
"""
This function is used to tell the user what they should pass to setParameter
in order to recreate a system. This will automatically be called if the module
has done the following:
When calling ExtendedParameter.setupParameter(), have passed a reference to 'self' like this::
ExtendedParameter.setupExtended(self.params, self)
Have a function called paramTreeChanged in the class which calls showScriptParameter (this function).
Typically done like the following, where self.showScriptParameter is setup in the setupExtended() call. You
might need to pass the reference to this instance down to lower modules.::
def paramTreeChanged(self, param, changes):
if self.showScriptParameter is not None:
self.showScriptParameter(param, changes, self.params)
"""
for param, change, data in changes:
ppath = topParam.childPath(param)
if ppath is None:
name = [param.name()]
else:
ppath.insert(0, topParam.name())
name = ppath
#Don't pollute script output with readonly things
if param.opts["readonly"] == True:
continue
if "echooff" in param.opts:
if param.opts["echooff"] == True:
param.opts["echooff"] = False
continue
if "values" in param.opts:
if not hasattr(param.opts["values"], 'iteritems'):
name.append(data)
else:
for k, v in param.opts["values"].iteritems():
if v == data:
name.append(k)
else:
name.append(data)
self.paramScripting.append(str(name))
def macWorkArounds(self):
# There is some odd error on Mac OS X where you get little rectangles near close buttons
# Calling this gets rid of them - reference to errors with modal system on QT Mac build have been found
# but haven't chased down actual cause yet
test = saveProjectDialog(self)
