# ========================================================================= # FILE: Application.py # # USAGE: --- # # DESCRIPTION: This main file use to start the Application # # OPTIONS: --- # REQUIREMENTS: --- # BUGS: --- # NOTES: --- # AUTHOR: Fahim Khan, fahim.elex@gmail.com # MODIFIED: Rahul Paknikar, rahulp@iitb.ac.in # ORGANIZATION: eSim team at FOSSEE, IIT Bombay. # CREATED: Tuesday 24 February 2015 # REVISION: Friday 14 February 2020 # ========================================================================= import pathmagic # noqa from PyQt4 import QtGui, QtCore from configuration.Appconfig import Appconfig from projManagement.openProject import OpenProjectInfo from projManagement.newProject import NewProjectInfo from projManagement.Kicad import Kicad from projManagement.Validation import Validation from projManagement import Worker from frontEnd import ProjectExplorer from frontEnd import Workspace from frontEnd import DockArea import time from PyQt4.Qt import QSize import sys import os import shutil # Its our main window of application. class Application(QtGui.QMainWindow): """This class initializes all objects used in this file.""" global project_name def __init__(self, *args): """Initialize main Application window.""" # Calling __init__ of super class QtGui.QMainWindow.__init__(self, *args) # Flag for mode of operation. Default is set to offline mode. self.online_flag = False # Creating require Object self.obj_workspace = Workspace.Workspace() self.obj_Mainview = MainView() self.obj_kicad = Kicad(self.obj_Mainview.obj_dockarea) self.obj_appconfig = Appconfig() self.obj_validation = Validation() # Initialize all widget self.setCentralWidget(self.obj_Mainview) self.initToolBar() self.setGeometry(self.obj_appconfig._app_xpos, self.obj_appconfig._app_ypos, self.obj_appconfig._app_width, self.obj_appconfig._app_heigth) self.setWindowTitle(self.obj_appconfig._APPLICATION) self.showMaximized() self.setWindowIcon(QtGui.QIcon('../../images/logo.png')) self.systemTrayIcon = QtGui.QSystemTrayIcon(self) self.systemTrayIcon.setIcon(QtGui.QIcon('../../images/logo.png')) self.systemTrayIcon.setVisible(True) def initToolBar(self): """ This function initializes Tool Bars. It setups the icons, short-cuts and defining functonality for: - Top-tool-bar (New project, Open project, Close project, \ Mode switch, Help option) - Left-tool-bar (Open Schematic, Convert KiCad to NgSpice, \ Simuation, Model Editor, Subcircuit, NGHDL, Modelica \ Converter, OM Optimisation) """ # Top Tool bar self.newproj = QtGui.QAction( QtGui.QIcon('../../images/newProject.png'), 'New Project', self ) self.newproj.setShortcut('Ctrl+N') self.newproj.triggered.connect(self.new_project) self.openproj = QtGui.QAction( QtGui.QIcon('../../images/openProject.png'), 'Open Project', self ) self.openproj.setShortcut('Ctrl+O') self.openproj.triggered.connect(self.open_project) self.closeproj = QtGui.QAction( QtGui.QIcon('../../images/closeProject.png'), 'Close Project', self ) self.closeproj.setShortcut('Ctrl+X') self.closeproj.triggered.connect(self.close_project) self.wrkspce = QtGui.QAction( QtGui.QIcon('../../images/workspace.ico'), 'Change Workspace', self ) self.wrkspce.setShortcut('Ctrl+W') self.wrkspce.triggered.connect(self.change_workspace) self.switchmode = None self.validate_mode() if self.online_flag == True: self.switchmode = QtGui.QAction(QtGui.QIcon( '../../images/online.png'), 'Go Offline', self ) elif self.online_flag == False: self.switchmode = QtGui.QAction(QtGui.QIcon( '../../images/offline.png'), 'Go Online', self ) elif self.online_flag is None: self.switchmode = QtGui.QAction(QtGui.QIcon( '../../images/disable.png'), 'Mode switching has been disabled. ' + 'Default mode set to offline', self ) self.switchmode.setEnabled(False) self.switchmode.setShortcut('Ctrl+G') self.switchmode.triggered.connect(self.change_mode) self.helpfile = QtGui.QAction( QtGui.QIcon('../../images/helpProject.png'), 'Help', self ) self.helpfile.setShortcut('Ctrl+H') self.helpfile.triggered.connect(self.help_project) self.topToolbar = self.addToolBar('Top Tool Bar') self.topToolbar.addAction(self.newproj) self.topToolbar.addAction(self.openproj) self.topToolbar.addAction(self.closeproj) self.topToolbar.addAction(self.wrkspce) self.topToolbar.addAction(self.switchmode) self.topToolbar.addAction(self.helpfile) # This part is setting fossee logo to the right # corner in the application window. self.spacer = QtGui.QWidget() self.spacer.setSizePolicy( QtGui.QSizePolicy.Expanding, QtGui.QSizePolicy.Expanding) self.topToolbar.addWidget(self.spacer) self.logo = QtGui.QLabel() self.logopic = QtGui.QPixmap( os.path.join( os.path.abspath('../..'), 'images', 'fosseeLogo.png' )) self.logopic = self.logopic.scaled( QSize(150, 150), QtCore.Qt.KeepAspectRatio) self.logo.setPixmap(self.logopic) self.logo.setStyleSheet("padding:0 15px 0 0;") self.topToolbar.addWidget(self.logo) # Left Tool bar Action Widget self.kicad = QtGui.QAction( QtGui.QIcon('../../images/kicad.png'), 'Open Schematic', self ) self.kicad.triggered.connect(self.obj_kicad.openSchematic) self.conversion = QtGui.QAction( QtGui.QIcon('../../images/ki-ng.png'), 'Convert Kicad to Ngspice', self ) self.conversion.triggered.connect(self.obj_kicad.openKicadToNgspice) self.ngspice = QtGui.QAction( QtGui.QIcon('../../images/ngspice.png'), 'Simulation', self ) self.ngspice.triggered.connect(self.open_ngspice) self.model = QtGui.QAction( QtGui.QIcon('../../images/model.png'), 'Model Editor', self ) self.model.triggered.connect(self.open_modelEditor) self.subcircuit = QtGui.QAction( QtGui.QIcon('../../images/subckt.png'), 'Subcircuit', self ) self.subcircuit.triggered.connect(self.open_subcircuit) self.nghdl = QtGui.QAction( QtGui.QIcon('../../images/nghdl.png'), 'Nghdl', self ) self.nghdl.triggered.connect(self.open_nghdl) self.omedit = QtGui.QAction( QtGui.QIcon('../../images/omedit.png'), 'Modelica Converter', self ) self.omedit.triggered.connect(self.open_OMedit) self.omoptim = QtGui.QAction( QtGui.QIcon('../../images/omoptim.png'), 'OM Optimisation', self ) self.omoptim.triggered.connect(self.open_OMoptim) # Adding Action Widget to tool bar self.lefttoolbar = QtGui.QToolBar('Left ToolBar') self.addToolBar(QtCore.Qt.LeftToolBarArea, self.lefttoolbar) self.lefttoolbar.addAction(self.kicad) self.lefttoolbar.addAction(self.conversion) self.lefttoolbar.addAction(self.ngspice) self.lefttoolbar.addAction(self.model) self.lefttoolbar.addAction(self.subcircuit) self.lefttoolbar.addAction(self.nghdl) self.lefttoolbar.addAction(self.omedit) self.lefttoolbar.addAction(self.omoptim) self.lefttoolbar.setOrientation(QtCore.Qt.Vertical) self.lefttoolbar.setIconSize(QSize(40, 40)) def closeEvent(self, event): ''' This function closes the ongoing program (process). When exit button is pressed a Message box pops out with \ exit message and buttons 'Yes', 'No'. 1. If 'Yes' is pressed: - check that program (process) in procThread_list \ (a list made in Appconfig.py): - if available it terminates that program. - if the program (process) is not available, \ then check it in process_obj (a list made in \ Appconfig.py) and if found, it closes the program. 2. If 'No' is pressed: - the program just continues as it was doing earlier. ''' exit_msg = "Are you sure you want to exit the program?" exit_msg += " All unsaved data will be lost." reply = QtGui.QMessageBox.question( self, 'Message', exit_msg, QtGui.QMessageBox.Yes, QtGui.QMessageBox.No ) if reply == QtGui.QMessageBox.Yes: for proc in self.obj_appconfig.procThread_list: try: proc.terminate() except BaseException: pass try: for process_object in self.obj_appconfig.process_obj: try: process_object.close() except BaseException: pass except BaseException: pass # Check if "Open project" and "New project" window is open. # If yes, just close it when application is closed. try: self.project.close() except BaseException: pass event.accept() self.systemTrayIcon.showMessage('Exit', 'eSim is Closed.') elif reply == QtGui.QMessageBox.No: event.ignore() def new_project(self): """This function call New Project Info class.""" text, ok = QtGui.QInputDialog.getText( self, 'New Project Info', 'Enter Project Name:' ) if ok: self.projname = (str(text)) self.project = NewProjectInfo() directory, filelist = self.project.createProject(self.projname) self.obj_Mainview.obj_projectExplorer.addTreeNode( directory, filelist) else: print("No new project created") self.obj_appconfig.print_info('No new project created') try: self.obj_appconfig.print_info( 'Current project is : ' + self.obj_appconfig.current_project["ProjectName"] ) except BaseException: pass def open_project(self): """This project call Open Project Info class.""" print("Function : Open Project") self.project = OpenProjectInfo() try: directory, filelist = self.project.body() self.obj_Mainview.obj_projectExplorer.addTreeNode( directory, filelist) except BaseException: pass def close_project(self): """ This function closes the saved project. It first checks whether project (file) is present in list. - If present: - it first kills that process-id. - closes that file. - Shows message "Current project is closed" - If not present: pass """ print("Function : Close Project") current_project = self.obj_appconfig.current_project['ProjectName'] if current_project is None: pass else: temp = self.obj_appconfig.current_project['ProjectName'] for pid in self.obj_appconfig.proc_dict[temp]: try: os.kill(pid, 9) except BaseException: pass self.obj_Mainview.obj_dockarea.closeDock() self.obj_appconfig.current_project['ProjectName'] = None self.systemTrayIcon.showMessage( 'Close', 'Current project ' + os.path.basename(current_project) + ' is Closed.' ) def change_workspace(self): """ This function call changes Workspace """ print("Function : Change Workspace") self.obj_workspace.returnWhetherClickedOrNot(self) self.hide() self.obj_workspace.show() def validate_mode(self): """ This functions checks whether proper fp-lib-table* files are \ available or not. If not, then move appropriate files from \ supportFiles folder and set `self.online_flag` accordingly. @params @return None """ remove = False if self.obj_appconfig.kicad_path is not None: if not os.path.exists( self.obj_appconfig.kicad_path + "/fp-lib-table" ): remove = True elif os.path.exists(self.obj_appconfig.kicad_path + "/fp-lib-table-offline"): if os.path.exists(self.obj_appconfig.kicad_path + "/fp-lib-table-online"): remove = True os.remove(self.obj_appconfig.kicad_path + "/fp-lib-table") else: self.online_flag = True else: if not os.path.exists(self.obj_appconfig.kicad_path + "/fp-lib-table-online"): remove = True os.remove(self.obj_appconfig.kicad_path + "/fp-lib-table") else: self.online_flag = False if remove: # Remove invalid files if os.path.exists( self.obj_appconfig.kicad_path + "/fp-lib-table-offline" ): os.remove(self.obj_appconfig.kicad_path + "/fp-lib-table-offline") if os.path.exists( self.obj_appconfig.kicad_path + "/fp-lib-table-online" ): os.remove(self.obj_appconfig.kicad_path + "/fp-lib-table-online") # Restore original files shutil.copy('../supportFiles/fp-lib-table-online', self.obj_appconfig.kicad_path + "/") shutil.copy('../supportFiles/fp-lib-table', self.obj_appconfig.kicad_path + "/") self.online_flag = False else: self.online_flag = None def change_mode(self): """ - This function is used for changing mode of operation for KiCad. \ - There are three modes of operation : - online - offline - disable - If none of the KiCad tools (associated with eSim) are \ open, then validate this mode by calling the function \ `validate_mode` and depending on online_flag, swap \ appropriate fp-lib-table files. - If any of the KiCad tools (associated with eSim) is open, \ then ask user to close all these tools. - If `online_flag` is `None`, then disable this feature. @params @return None """ if not self.obj_kicad.check_open_schematic(): self.validate_mode() if self.online_flag is True: os.rename( self.obj_appconfig.kicad_path + "/fp-lib-table", self.obj_appconfig.kicad_path + "/fp-lib-table-online" ) os.rename( self.obj_appconfig.kicad_path + "/fp-lib-table-offline", self.obj_appconfig.kicad_path + "/fp-lib-table" ) self.switchmode.setIcon( QtGui.QIcon('../../images/offline.png') ) self.switchmode.setText('Go Online') self.switchmode.setEnabled(True) self.online_flag = False elif self.online_flag is False: os.rename( self.obj_appconfig.kicad_path + "/fp-lib-table", self.obj_appconfig.kicad_path + "/fp-lib-table-offline" ) os.rename( self.obj_appconfig.kicad_path + "/fp-lib-table-online", self.obj_appconfig.kicad_path + "/fp-lib-table" ) self.switchmode.setIcon( QtGui.QIcon('../../images/online.png') ) self.switchmode.setText('Go Offline') self.switchmode.setEnabled(True) self.online_flag = True elif self.online_flag is None: self.switchmode.setIcon( QtGui.QIcon('../../images/disable.png') ) self.switchmode.setText('Mode switching has been ' + 'disabled. Default mode set to offline.') self.switchmode.setEnabled(False) else: self.msg = QtGui.QErrorMessage() self.msg.setWindowTitle("Error Message") self.msg.setModal(True) self.msg.showMessage( 'Please save and close all the Kicad ' + 'windows first, then change the mode' ) self.msg.exec_() def help_project(self): """ This function opens usermanual in dockarea. - It prints the message ""Function : Help"" - Uses print_info() method of class Appconfig from Configuration/Appconfig.py file. - Call method usermanual() from ./DockArea.py. """ print("Function : Help") self.obj_appconfig.print_info('Help is called') print("Current Project is : ", self.obj_appconfig.current_project) self.obj_Mainview.obj_dockarea.usermanual() def open_ngspice(self): """This Function execute ngspice on current project.""" self.projDir = self.obj_appconfig.current_project["ProjectName"] if self.projDir is not None: self.obj_Mainview.obj_dockarea.ngspiceEditor(self.projDir) currTime = time.time() count = 0 while True: try: st = os.stat(os.path.join(self.projDir, "plot_data_i.txt")) if st.st_mtime >= currTime: break except Exception: pass time.sleep(0.5) # Fail Safe ===> count += 1 if count >= 100: raise Exception( "Ngspice taking too long for simulation. " "Check netlist file to change simulation parameters." ) # Calling Python Plotting try: self.obj_Mainview.obj_dockarea.plottingEditor() except Exception as e: self.msg = QtGui.QErrorMessage() self.msg.setModal(True) self.msg.setWindowTitle("Error Message") self.msg.showMessage( 'Error while opening python plotting Editor.' ' Please look at console for more details.' ) self.msg.exec_() print("Exception Message:", str(e)) self.obj_appconfig.print_error('Exception Message : ' + str(e)) else: self.msg = QtGui.QErrorMessage() self.msg.setModal(True) self.msg.setWindowTitle("Error Message") self.msg.showMessage( 'Please select the project first.' ' You can either create new project or open existing project' ) self.msg.exec_() def open_subcircuit(self): """ This function opens 'subcircuit' option in left-tool-bar. When 'subcircuit' icon is clicked wich is present in left-tool-bar of main page: - Meassge shown on screen "Subcircuit editor is called". - 'subcircuiteditor()' function is called using object 'obj_dockarea' of class 'Mainview'. """ print("Function : Subcircuit editor") self.obj_appconfig.print_info('Subcircuit editor is called') self.obj_Mainview.obj_dockarea.subcircuiteditor() def open_nghdl(self): """ This function calls NGHDL option in left-tool-bar. It uses validateTool() method from Validation.py: - If 'nghdl' is present in executables list then it passes command 'nghdl -e' to WorkerThread class of Worker.py. - If 'nghdl' is not present, then it shows error message. """ print("Function : NGHDL") self.obj_appconfig.print_info('NGHDL is called') if self.obj_validation.validateTool('nghdl'): self.cmd = 'nghdl -e' self.obj_workThread = Worker.WorkerThread(self.cmd) self.obj_workThread.start() else: self.msg = QtGui.QErrorMessage() self.msg.setModal(True) self.msg.setWindowTitle('NGHDL Error') self.msg.showMessage('Error while opening NGHDL. ' + 'Please make sure it is installed') self.obj_appconfig.print_error('Error while opening NGHDL. ' + 'Please make sure it is installed') self.msg.exec_() def open_modelEditor(self): """ This function opens model editor option in left-tool-bar. When model editor icon is clicked which is present in left-tool-bar of main page: - Meassge shown on screen "Model editor is called". - 'modeleditor()' function is called using object 'obj_dockarea' of class 'Mainview'. """ print("Function : Model editor") self.obj_appconfig.print_info('Model editor is called') self.obj_Mainview.obj_dockarea.modelEditor() def open_OMedit(self): """ This function calls ngspice to OMEdit converter and then launch OMEdit. """ self.obj_appconfig.print_info('OMEdit is called') self.projDir = self.obj_appconfig.current_project["ProjectName"] if self.projDir is not None: if self.obj_validation.validateCirOut(self.projDir): self.projName = os.path.basename(self.projDir) self.ngspiceNetlist = os.path.join( self.projDir, self.projName + ".cir.out" ) self.modelicaNetlist = os.path.join( self.projDir, self.projName + ".mo" ) """ try: # Creating a command for Ngspice to Modelica converter self.cmd1 = " python3 ../ngspicetoModelica/NgspicetoModelica.py "\ +self.ngspiceNetlist self.obj_workThread1 = Worker.WorkerThread(self.cmd1) self.obj_workThread1.start() if self.obj_validation.validateTool("OMEdit"): # Creating command to run OMEdit self.cmd2 = "OMEdit "+self.modelicaNetlist self.obj_workThread2 = Worker.WorkerThread(self.cmd2) self.obj_workThread2.start() else: self.msg = QtGui.QMessageBox() self.msgContent = "There was an error while opening OMEdit.
\ Please make sure OpenModelica is installed in your\ system.
\ To install it on Linux : Go to\ OpenModelica Linux and \ install nigthly build release.
\ To install it on Windows : Go to\ OpenModelica Windows\ and install latest version.
" self.msg.setTextFormat(QtCore.Qt.RichText) self.msg.setText(self.msgContent) self.msg.setWindowTitle("Missing OpenModelica") self.obj_appconfig.print_info(self.msgContent) self.msg.exec_() except Exception as e: self.msg = QtGui.QErrorMessage() self.msg.setModal(True) self.msg.setWindowTitle( "Ngspice to Modelica conversion error") self.msg.showMessage( 'Unable to convert NgSpice netlist to\ Modelica netlist :'+str(e)) self.msg.exec_() self.obj_appconfig.print_error(str(e)) """ self.obj_Mainview.obj_dockarea.modelicaEditor(self.projDir) else: self.msg = QtGui.QErrorMessage() self.msg.setModal(True) self.msg.setWindowTitle("Missing Ngspice netlist") self.msg.showMessage( 'Current project does not contain any Ngspice file. ' + 'Please create Ngspice file with extension .cir.out' ) self.msg.exec_() else: self.msg = QtGui.QErrorMessage() self.msg.setModal(True) self.msg.setWindowTitle("Error Message") self.msg.showMessage( 'Please select the project first. ' + 'You can either create a new project or open existing project' ) self.exec_() def open_OMoptim(self): """ This function uses validateTool() method from Validation.py: - If 'OMOptim' is present in executables list then it passes command 'OMOptim' to WorkerThread class of Worker.py - If 'OMOptim' is not present, then it shows error message with link to download it on Linux and Windows. """ print("Function : OMOptim") self.obj_appconfig.print_info('OMOptim is called') # Check if OMOptim is installed if self.obj_validation.validateTool("OMOptim"): # Creating a command to run self.cmd = "OMOptim" self.obj_workThread = Worker.WorkerThread(self.cmd) self.obj_workThread.start() else: self.msg = QtGui.QMessageBox() self.msgContent = ( "There was an error while opening OMOptim.
" "Please make sure OpenModelica is installed in your" " system.
" "To install it on Linux : Go to OpenModelica Linux and install nightly build" " release.
" "To install it on Windows : Go to OpenModelica Windows and install latest version.
" ) self.msg.setTextFormat(QtCore.Qt.RichText) self.msg.setText(self.msgContent) self.msg.setWindowTitle("Error Message") self.obj_appconfig.print_info(self.msgContent) self.msg.exec_() # This class initialize the Main View of Application class MainView(QtGui.QWidget): """ This class defines whole view and style of main page: - Position of tool bars: - Top tool bar. - Left tool bar. - Project explorer Area. - Dock area. - Console area. """ def __init__(self, *args): # call init method of superclass QtGui.QWidget.__init__(self, *args) self.obj_appconfig = Appconfig() self.leftSplit = QtGui.QSplitter() self.middleSplit = QtGui.QSplitter() self.mainLayout = QtGui.QVBoxLayout() # Intermediate Widget self.middleContainer = QtGui.QWidget() self.middleContainerLayout = QtGui.QVBoxLayout() # Area to be included in MainView self.noteArea = QtGui.QTextEdit() self.noteArea.setReadOnly(True) self.obj_appconfig.noteArea['Note'] = self.noteArea self.obj_appconfig.noteArea['Note'].append( ' eSim Started......') self.obj_appconfig.noteArea['Note'].append('Project Selected : None') self.obj_appconfig.noteArea['Note'].append('\n') # CSS self.noteArea.setStyleSheet(" \ QWidget { border-radius: 15px; border: 1px \ solid gray; padding: 5px; } \ ") self.obj_dockarea = DockArea.DockArea() self.obj_projectExplorer = ProjectExplorer.ProjectExplorer() # Adding content to vertical middle Split. self.middleSplit.setOrientation(QtCore.Qt.Vertical) self.middleSplit.addWidget(self.obj_dockarea) self.middleSplit.addWidget(self.noteArea) # Adding middle split to Middle Container Widget self.middleContainerLayout.addWidget(self.middleSplit) self.middleContainer.setLayout(self.middleContainerLayout) # Adding content of left split self.leftSplit.addWidget(self.obj_projectExplorer) self.leftSplit.addWidget(self.middleContainer) # Adding to main Layout self.mainLayout.addWidget(self.leftSplit) self.leftSplit.setSizes([self.width() / 4.5, self.height()]) self.middleSplit.setSizes([self.width(), self.height() / 2]) self.setLayout(self.mainLayout) # It is main function of the module and starts the application def main(args): """ The splash screen opened at the starting of screen is performed by this function. """ print("Starting eSim......") app = QtGui.QApplication(args) splash_pix = QtGui.QPixmap('../../images/splash_screen_esim.png') splash = QtGui.QSplashScreen(splash_pix, QtCore.Qt.WindowStaysOnTopHint) splash.setMask(splash_pix.mask()) splash.show() appView = Application() appView.splash = splash appView.obj_workspace.returnWhetherClickedOrNot(appView) try: file = open(os.path.join( os.path.expanduser("~"),".esim/workspace.txt"), 'r' ) work = int(file.read(1)) file.close() except IOError: work = 0 if work is not 0: appView.obj_workspace.defaultWorkspace() else: appView.hide() appView.obj_workspace.show() sys.exit(app.exec_()) # Call main function if __name__ == '__main__': # Create and display the splash screen main(sys.argv)