[wxWidgets.git] / wxPython / samples / ide / activegrid / tool / ExtensionService.py

#----------------------------------------------------------------------------
# Name:         ExtensionService.py
# Purpose:      Extension Service for IDE
#
# Author:       Peter Yared
#
# Created:      5/23/05
# CVS-ID:       $ID:$
# Copyright:    (c) 2005-2006 ActiveGrid, Inc.
# License:      wxWindows License
#----------------------------------------------------------------------------

import wx
import wx.lib.pydocview
import MessageService
import ProjectEditor
import os
import os.path
import activegrid.util.xmlutils as xmlutils
_ = wx.GetTranslation


#----------------------------------------------------------------------------
# Constants
#----------------------------------------------------------------------------
SPACE = 10
HALF_SPACE = 5


#----------------------------------------------------------------------------
# Classes
#----------------------------------------------------------------------------

class Extension:


    def __init__(self, menuItemName=None):
        self.menuItemName = menuItemName
        self.id = 0
        self.menuItemDesc = ''
        self.command = ''
        self.commandPreArgs = ''
        self.commandPostArgs = ''
        self.fileExt = None
        self.opOnSelectedFile = True


class ExtensionService(wx.lib.pydocview.DocService):

    EXTENSIONS_KEY = "/AG_Extensions"

    def __init__(self):
        self.LoadExtensions()


    def __getExtensionKeyName(extensionName):
        return "%s/%s" % (ExtensionService.EXTENSIONS_KEY, extensionName)


    __getExtensionKeyName = staticmethod(__getExtensionKeyName)


    def LoadExtensions(self):
        self._extensions = []

        extensionNames = []
        config = wx.ConfigBase_Get()
        path = config.GetPath()
        try:
            config.SetPath(ExtensionService.EXTENSIONS_KEY)
            cont, value, index = config.GetFirstEntry()
            while cont:
                extensionNames.append(value)
                cont, value, index = config.GetNextEntry(index)
        finally:
            config.SetPath(path)

        for extensionName in extensionNames:
            extensionData = config.Read(self.__getExtensionKeyName(extensionName))
            if extensionData:
                extension = xmlutils.unmarshal(extensionData.encode('utf-8'))
                self._extensions.append(extension)


    def SaveExtensions(self):
        config = wx.ConfigBase_Get()
        config.DeleteGroup(ExtensionService.EXTENSIONS_KEY)
        for extension in self._extensions:
            config.Write(self.__getExtensionKeyName(extension.menuItemName), xmlutils.marshal(extension))


    def GetExtensions(self):
        return self._extensions


    def SetExtensions(self, extensions):
        self._extensions = extensions


    def CheckSumExtensions(self):
        return xmlutils.marshal(self._extensions)


    def InstallControls(self, frame, menuBar = None, toolBar = None, statusBar = None, document = None):
        toolsMenuIndex = menuBar.FindMenu(_("&Tools"))
        if toolsMenuIndex > -1:
            toolsMenu = menuBar.GetMenu(toolsMenuIndex)
        else:
            toolsMenu = wx.Menu()

        if self._extensions:
            if toolsMenu.GetMenuItems():
                toolsMenu.AppendSeparator()
            for ext in self._extensions:
                # Append a tool menu item for each extension
                ext.id = wx.NewId()
                toolsMenu.Append(ext.id, ext.menuItemName)
                wx.EVT_MENU(frame, ext.id, frame.ProcessEvent)
                wx.EVT_UPDATE_UI(frame, ext.id, frame.ProcessUpdateUIEvent)

        if toolsMenuIndex == -1:
            index = menuBar.FindMenu(_("&Run"))
            if index == -1:
                index = menuBar.FindMenu(_("&Project"))
            if index == -1:
                index = menuBar.FindMenu(_("&Format"))
            if index == -1:
                index = menuBar.FindMenu(_("&View"))
            menuBar.Insert(index + 1, toolsMenu, _("&Tools"))


    def ProcessEvent(self, event):
        id = event.GetId()
        for extension in self._extensions:
            if id == extension.id:
                self.OnExecuteExtension(extension)
                return True
        return False


    def ProcessUpdateUIEvent(self, event):
        id = event.GetId()
        for extension in self._extensions:
            if id == extension.id:
                if extension.fileExt:
                    doc = wx.GetApp().GetDocumentManager().GetCurrentDocument()
                    if doc and '*' in extension.fileExt:
                        event.Enable(True)
                        return True
                    if doc:
                        for fileExt in extension.fileExt:
                            if fileExt in doc.GetDocumentTemplate().GetFileFilter():
                                event.Enable(True)
                                return True
                        if extension.opOnSelectedFile and isinstance(doc, ProjectEditor.ProjectDocument):
                            filename = doc.GetFirstView().GetSelectedFile()
                            if filename:
                                template = wx.GetApp().GetDocumentManager().FindTemplateForPath(filename)
                                for fileExt in extension.fileExt:
                                    if fileExt in template.GetFileFilter():
                                        event.Enable(True)
                                        return True
                    event.Enable(False)
                    return False
        return False


    def OnExecuteExtension(self, extension):
        if extension.fileExt:
            doc = wx.GetApp().GetDocumentManager().GetCurrentDocument()
            if not doc:
                return
            if extension.opOnSelectedFile and isinstance(doc, ProjectEditor.ProjectDocument):
                filename = doc.GetFirstView().GetSelectedFile()
                if not filename:
                    filename = doc.GetFilename()
            else:
                filename = doc.GetFilename()
            ext = os.path.splitext(filename)[1]
            if not '*' in extension.fileExt:
                if not ext or ext[1:] not in extension.fileExt:
                    return
            cmds = [extension.command]
            if extension.commandPreArgs:
                cmds.append(extension.commandPreArgs)
            cmds.append(filename)
            if extension.commandPostArgs:
                cmds.append(extension.commandPostArgs)
            os.spawnv(os.P_NOWAIT, extension.command, cmds)

        else:
            cmd = extension.command
            if extension.commandPreArgs:
                cmd = cmd + ' ' + extension.commandPreArgs
            if extension.commandPostArgs:
                cmd = cmd + ' ' + extension.commandPostArgs
            f = os.popen(cmd)
            messageService = wx.GetApp().GetService(MessageService.MessageService)
            messageService.ShowWindow()
            view = messageService.GetView()
            for line in f.readlines():
                view.AddLines(line)
            view.GetControl().EnsureCaretVisible()
            f.close()


class ExtensionOptionsPanel(wx.Panel):


    def __init__(self, parent, id):
        wx.Panel.__init__(self, parent, id)

        extOptionsPanelBorderSizer = wx.BoxSizer(wx.VERTICAL)

        extOptionsPanelSizer = wx.BoxSizer(wx.HORIZONTAL)

        extCtrlSizer = wx.BoxSizer(wx.VERTICAL)
        extCtrlSizer.Add(wx.StaticText(self, -1, _("External Tools:")), 0, wx.BOTTOM, HALF_SPACE)
        self._extListBox = wx.ListBox(self, -1, style=wx.LB_SINGLE)
        self.Bind(wx.EVT_LISTBOX, self.OnListBoxSelect, self._extListBox)
        extCtrlSizer.Add(self._extListBox, 1, wx.BOTTOM | wx.EXPAND, SPACE)
        buttonSizer = wx.GridSizer(cols=2, vgap=HALF_SPACE, hgap=HALF_SPACE)
        self._moveUpButton = wx.Button(self, -1, _("Move Up"))
        self.Bind(wx.EVT_BUTTON, self.OnMoveUp, self._moveUpButton)
        buttonSizer.Add(self._moveUpButton, 1, wx.EXPAND)
        self._moveDownButton = wx.Button(self, -1, _("Move Down"))
        self.Bind(wx.EVT_BUTTON, self.OnMoveDown, self._moveDownButton)
        buttonSizer.Add(self._moveDownButton, 1, wx.EXPAND)
        self._addButton = wx.Button(self, wx.ID_ADD)
        self.Bind(wx.EVT_BUTTON, self.OnAdd, self._addButton)
        buttonSizer.Add(self._addButton, 1, wx.EXPAND)
        self._deleteButton = wx.Button(self, wx.ID_DELETE, label=_("Delete")) # get rid of accelerator for letter d in "&Delete"
        self.Bind(wx.EVT_BUTTON, self.OnDelete, self._deleteButton)
        buttonSizer.Add(self._deleteButton, 1, wx.EXPAND)
        extCtrlSizer.Add(buttonSizer, 0, wx.ALIGN_CENTER)
        extOptionsPanelSizer.Add(extCtrlSizer, 0, wx.EXPAND)

        self._extDetailPanel = wx.Panel(self)
        staticBox = wx.StaticBox(self, label=_("Selected External Tool"))
        staticBoxSizer = wx.StaticBoxSizer(staticBox, wx.VERTICAL)

        extDetailSizer = wx.FlexGridSizer(cols=2, vgap=5, hgap=5)
        extDetailSizer.AddGrowableCol(1,1)

        extDetailSizer.Add(wx.StaticText(self._extDetailPanel, -1, _("Menu Item Name:")), flag=wx.ALIGN_CENTER_VERTICAL)
        self._menuItemNameTextCtrl = wx.TextCtrl(self._extDetailPanel, -1, size = (-1, -1))
        extDetailSizer.Add(self._menuItemNameTextCtrl, 0, wx.EXPAND)
        self.Bind(wx.EVT_TEXT, self.SaveCurrentItem, self._menuItemNameTextCtrl)

        extDetailSizer.Add(wx.StaticText(self._extDetailPanel, -1, _("Menu Item Description:")), flag=wx.ALIGN_CENTER_VERTICAL)
        self._menuItemDescTextCtrl = wx.TextCtrl(self._extDetailPanel, -1, size = (-1, -1))
        extDetailSizer.Add(self._menuItemDescTextCtrl, 0, wx.EXPAND)

        extDetailSizer.Add(wx.StaticText(self._extDetailPanel, -1, _("Command Path:")), flag=wx.ALIGN_CENTER_VERTICAL)
        self._commandTextCtrl = wx.TextCtrl(self._extDetailPanel, -1, size = (-1, -1))
        findFileButton = wx.Button(self._extDetailPanel, -1, _("Browse..."))
        def OnBrowseButton(event):
            fileDlg = wx.FileDialog(self, _("Choose an Executable:"), style=wx.OPEN|wx.FILE_MUST_EXIST|wx.HIDE_READONLY|wx.CHANGE_DIR)
            path = self._commandTextCtrl.GetValue()
            if path:
                fileDlg.SetPath(path)
            # fileDlg.CenterOnParent()  # wxBug: caused crash with wx.FileDialog
            if fileDlg.ShowModal() == wx.ID_OK:
                self._commandTextCtrl.SetValue(fileDlg.GetPath())
                self._commandTextCtrl.SetInsertionPointEnd()
                self._commandTextCtrl.SetToolTipString(fileDlg.GetPath())
            fileDlg.Destroy()
        wx.EVT_BUTTON(findFileButton, -1, OnBrowseButton)
        hsizer = wx.BoxSizer(wx.HORIZONTAL)
        hsizer.Add(self._commandTextCtrl, 1, wx.EXPAND)
        hsizer.Add(findFileButton, 0, wx.LEFT, HALF_SPACE)
        extDetailSizer.Add(hsizer, 0, wx.EXPAND)

        extDetailSizer.Add(wx.StaticText(self._extDetailPanel, -1, _("Command Pre Args:")), flag=wx.ALIGN_CENTER_VERTICAL)
        self._commandPreArgsTextCtrl = wx.TextCtrl(self._extDetailPanel, -1, size = (-1, -1))
        extDetailSizer.Add(self._commandPreArgsTextCtrl, 0, wx.EXPAND)

        extDetailSizer.Add(wx.StaticText(self._extDetailPanel, -1, _("Command Post Args:")), flag=wx.ALIGN_CENTER_VERTICAL)
        self._commandPostArgsTextCtrl = wx.TextCtrl(self._extDetailPanel, -1, size = (-1, -1))
        extDetailSizer.Add(self._commandPostArgsTextCtrl, 0, wx.EXPAND)

        extDetailSizer.Add(wx.StaticText(self._extDetailPanel, -1, _("File Extensions:")), flag=wx.ALIGN_CENTER_VERTICAL)
        self._fileExtTextCtrl = wx.TextCtrl(self._extDetailPanel, -1, size = (-1, -1))
        self._fileExtTextCtrl.SetToolTipString(_("""For example: "txt, text" (comma separated) or "*" for all files"""))
        extDetailSizer.Add(self._fileExtTextCtrl, 0, wx.EXPAND)

        self._selFileCtrl = wx.CheckBox(self._extDetailPanel, -1, _("Operate on Selected File"))
        extDetailSizer.Add(self._selFileCtrl, 0, wx.ALIGN_CENTER_VERTICAL|wx.TOP, SPACE)
        self._selFileCtrl.SetToolTipString(_("If focus is in the project, instead of operating on the project file, operate on the selected file."))

        self._extDetailPanel.SetSizer(extDetailSizer)
        staticBoxSizer.Add(self._extDetailPanel, 1, wx.ALL|wx.EXPAND, SPACE)

        extOptionsPanelSizer.Add(staticBoxSizer, 1, wx.LEFT|wx.EXPAND, SPACE)

        extOptionsPanelBorderSizer.Add(extOptionsPanelSizer, 1, wx.ALL|wx.EXPAND, SPACE)
        self.SetSizer(extOptionsPanelBorderSizer)

        if self.PopulateItems():
            self._extListBox.SetSelection(0)
        self.OnListBoxSelect()

        self.Layout()

        parent.AddPage(self, _("External Tools"))


    def OnOK(self, optionsDialog):
        self.SaveCurrentItem()
        extensionsService = wx.GetApp().GetService(ExtensionService)
        extensionsService.SetExtensions(self._extensions)
        extensionsService.SaveExtensions()
        if extensionsService.CheckSumExtensions() != self._oldExtensions:  # see PopulateItems() note about self._oldExtensions
            msgTitle = wx.GetApp().GetAppName()
            if not msgTitle:
                msgTitle = _("Document Options")
            wx.MessageBox(_("Extension changes will not appear until the application is restarted."),
                          msgTitle,
                          wx.OK | wx.ICON_INFORMATION,
                          self.GetParent())


    def PopulateItems(self):
        extensionsService = wx.GetApp().GetService(ExtensionService)
        import copy
        self._extensions = copy.deepcopy(extensionsService.GetExtensions())
        self._oldExtensions = extensionsService.CheckSumExtensions()  # wxBug:  need to make a copy now since the deepcopy reorders fields, so we must compare the prestine copy with the modified copy
        for extension in self._extensions:
            self._extListBox.Append(extension.menuItemName, extension)
        self._currentItem = None
        self._currentItemIndex = -1
        return len(self._extensions)


    def OnListBoxSelect(self, event=None):
        self.SaveCurrentItem()
        if self._extListBox.GetSelection() == wx.NOT_FOUND:
            self._currentItemIndex = -1
            self._currentItem = None
            self._deleteButton.Enable(False)
            self._moveUpButton.Enable(False)
            self._moveDownButton.Enable(False)
        else:
            self._currentItemIndex = self._extListBox.GetSelection()
            self._currentItem = self._extListBox.GetClientData(self._currentItemIndex)
            self._deleteButton.Enable()
            self._moveUpButton.Enable(self._extListBox.GetCount() > 1 and self._currentItemIndex > 0)
            self._moveDownButton.Enable(self._extListBox.GetCount() > 1 and self._currentItemIndex < self._extListBox.GetCount() - 1)
        self.LoadItem(self._currentItem)


    def SaveCurrentItem(self, event=None):
        extension = self._currentItem
        if extension:
            if extension.menuItemName != self._menuItemNameTextCtrl.GetValue():
                extension.menuItemName = self._menuItemNameTextCtrl.GetValue()
                self._extListBox.SetString(self._currentItemIndex, extension.menuItemName)
            extension.menuItemDesc = self._menuItemDescTextCtrl.GetValue()
            extension.command = self._commandTextCtrl.GetValue()
            extension.commandPreArgs = self._commandPreArgsTextCtrl.GetValue()
            extension.commandPostArgs = self._commandPostArgsTextCtrl.GetValue()
            fileExt = self._fileExtTextCtrl.GetValue().replace(' ','')
            if not fileExt:
                extension.fileExt = None
            else:
                extension.fileExt = fileExt.split(',')
            extension.opOnSelectedFile = self._selFileCtrl.GetValue()


    def LoadItem(self, extension):
        if extension:
            self._menuItemDescTextCtrl.SetValue(extension.menuItemDesc or '')
            self._commandTextCtrl.SetValue(extension.command or '')
            self._commandTextCtrl.SetToolTipString(extension.command or '')
            self._commandPreArgsTextCtrl.SetValue(extension.commandPreArgs or '')
            self._commandPostArgsTextCtrl.SetValue(extension.commandPostArgs or '')
            if extension.fileExt:
                list = ""
                for ext in extension.fileExt:
                    if list:
                        list = list + ", "
                    list = list + ext
                self._fileExtTextCtrl.SetValue(list)
            else:
                self._fileExtTextCtrl.SetValue('')
            self._selFileCtrl.SetValue(extension.opOnSelectedFile)
            self._menuItemNameTextCtrl.SetValue(extension.menuItemName or '')  # Do the name last since it triggers the write event that updates the entire item
            self._extDetailPanel.Enable()
        else:
            self._menuItemNameTextCtrl.SetValue('')
            self._menuItemDescTextCtrl.SetValue('')
            self._commandTextCtrl.SetValue('')
            self._commandTextCtrl.SetToolTipString(_("Path to executable"))
            self._commandPreArgsTextCtrl.SetValue('')
            self._commandPostArgsTextCtrl.SetValue('')
            self._fileExtTextCtrl.SetValue('')
            self._selFileCtrl.SetValue(True)
            self._extDetailPanel.Enable(False)


    def OnAdd(self, event):
        self.SaveCurrentItem()
        name = _("Untitled")
        count = 1
        while self._extListBox.FindString(name) != wx.NOT_FOUND:
            count = count + 1
            name = _("Untitled%s") % count
        extension = Extension(name)
        self._extensions.append(extension)
        self._extListBox.Append(extension.menuItemName, extension)
        self._extListBox.SetStringSelection(extension.menuItemName)
        self.OnListBoxSelect()
        self._menuItemNameTextCtrl.SetFocus()
        self._menuItemNameTextCtrl.SetSelection(-1, -1)


    def OnDelete(self, event):
        self._extListBox.Delete(self._currentItemIndex)
        self._extensions.remove(self._currentItem)
        self._currentItemIndex = min(self._currentItemIndex, self._extListBox.GetCount() - 1)
        if self._currentItemIndex > -1:
            self._extListBox.SetSelection(self._currentItemIndex)
        self._currentItem = None  # Don't update it since it no longer exists
        self.OnListBoxSelect()


    def OnMoveUp(self, event):
        itemAboveString = self._extListBox.GetString(self._currentItemIndex - 1)
        itemAboveData = self._extListBox.GetClientData(self._currentItemIndex - 1)
        self._extListBox.Delete(self._currentItemIndex - 1)
        self._extListBox.Insert(itemAboveString, self._currentItemIndex)
        self._extListBox.SetClientData(self._currentItemIndex, itemAboveData)
        self._currentItemIndex = self._currentItemIndex - 1
        self.OnListBoxSelect() # Reset buttons


    def OnMoveDown(self, event):
        itemBelowString = self._extListBox.GetString(self._currentItemIndex + 1)
        itemBelowData = self._extListBox.GetClientData(self._currentItemIndex + 1)
        self._extListBox.Delete(self._currentItemIndex + 1)
        self._extListBox.Insert(itemBelowString, self._currentItemIndex)
        self._extListBox.SetClientData(self._currentItemIndex, itemBelowData)
        self._currentItemIndex = self._currentItemIndex + 1
        self.OnListBoxSelect() # Reset buttons
Commit	Line	Data
2eeaec19 RD	1	#----------------------------------------------------------------------------
	2	# Name: ExtensionService.py
	3	# Purpose: Extension Service for IDE
	4	#
	5	# Author: Peter Yared
	6	#
	7	# Created: 5/23/05
	8	# CVS-ID: $ID:$
aca310e5	9	# Copyright: (c) 2005-2006 ActiveGrid, Inc.
2eeaec19 RD	10	# License: wxWindows License
	11	#----------------------------------------------------------------------------
	12
	13	import wx
	14	import wx.lib.pydocview
	15	import MessageService
02b800ce	16	import ProjectEditor
2eeaec19 RD	17	import os
2eeaec19 RD	18	import os.path
02b800ce	19	import activegrid.util.xmlutils as xmlutils
2eeaec19 RD	20	_ = wx.GetTranslation
	21
	22
aca310e5 RD	23	#----------------------------------------------------------------------------
	24	# Constants
	25	#----------------------------------------------------------------------------
2eeaec19 RD	26	SPACE = 10
	27	HALF_SPACE = 5
	28
	29
2eeaec19 RD	30	#----------------------------------------------------------------------------
	31	# Classes
	32	#----------------------------------------------------------------------------
	33
	34	class Extension:
aca310e5	35
2eeaec19	36
02b800ce	37	def __init__(self, menuItemName=None):
2eeaec19 RD	38	self.menuItemName = menuItemName
	39	self.id = 0
	40	self.menuItemDesc = ''
	41	self.command = ''
	42	self.commandPreArgs = ''
	43	self.commandPostArgs = ''
	44	self.fileExt = None
02b800ce	45	self.opOnSelectedFile = True
aca310e5	46
2eeaec19 RD	47
	48	class ExtensionService(wx.lib.pydocview.DocService):
	49
02b800ce	50	EXTENSIONS_KEY = "/AG_Extensions"
2eeaec19 RD	51
	52	def __init__(self):
	53	self.LoadExtensions()
	54
	55
02b800ce RD	56	def __getExtensionKeyName(extensionName):
02b800ce RD	57	return "%s/%s" % (ExtensionService.EXTENSIONS_KEY, extensionName)
aca310e5 RD	58
aca310e5 RD	59
02b800ce RD	60	__getExtensionKeyName = staticmethod(__getExtensionKeyName)
	61
	62
2eeaec19	63	def LoadExtensions(self):
02b800ce RD	64	self._extensions = []
	65
	66	extensionNames = []
2eeaec19	67	config = wx.ConfigBase_Get()
02b800ce RD	68	path = config.GetPath()
	69	try:
	70	config.SetPath(ExtensionService.EXTENSIONS_KEY)
	71	cont, value, index = config.GetFirstEntry()
	72	while cont:
	73	extensionNames.append(value)
	74	cont, value, index = config.GetNextEntry(index)
	75	finally:
	76	config.SetPath(path)
aca310e5	77
02b800ce RD	78	for extensionName in extensionNames:
	79	extensionData = config.Read(self.__getExtensionKeyName(extensionName))
	80	if extensionData:
	81	extension = xmlutils.unmarshal(extensionData.encode('utf-8'))
	82	self._extensions.append(extension)
	83
2eeaec19 RD	84
	85	def SaveExtensions(self):
	86	config = wx.ConfigBase_Get()
02b800ce RD	87	config.DeleteGroup(ExtensionService.EXTENSIONS_KEY)
	88	for extension in self._extensions:
	89	config.Write(self.__getExtensionKeyName(extension.menuItemName), xmlutils.marshal(extension))
2eeaec19 RD	90
	91
	92	def GetExtensions(self):
	93	return self._extensions
	94
	95
	96	def SetExtensions(self, extensions):
	97	self._extensions = extensions
	98
	99
02b800ce RD	100	def CheckSumExtensions(self):
	101	return xmlutils.marshal(self._extensions)
	102
	103
2eeaec19 RD	104	def InstallControls(self, frame, menuBar = None, toolBar = None, statusBar = None, document = None):
	105	toolsMenuIndex = menuBar.FindMenu(_("&Tools"))
	106	if toolsMenuIndex > -1:
	107	toolsMenu = menuBar.GetMenu(toolsMenuIndex)
	108	else:
	109	toolsMenu = wx.Menu()
aca310e5	110
2eeaec19 RD	111	if self._extensions:
2eeaec19 RD	112	if toolsMenu.GetMenuItems():
aca310e5	113	toolsMenu.AppendSeparator()
2eeaec19 RD	114	for ext in self._extensions:
	115	# Append a tool menu item for each extension
	116	ext.id = wx.NewId()
	117	toolsMenu.Append(ext.id, ext.menuItemName)
	118	wx.EVT_MENU(frame, ext.id, frame.ProcessEvent)
	119	wx.EVT_UPDATE_UI(frame, ext.id, frame.ProcessUpdateUIEvent)
	120
	121	if toolsMenuIndex == -1:
02b800ce RD	122	index = menuBar.FindMenu(_("&Run"))
	123	if index == -1:
	124	index = menuBar.FindMenu(_("&Project"))
	125	if index == -1:
	126	index = menuBar.FindMenu(_("&Format"))
	127	if index == -1:
	128	index = menuBar.FindMenu(_("&View"))
	129	menuBar.Insert(index + 1, toolsMenu, _("&Tools"))
	130
2eeaec19 RD	131
	132	def ProcessEvent(self, event):
	133	id = event.GetId()
	134	for extension in self._extensions:
	135	if id == extension.id:
	136	self.OnExecuteExtension(extension)
	137	return True
	138	return False
	139
	140
	141	def ProcessUpdateUIEvent(self, event):
	142	id = event.GetId()
	143	for extension in self._extensions:
	144	if id == extension.id:
	145	if extension.fileExt:
	146	doc = wx.GetApp().GetDocumentManager().GetCurrentDocument()
	147	if doc and '*' in extension.fileExt:
	148	event.Enable(True)
	149	return True
	150	if doc:
	151	for fileExt in extension.fileExt:
	152	if fileExt in doc.GetDocumentTemplate().GetFileFilter():
	153	event.Enable(True)
	154	return True
02b800ce RD	155	if extension.opOnSelectedFile and isinstance(doc, ProjectEditor.ProjectDocument):
	156	filename = doc.GetFirstView().GetSelectedFile()
	157	if filename:
	158	template = wx.GetApp().GetDocumentManager().FindTemplateForPath(filename)
	159	for fileExt in extension.fileExt:
	160	if fileExt in template.GetFileFilter():
	161	event.Enable(True)
	162	return True
2eeaec19 RD	163	event.Enable(False)
	164	return False
	165	return False
	166
	167
	168	def OnExecuteExtension(self, extension):
	169	if extension.fileExt:
	170	doc = wx.GetApp().GetDocumentManager().GetCurrentDocument()
	171	if not doc:
	172	return
02b800ce RD	173	if extension.opOnSelectedFile and isinstance(doc, ProjectEditor.ProjectDocument):
	174	filename = doc.GetFirstView().GetSelectedFile()
	175	if not filename:
	176	filename = doc.GetFilename()
	177	else:
	178	filename = doc.GetFilename()
2eeaec19 RD	179	ext = os.path.splitext(filename)[1]
	180	if not '*' in extension.fileExt:
	181	if not ext or ext[1:] not in extension.fileExt:
	182	return
	183	cmds = [extension.command]
	184	if extension.commandPreArgs:
	185	cmds.append(extension.commandPreArgs)
	186	cmds.append(filename)
	187	if extension.commandPostArgs:
	188	cmds.append(extension.commandPostArgs)
	189	os.spawnv(os.P_NOWAIT, extension.command, cmds)
aca310e5	190
2eeaec19 RD	191	else:
	192	cmd = extension.command
	193	if extension.commandPreArgs:
	194	cmd = cmd + ' ' + extension.commandPreArgs
	195	if extension.commandPostArgs:
	196	cmd = cmd + ' ' + extension.commandPostArgs
	197	f = os.popen(cmd)
	198	messageService = wx.GetApp().GetService(MessageService.MessageService)
	199	messageService.ShowWindow()
	200	view = messageService.GetView()
	201	for line in f.readlines():
	202	view.AddLines(line)
	203	view.GetControl().EnsureCaretVisible()
	204	f.close()
aca310e5	205
2eeaec19 RD	206
	207	class ExtensionOptionsPanel(wx.Panel):
	208
	209
	210	def __init__(self, parent, id):
	211	wx.Panel.__init__(self, parent, id)
aca310e5	212
02b800ce	213	extOptionsPanelBorderSizer = wx.BoxSizer(wx.VERTICAL)
aca310e5	214
02b800ce	215	extOptionsPanelSizer = wx.BoxSizer(wx.HORIZONTAL)
aca310e5	216
2eeaec19	217	extCtrlSizer = wx.BoxSizer(wx.VERTICAL)
02b800ce	218	extCtrlSizer.Add(wx.StaticText(self, -1, _("External Tools:")), 0, wx.BOTTOM, HALF_SPACE)
aca310e5	219	self._extListBox = wx.ListBox(self, -1, style=wx.LB_SINGLE)
2eeaec19	220	self.Bind(wx.EVT_LISTBOX, self.OnListBoxSelect, self._extListBox)
aca310e5 RD	221	extCtrlSizer.Add(self._extListBox, 1, wx.BOTTOM \| wx.EXPAND, SPACE)
aca310e5 RD	222	buttonSizer = wx.GridSizer(cols=2, vgap=HALF_SPACE, hgap=HALF_SPACE)
2eeaec19 RD	223	self._moveUpButton = wx.Button(self, -1, _("Move Up"))
2eeaec19 RD	224	self.Bind(wx.EVT_BUTTON, self.OnMoveUp, self._moveUpButton)
02b800ce	225	buttonSizer.Add(self._moveUpButton, 1, wx.EXPAND)
2eeaec19 RD	226	self._moveDownButton = wx.Button(self, -1, _("Move Down"))
2eeaec19 RD	227	self.Bind(wx.EVT_BUTTON, self.OnMoveDown, self._moveDownButton)
02b800ce RD	228	buttonSizer.Add(self._moveDownButton, 1, wx.EXPAND)
02b800ce RD	229	self._addButton = wx.Button(self, wx.ID_ADD)
2eeaec19	230	self.Bind(wx.EVT_BUTTON, self.OnAdd, self._addButton)
02b800ce RD	231	buttonSizer.Add(self._addButton, 1, wx.EXPAND)
02b800ce RD	232	self._deleteButton = wx.Button(self, wx.ID_DELETE, label=_("Delete")) # get rid of accelerator for letter d in "&Delete"
2eeaec19	233	self.Bind(wx.EVT_BUTTON, self.OnDelete, self._deleteButton)
02b800ce	234	buttonSizer.Add(self._deleteButton, 1, wx.EXPAND)
2eeaec19	235	extCtrlSizer.Add(buttonSizer, 0, wx.ALIGN_CENTER)
02b800ce	236	extOptionsPanelSizer.Add(extCtrlSizer, 0, wx.EXPAND)
2eeaec19 RD	237
2eeaec19 RD	238	self._extDetailPanel = wx.Panel(self)
02b800ce RD	239	staticBox = wx.StaticBox(self, label=_("Selected External Tool"))
02b800ce RD	240	staticBoxSizer = wx.StaticBoxSizer(staticBox, wx.VERTICAL)
aca310e5 RD	241
aca310e5 RD	242	extDetailSizer = wx.FlexGridSizer(cols=2, vgap=5, hgap=5)
02b800ce	243	extDetailSizer.AddGrowableCol(1,1)
2eeaec19	244
aca310e5	245	extDetailSizer.Add(wx.StaticText(self._extDetailPanel, -1, _("Menu Item Name:")), flag=wx.ALIGN_CENTER_VERTICAL)
2eeaec19	246	self._menuItemNameTextCtrl = wx.TextCtrl(self._extDetailPanel, -1, size = (-1, -1))
02b800ce	247	extDetailSizer.Add(self._menuItemNameTextCtrl, 0, wx.EXPAND)
aca310e5	248	self.Bind(wx.EVT_TEXT, self.SaveCurrentItem, self._menuItemNameTextCtrl)
2eeaec19	249
aca310e5	250	extDetailSizer.Add(wx.StaticText(self._extDetailPanel, -1, _("Menu Item Description:")), flag=wx.ALIGN_CENTER_VERTICAL)
2eeaec19	251	self._menuItemDescTextCtrl = wx.TextCtrl(self._extDetailPanel, -1, size = (-1, -1))
02b800ce	252	extDetailSizer.Add(self._menuItemDescTextCtrl, 0, wx.EXPAND)
2eeaec19	253
aca310e5 RD	254	extDetailSizer.Add(wx.StaticText(self._extDetailPanel, -1, _("Command Path:")), flag=wx.ALIGN_CENTER_VERTICAL)
aca310e5 RD	255	self._commandTextCtrl = wx.TextCtrl(self._extDetailPanel, -1, size = (-1, -1))
2eeaec19 RD	256	findFileButton = wx.Button(self._extDetailPanel, -1, _("Browse..."))
2eeaec19 RD	257	def OnBrowseButton(event):
02b800ce	258	fileDlg = wx.FileDialog(self, _("Choose an Executable:"), style=wx.OPEN\|wx.FILE_MUST_EXIST\|wx.HIDE_READONLY\|wx.CHANGE_DIR)
2eeaec19 RD	259	path = self._commandTextCtrl.GetValue()
	260	if path:
	261	fileDlg.SetPath(path)
02b800ce	262	# fileDlg.CenterOnParent() # wxBug: caused crash with wx.FileDialog
2eeaec19 RD	263	if fileDlg.ShowModal() == wx.ID_OK:
	264	self._commandTextCtrl.SetValue(fileDlg.GetPath())
	265	self._commandTextCtrl.SetInsertionPointEnd()
02b800ce	266	self._commandTextCtrl.SetToolTipString(fileDlg.GetPath())
2eeaec19 RD	267	fileDlg.Destroy()
	268	wx.EVT_BUTTON(findFileButton, -1, OnBrowseButton)
	269	hsizer = wx.BoxSizer(wx.HORIZONTAL)
	270	hsizer.Add(self._commandTextCtrl, 1, wx.EXPAND)
	271	hsizer.Add(findFileButton, 0, wx.LEFT, HALF_SPACE)
02b800ce	272	extDetailSizer.Add(hsizer, 0, wx.EXPAND)
2eeaec19	273
aca310e5	274	extDetailSizer.Add(wx.StaticText(self._extDetailPanel, -1, _("Command Pre Args:")), flag=wx.ALIGN_CENTER_VERTICAL)
2eeaec19	275	self._commandPreArgsTextCtrl = wx.TextCtrl(self._extDetailPanel, -1, size = (-1, -1))
02b800ce	276	extDetailSizer.Add(self._commandPreArgsTextCtrl, 0, wx.EXPAND)
2eeaec19	277
aca310e5	278	extDetailSizer.Add(wx.StaticText(self._extDetailPanel, -1, _("Command Post Args:")), flag=wx.ALIGN_CENTER_VERTICAL)
2eeaec19	279	self._commandPostArgsTextCtrl = wx.TextCtrl(self._extDetailPanel, -1, size = (-1, -1))
02b800ce	280	extDetailSizer.Add(self._commandPostArgsTextCtrl, 0, wx.EXPAND)
2eeaec19	281
aca310e5	282	extDetailSizer.Add(wx.StaticText(self._extDetailPanel, -1, _("File Extensions:")), flag=wx.ALIGN_CENTER_VERTICAL)
2eeaec19	283	self._fileExtTextCtrl = wx.TextCtrl(self._extDetailPanel, -1, size = (-1, -1))
02b800ce RD	284	self._fileExtTextCtrl.SetToolTipString(_("""For example: "txt, text" (comma separated) or "*" for all files"""))
02b800ce RD	285	extDetailSizer.Add(self._fileExtTextCtrl, 0, wx.EXPAND)
2eeaec19	286
02b800ce	287	self._selFileCtrl = wx.CheckBox(self._extDetailPanel, -1, _("Operate on Selected File"))
aca310e5	288	extDetailSizer.Add(self._selFileCtrl, 0, wx.ALIGN_CENTER_VERTICAL\|wx.TOP, SPACE)
02b800ce	289	self._selFileCtrl.SetToolTipString(_("If focus is in the project, instead of operating on the project file, operate on the selected file."))
2eeaec19	290
02b800ce RD	291	self._extDetailPanel.SetSizer(extDetailSizer)
02b800ce RD	292	staticBoxSizer.Add(self._extDetailPanel, 1, wx.ALL\|wx.EXPAND, SPACE)
aca310e5	293
02b800ce RD	294	extOptionsPanelSizer.Add(staticBoxSizer, 1, wx.LEFT\|wx.EXPAND, SPACE)
	295
	296	extOptionsPanelBorderSizer.Add(extOptionsPanelSizer, 1, wx.ALL\|wx.EXPAND, SPACE)
	297	self.SetSizer(extOptionsPanelBorderSizer)
	298
2eeaec19 RD	299	if self.PopulateItems():
2eeaec19 RD	300	self._extListBox.SetSelection(0)
02b800ce RD	301	self.OnListBoxSelect()
	302
	303	self.Layout()
aca310e5 RD	304
aca310e5 RD	305	parent.AddPage(self, _("External Tools"))
2eeaec19 RD	306
	307
	308	def OnOK(self, optionsDialog):
	309	self.SaveCurrentItem()
	310	extensionsService = wx.GetApp().GetService(ExtensionService)
2eeaec19 RD	311	extensionsService.SetExtensions(self._extensions)
2eeaec19 RD	312	extensionsService.SaveExtensions()
02b800ce	313	if extensionsService.CheckSumExtensions() != self._oldExtensions: # see PopulateItems() note about self._oldExtensions
2eeaec19 RD	314	msgTitle = wx.GetApp().GetAppName()
	315	if not msgTitle:
	316	msgTitle = _("Document Options")
	317	wx.MessageBox(_("Extension changes will not appear until the application is restarted."),
	318	msgTitle,
	319	wx.OK \| wx.ICON_INFORMATION,
	320	self.GetParent())
aca310e5	321
2eeaec19 RD	322
	323	def PopulateItems(self):
	324	extensionsService = wx.GetApp().GetService(ExtensionService)
	325	import copy
	326	self._extensions = copy.deepcopy(extensionsService.GetExtensions())
02b800ce	327	self._oldExtensions = extensionsService.CheckSumExtensions() # wxBug: need to make a copy now since the deepcopy reorders fields, so we must compare the prestine copy with the modified copy
2eeaec19 RD	328	for extension in self._extensions:
	329	self._extListBox.Append(extension.menuItemName, extension)
	330	self._currentItem = None
	331	self._currentItemIndex = -1
	332	return len(self._extensions)
aca310e5	333
2eeaec19	334
02b800ce	335	def OnListBoxSelect(self, event=None):
2eeaec19	336	self.SaveCurrentItem()
02b800ce	337	if self._extListBox.GetSelection() == wx.NOT_FOUND:
2eeaec19 RD	338	self._currentItemIndex = -1
	339	self._currentItem = None
	340	self._deleteButton.Enable(False)
	341	self._moveUpButton.Enable(False)
	342	self._moveDownButton.Enable(False)
	343	else:
	344	self._currentItemIndex = self._extListBox.GetSelection()
	345	self._currentItem = self._extListBox.GetClientData(self._currentItemIndex)
	346	self._deleteButton.Enable()
	347	self._moveUpButton.Enable(self._extListBox.GetCount() > 1 and self._currentItemIndex > 0)
	348	self._moveDownButton.Enable(self._extListBox.GetCount() > 1 and self._currentItemIndex < self._extListBox.GetCount() - 1)
	349	self.LoadItem(self._currentItem)
	350
	351
	352	def SaveCurrentItem(self, event=None):
	353	extension = self._currentItem
	354	if extension:
	355	if extension.menuItemName != self._menuItemNameTextCtrl.GetValue():
	356	extension.menuItemName = self._menuItemNameTextCtrl.GetValue()
	357	self._extListBox.SetString(self._currentItemIndex, extension.menuItemName)
	358	extension.menuItemDesc = self._menuItemDescTextCtrl.GetValue()
	359	extension.command = self._commandTextCtrl.GetValue()
	360	extension.commandPreArgs = self._commandPreArgsTextCtrl.GetValue()
	361	extension.commandPostArgs = self._commandPostArgsTextCtrl.GetValue()
	362	fileExt = self._fileExtTextCtrl.GetValue().replace(' ','')
	363	if not fileExt:
	364	extension.fileExt = None
	365	else:
	366	extension.fileExt = fileExt.split(',')
02b800ce	367	extension.opOnSelectedFile = self._selFileCtrl.GetValue()
aca310e5	368
2eeaec19 RD	369
	370	def LoadItem(self, extension):
	371	if extension:
	372	self._menuItemDescTextCtrl.SetValue(extension.menuItemDesc or '')
	373	self._commandTextCtrl.SetValue(extension.command or '')
02b800ce	374	self._commandTextCtrl.SetToolTipString(extension.command or '')
2eeaec19 RD	375	self._commandPreArgsTextCtrl.SetValue(extension.commandPreArgs or '')
	376	self._commandPostArgsTextCtrl.SetValue(extension.commandPostArgs or '')
	377	if extension.fileExt:
02b800ce RD	378	list = ""
	379	for ext in extension.fileExt:
	380	if list:
	381	list = list + ", "
	382	list = list + ext
	383	self._fileExtTextCtrl.SetValue(list)
2eeaec19 RD	384	else:
2eeaec19 RD	385	self._fileExtTextCtrl.SetValue('')
02b800ce	386	self._selFileCtrl.SetValue(extension.opOnSelectedFile)
2eeaec19 RD	387	self._menuItemNameTextCtrl.SetValue(extension.menuItemName or '') # Do the name last since it triggers the write event that updates the entire item
	388	self._extDetailPanel.Enable()
	389	else:
	390	self._menuItemNameTextCtrl.SetValue('')
	391	self._menuItemDescTextCtrl.SetValue('')
	392	self._commandTextCtrl.SetValue('')
02b800ce	393	self._commandTextCtrl.SetToolTipString(_("Path to executable"))
2eeaec19 RD	394	self._commandPreArgsTextCtrl.SetValue('')
	395	self._commandPostArgsTextCtrl.SetValue('')
	396	self._fileExtTextCtrl.SetValue('')
02b800ce	397	self._selFileCtrl.SetValue(True)
2eeaec19	398	self._extDetailPanel.Enable(False)
aca310e5 RD	399
aca310e5 RD	400
2eeaec19 RD	401	def OnAdd(self, event):
2eeaec19 RD	402	self.SaveCurrentItem()
2eeaec19 RD	403	name = _("Untitled")
2eeaec19 RD	404	count = 1
02b800ce	405	while self._extListBox.FindString(name) != wx.NOT_FOUND:
2eeaec19	406	count = count + 1
02b800ce	407	name = _("Untitled%s") % count
2eeaec19 RD	408	extension = Extension(name)
	409	self._extensions.append(extension)
	410	self._extListBox.Append(extension.menuItemName, extension)
02b800ce RD	411	self._extListBox.SetStringSelection(extension.menuItemName)
02b800ce RD	412	self.OnListBoxSelect()
2eeaec19 RD	413	self._menuItemNameTextCtrl.SetFocus()
2eeaec19 RD	414	self._menuItemNameTextCtrl.SetSelection(-1, -1)
aca310e5	415
2eeaec19 RD	416
	417	def OnDelete(self, event):
	418	self._extListBox.Delete(self._currentItemIndex)
aca310e5	419	self._extensions.remove(self._currentItem)
2eeaec19 RD	420	self._currentItemIndex = min(self._currentItemIndex, self._extListBox.GetCount() - 1)
	421	if self._currentItemIndex > -1:
	422	self._extListBox.SetSelection(self._currentItemIndex)
	423	self._currentItem = None # Don't update it since it no longer exists
02b800ce	424	self.OnListBoxSelect()
2eeaec19 RD	425
	426
	427	def OnMoveUp(self, event):
	428	itemAboveString = self._extListBox.GetString(self._currentItemIndex - 1)
	429	itemAboveData = self._extListBox.GetClientData(self._currentItemIndex - 1)
	430	self._extListBox.Delete(self._currentItemIndex - 1)
	431	self._extListBox.Insert(itemAboveString, self._currentItemIndex)
	432	self._extListBox.SetClientData(self._currentItemIndex, itemAboveData)
	433	self._currentItemIndex = self._currentItemIndex - 1
02b800ce	434	self.OnListBoxSelect() # Reset buttons
2eeaec19 RD	435
	436
	437	def OnMoveDown(self, event):
	438	itemBelowString = self._extListBox.GetString(self._currentItemIndex + 1)
	439	itemBelowData = self._extListBox.GetClientData(self._currentItemIndex + 1)
	440	self._extListBox.Delete(self._currentItemIndex + 1)
	441	self._extListBox.Insert(itemBelowString, self._currentItemIndex)
	442	self._extListBox.SetClientData(self._currentItemIndex, itemBelowData)
	443	self._currentItemIndex = self._currentItemIndex + 1
02b800ce	444	self.OnListBoxSelect() # Reset buttons