gmodeler.py 57 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678
  1. """!
  2. @package gmodeler.py
  3. @brief Graphical modeler to create edit, and manage models
  4. Classes:
  5. - ModelFrame
  6. - ModelCanvas
  7. - ModelAction
  8. - ModelSearchDialog
  9. - ModelData
  10. - ModelDataDialog
  11. - ProcessModelFile
  12. - WriteModelFile
  13. (C) 2010 by the GRASS Development Team
  14. This program is free software under the GNU General Public License
  15. (>=v2). Read the file COPYING that comes with GRASS for details.
  16. @author Martin Landa <landa.martin gmail.com>
  17. """
  18. import os
  19. import sys
  20. import shlex
  21. import time
  22. import traceback
  23. import getpass
  24. import stat
  25. import textwrap
  26. try:
  27. import xml.etree.ElementTree as etree
  28. except ImportError:
  29. import elementtree.ElementTree as etree # Python <= 2.4
  30. import globalvar
  31. if not os.getenv("GRASS_WXBUNDLED"):
  32. globalvar.CheckForWx()
  33. import wx
  34. import wx.lib.ogl as ogl
  35. import wx.lib.flatnotebook as FN
  36. import menu
  37. import menudata
  38. import toolbars
  39. import menuform
  40. import prompt
  41. import utils
  42. import goutput
  43. import gselect
  44. from debug import Debug
  45. from gcmd import GMessage
  46. from gdialogs import ElementDialog
  47. from gdialogs import GetImageHandlers
  48. from grass.script import core as grass
  49. class ModelFrame(wx.Frame):
  50. def __init__(self, parent, id = wx.ID_ANY, title = _("Graphical modeler (under development)"), **kwargs):
  51. """!Graphical modeler main window
  52. @param parent parent window
  53. @param id window id
  54. @param title window title
  55. @param kwargs wx.Frames' arguments
  56. """
  57. self.parent = parent
  58. self.searchDialog = None # module search dialog
  59. self.actions = list() # list of recorded actions
  60. self.data = list() # list of recorded data items
  61. self.baseTitle = title
  62. self.modelFile = None # loaded model
  63. self.modelChanged = False
  64. self.cursors = {
  65. "default" : wx.StockCursor(wx.CURSOR_ARROW),
  66. "cross" : wx.StockCursor(wx.CURSOR_CROSS),
  67. }
  68. wx.Frame.__init__(self, parent = parent, id = id, title = title, **kwargs)
  69. self.SetName("Modeler")
  70. self.SetIcon(wx.Icon(os.path.join(globalvar.ETCICONDIR, 'grass.ico'), wx.BITMAP_TYPE_ICO))
  71. self.menubar = menu.Menu(parent = self, data = menudata.ModelerData())
  72. self.SetMenuBar(self.menubar)
  73. self.toolbar = toolbars.ModelToolbar(parent = self)
  74. self.SetToolBar(self.toolbar)
  75. self.statusbar = self.CreateStatusBar(number = 1)
  76. self.notebook = FN.FlatNotebook(parent = self, id = wx.ID_ANY,
  77. style = FN.FNB_FANCY_TABS | FN.FNB_BOTTOM |
  78. FN.FNB_NO_NAV_BUTTONS | FN.FNB_NO_X_BUTTON)
  79. self.canvas = ModelCanvas(self)
  80. self.canvas.SetBackgroundColour(wx.WHITE)
  81. self.canvas.SetCursor(self.cursors["default"])
  82. self.goutput = goutput.GMConsole(parent = self, pageid = 1)
  83. self.modelPage = self.notebook.AddPage(self.canvas, text=_('Model'))
  84. self.commandPage = self.notebook.AddPage(self.goutput, text=_('Command output'))
  85. wx.CallAfter(self.notebook.SetSelection, 0)
  86. self.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
  87. self._layout()
  88. self.SetMinSize((350, 200))
  89. self.SetSize((640, 480))
  90. # fix goutput's pane size
  91. if self.goutput:
  92. self.goutput.SetSashPosition(int(self.GetSize()[1] * .75))
  93. def _layout(self):
  94. """!Do layout"""
  95. sizer = wx.BoxSizer(wx.VERTICAL)
  96. sizer.Add(item = self.notebook, proportion = 1,
  97. flag = wx.EXPAND)
  98. self.SetAutoLayout(True)
  99. self.SetSizer(sizer)
  100. sizer.Fit(self)
  101. self.Layout()
  102. def _addEvent(self, item):
  103. """!Add event to item"""
  104. evthandler = ModelEvtHandler(self.statusbar,
  105. self)
  106. evthandler.SetShape(item)
  107. evthandler.SetPreviousHandler(item.GetEventHandler())
  108. item.SetEventHandler(evthandler)
  109. def FindAction(self, id):
  110. """!Find action by id"""
  111. for action in self.actions:
  112. if action.GetId() == id:
  113. return action
  114. return None
  115. def FindData(self, value, prompt):
  116. """!Find data by value, and prompt"""
  117. for data in self.data:
  118. if data.GetValue() == value and \
  119. data.GetPrompt() == prompt:
  120. return data
  121. return None
  122. def ModelChanged(self):
  123. """!Update window title"""
  124. if not self.modelChanged:
  125. self.modelChanged = True
  126. if self.modelFile:
  127. self.SetTitle(self.baseTitle + " - " + os.path.basename(self.modelFile) + '*')
  128. def OnCloseWindow(self, event):
  129. """!Close window"""
  130. self.Destroy()
  131. def OnDeleteData(self, event):
  132. """!Delete intermediate data"""
  133. rast = list()
  134. rast3d = list()
  135. vect = list()
  136. for data in self.data:
  137. if not data.IsIntermediate():
  138. continue
  139. name = data.GetValue()
  140. prompt = data.GetPrompt()
  141. if prompt == 'raster':
  142. rast.append(name)
  143. elif prompt == 'vector':
  144. vect.append(name)
  145. elif prompt == 'rast3d':
  146. rast3d.append(name)
  147. if not rast and not vect and not rast3d:
  148. GMessage(parent = self,
  149. message = _('Nothing to delete.'),
  150. msgType = 'info')
  151. return
  152. msg = ''
  153. if rast:
  154. msg += '\n\n%s: ' % _('Raster maps')
  155. msg += ', '.join(rast)
  156. if rast3d:
  157. msg += '\n\n%s: ' % _('3D raster maps')
  158. msg += ', '.join(rast3d)
  159. if vect:
  160. msg += '\n\n%s: ' % _('Vector maps')
  161. msg += ', '.join(vect)
  162. dlg = wx.MessageDialog(parent = self,
  163. message= _("Do you want to permanently delete data?%s" % msg),
  164. caption=_("Delete intermediate data?"),
  165. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION)
  166. ret = dlg.ShowModal()
  167. if ret == wx.ID_YES:
  168. dlg.Destroy()
  169. if rast:
  170. self.goutput.RunCmd(['g.remove', 'rast=%s' %','.join(rast)])
  171. if rast3d:
  172. self.goutput.RunCmd(['g.remove', 'rast3d=%s' %','.join(rast3d)])
  173. if vect:
  174. self.goutput.RunCmd(['g.remove', 'vect=%s' %','.join(vect)])
  175. self.SetStatusText(_("%d maps deleted from current mapset") % \
  176. int(len(rast) + len(rast3d) + len(vect)))
  177. return
  178. dlg.Destroy()
  179. def OnModelNew(self, event):
  180. """!Create new model"""
  181. Debug.msg(4, "ModelFrame.OnModelNew():")
  182. # ask user to save current model
  183. if self.modelFile and self.modelChanged:
  184. self.OnModelSave()
  185. elif self.modelFile is None and \
  186. (len(self.actions) > 0 or len(self.data) > 0):
  187. dlg = wx.MessageDialog(self, message=_("Current model is not empty. "
  188. "Do you want to store current settings "
  189. "to model file?"),
  190. caption=_("Create new model?"),
  191. style=wx.YES_NO | wx.YES_DEFAULT |
  192. wx.CANCEL | wx.ICON_QUESTION)
  193. ret = dlg.ShowModal()
  194. if ret == wx.ID_YES:
  195. self.OnModelSaveAs()
  196. elif ret == wx.ID_CANCEL:
  197. dlg.Destroy()
  198. return
  199. dlg.Destroy()
  200. # delete all items
  201. self.canvas.GetDiagram().DeleteAllShapes()
  202. self.actions = list()
  203. self.data = list()
  204. self.canvas.Refresh()
  205. # no model file loaded
  206. self.modelFile = None
  207. self.modelChanged = False
  208. self.SetTitle(self.baseTitle)
  209. def OnModelOpen(self, event):
  210. """!Load model from file"""
  211. filename = ''
  212. dlg = wx.FileDialog(parent = self, message=_("Choose model file"),
  213. defaultDir = os.getcwd(),
  214. wildcard=_("GRASS Model File (*.gxm)|*.gxm"))
  215. if dlg.ShowModal() == wx.ID_OK:
  216. filename = dlg.GetPath()
  217. if not filename:
  218. return
  219. Debug.msg(4, "ModelFrame.OnModelOpen(): filename=%s" % filename)
  220. # close current model
  221. self.OnModelClose()
  222. self.LoadModelFile(filename)
  223. self.modelFile = filename
  224. self.SetTitle(self.baseTitle + " - " + os.path.basename(self.modelFile))
  225. self.SetStatusText(_('%d actions loaded into model') % len(self.actions), 0)
  226. def OnModelSave(self, event = None):
  227. """!Save model to file"""
  228. if self.modelFile and self.modelChanged:
  229. dlg = wx.MessageDialog(self, message=_("Model file <%s> already exists. "
  230. "Do you want to overwrite this file?") % \
  231. self.modelFile,
  232. caption=_("Save model"),
  233. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION)
  234. if dlg.ShowModal() == wx.ID_NO:
  235. dlg.Destroy()
  236. else:
  237. Debug.msg(4, "ModelFrame.OnModelSave(): filename=%s" % self.modelFile)
  238. self.WriteModelFile(self.modelFile)
  239. self.SetStatusText(_('File <%s> saved') % self.modelFile, 0)
  240. elif not self.modelFile:
  241. self.OnModelSaveAs(None)
  242. def OnModelSaveAs(self, event):
  243. """!Create model to file as"""
  244. filename = ''
  245. dlg = wx.FileDialog(parent = self,
  246. message = _("Choose file to save current model"),
  247. defaultDir = os.getcwd(),
  248. wildcard=_("GRASS Model File (*.gxm)|*.gxm"),
  249. style=wx.FD_SAVE)
  250. if dlg.ShowModal() == wx.ID_OK:
  251. filename = dlg.GetPath()
  252. if not filename:
  253. return
  254. # check for extension
  255. if filename[-4:] != ".gxm":
  256. filename += ".gxm"
  257. if os.path.exists(filename):
  258. dlg = wx.MessageDialog(parent = self,
  259. message=_("Model file <%s> already exists. "
  260. "Do you want to overwrite this file?") % filename,
  261. caption=_("File already exists"),
  262. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION)
  263. if dlg.ShowModal() != wx.ID_YES:
  264. dlg.Destroy()
  265. return
  266. Debug.msg(4, "GMFrame.OnModelSaveAs(): filename=%s" % filename)
  267. self.WriteModelFile(filename)
  268. self.modelFile = filename
  269. self.SetTitle(self.baseTitle + " - " + os.path.basename(self.modelFile))
  270. self.SetStatusText(_('File <%s> saved') % self.modelFile, 0)
  271. def OnModelClose(self, event = None):
  272. """!Close model file"""
  273. Debug.msg(4, "ModelFrame.OnModelClose(): file=%s" % self.modelFile)
  274. # ask user to save current model
  275. if self.modelFile and self.modelChanged:
  276. self.OnModelSave()
  277. elif self.modelFile is None and \
  278. (len(self.actions) > 0 or len(self.data) > 0):
  279. dlg = wx.MessageDialog(self, message=_("Current model is not empty. "
  280. "Do you want to store current settings "
  281. "to model file?"),
  282. caption=_("Create new model?"),
  283. style=wx.YES_NO | wx.YES_DEFAULT |
  284. wx.CANCEL | wx.ICON_QUESTION)
  285. ret = dlg.ShowModal()
  286. if ret == wx.ID_YES:
  287. self.OnModelSaveAs()
  288. elif ret == wx.ID_CANCEL:
  289. dlg.Destroy()
  290. return
  291. dlg.Destroy()
  292. self.modelFile = None
  293. self.SetTitle(self.baseTitle)
  294. self.canvas.GetDiagram().DeleteAllShapes()
  295. self.actions = list()
  296. self.data = list()
  297. self.canvas.Refresh()
  298. def OnRunModel(self, event):
  299. """!Run entire model"""
  300. if len(self.actions) < 1:
  301. GMessage(parent = self,
  302. message = _('Model is empty. Nothing to run.'),
  303. msgType = 'info')
  304. return
  305. errList = self._validateModel()
  306. if errList:
  307. dlg = wx.MessageDialog(parent = self,
  308. message = _('Model is not valid. Do you want to '
  309. 'run the model anyway?\n\n%s') % '\n'.join(errList),
  310. caption=_("Run model?"),
  311. style = wx.YES_NO | wx.NO_DEFAULT |
  312. wx.ICON_QUESTION | wx.CENTRE)
  313. ret = dlg.ShowModal()
  314. if ret != wx.ID_YES:
  315. return
  316. for action in self.actions:
  317. self.SetStatusText(_('Running model...'), 0)
  318. self.goutput.RunCmd(command = action.GetLog(string = False),
  319. onDone = self.OnDone)
  320. def OnDone(self, returncode):
  321. """!Computation finished"""
  322. self.SetStatusText('', 0)
  323. def OnValidateModel(self, event, showMsg = True):
  324. """!Validate entire model"""
  325. if len(self.actions) < 1:
  326. GMessage(parent = self,
  327. message = _('Model is empty. Nothing to validate.'),
  328. msgType = 'info')
  329. return
  330. errList = self._validateModel()
  331. if errList:
  332. GMessage(parent = self,
  333. message = _('Model is not valid.\n\n%s') % '\n'.join(errList),
  334. msgType = 'warning')
  335. else:
  336. GMessage(parent = self,
  337. message = _('Model is valid.'),
  338. msgType = 'info')
  339. def OnExportImage(self, event):
  340. """!Export model to image (default image)
  341. """
  342. xminImg = 0
  343. xmaxImg = 0
  344. yminImg = 0
  345. ymaxImg = 0
  346. for shape in self.canvas.GetDiagram().GetShapeList():
  347. w, h = shape.GetBoundingBoxMax()
  348. x = shape.GetX()
  349. y = shape.GetY()
  350. xmin = x - w / 2
  351. xmax = x + w / 2
  352. ymin = y - h / 2
  353. ymax = y + h / 2
  354. if xmin < xminImg:
  355. xminImg = xmin
  356. if xmax > xmaxImg:
  357. xmaxImg = xmax
  358. if ymin < yminImg:
  359. xminImg = xmin
  360. if ymax < ymaxImg:
  361. xminImg = xmin
  362. size = wx.Size(int(xmaxImg - xminImg),
  363. int(ymaxImg - ymaxImg))
  364. bitmap = wx.EmptyBitmap(width = size.width, height = size.height)
  365. filetype, ltype = GetImageHandlers(wx.ImageFromBitmap(bitmap))
  366. dlg = wx.FileDialog(parent = self,
  367. message = _("Choose a file name to save the image (no need to add extension)"),
  368. defaultDir = "",
  369. defaultFile = "",
  370. wildcard = filetype,
  371. style=wx.SAVE | wx.FD_OVERWRITE_PROMPT)
  372. if dlg.ShowModal() == wx.ID_OK:
  373. path = dlg.GetPath()
  374. if not path:
  375. dlg.Destroy()
  376. return
  377. base, ext = os.path.splitext(path)
  378. fileType = ltype[dlg.GetFilterIndex()]['type']
  379. extType = ltype[dlg.GetFilterIndex()]['ext']
  380. if ext != extType:
  381. path = base + '.' + extType
  382. dc = wx.MemoryDC(bitmap)
  383. dc.SetBackground(wx.WHITE_BRUSH)
  384. dc.SetBackgroundMode(wx.SOLID)
  385. dc.BeginDrawing()
  386. self.canvas.GetDiagram().Clear(dc)
  387. self.canvas.GetDiagram().Redraw(dc)
  388. dc.EndDrawing()
  389. bitmap.SaveFile(path, fileType)
  390. self.SetStatusText(_("Model exported to <%s>") % path)
  391. dlg.Destroy()
  392. def OnExportPython(self, event):
  393. """!Export model to Python script"""
  394. filename = ''
  395. dlg = wx.FileDialog(parent = self,
  396. message = _("Choose file to save"),
  397. defaultDir = os.getcwd(),
  398. wildcard=_("Python script (*.py)|*.py"),
  399. style=wx.FD_SAVE)
  400. if dlg.ShowModal() == wx.ID_OK:
  401. filename = dlg.GetPath()
  402. if not filename:
  403. return
  404. # check for extension
  405. if filename[-3:] != ".py":
  406. filename += ".py"
  407. if os.path.exists(filename):
  408. dlg = wx.MessageDialog(self, message=_("File <%s> already exists. "
  409. "Do you want to overwrite this file?") % filename,
  410. caption=_("Save file"),
  411. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION)
  412. if dlg.ShowModal() == wx.ID_NO:
  413. dlg.Destroy()
  414. return
  415. dlg.Destroy()
  416. fd = open(filename, "w")
  417. try:
  418. self._writePython(fd)
  419. finally:
  420. fd.close()
  421. # executable file
  422. os.chmod(filename, stat.S_IRWXU | stat.S_IWUSR)
  423. self.SetStatusText(_("Model exported to <%s>") % filename)
  424. def _writePython(self, fd):
  425. """!Write model to file"""
  426. fd.write(
  427. r"""#!/usr/bin/env python
  428. #
  429. ############################################################################
  430. #
  431. # MODULE: Graphical modeler script
  432. #
  433. # AUTHOR(S): %s
  434. #
  435. # PURPOSE: Script generated by wxGUI Graphical Modeler
  436. #
  437. # DATE: %s
  438. #
  439. #############################################################################
  440. """ % (getpass.getuser(), time.asctime()))
  441. fd.write(
  442. r"""
  443. import sys
  444. import os
  445. import grass.script as grass
  446. import atexit
  447. """)
  448. fd.write(
  449. r"""
  450. def cleanup():
  451. pass
  452. """)
  453. fd.write("\ndef main():\n")
  454. for action in self.actions:
  455. task = menuform.GUI().ParseCommand(cmd = action.GetLog(string = False),
  456. show = None)
  457. opts = task.get_options()
  458. flags = ''
  459. params = list()
  460. strcmd = " grass.run_command("
  461. indent = len(strcmd)
  462. fd.write(strcmd + "'%s',\n" % task.get_name())
  463. for f in opts['flags']:
  464. if f.get('value', False) == True:
  465. name = f.get('name', '')
  466. if len(name) > 1:
  467. params.append('%s=True' % name)
  468. else:
  469. flags += name
  470. for p in opts['params']:
  471. name = p.get('name', None)
  472. value = p.get('value', None)
  473. if name and value:
  474. ptype = p.get('type', 'string')
  475. if ptype == 'string':
  476. params.append("%s='%s'" % (name, value))
  477. else:
  478. params.append("%s=%s" % (name, value))
  479. for opt in params[:-1]:
  480. fd.write("%s%s,\n" % (' ' * indent, opt))
  481. fd.write("%s%s)\n" % (' ' * indent, params[-1]))
  482. fd.write("\n return 0\n")
  483. fd.write(
  484. r"""
  485. if __name__ == "__main__":
  486. options, flags = grass.parser()
  487. atexit.register(cleanup)
  488. sys.exit(main())
  489. """)
  490. def _validateModel(self):
  491. """!Validate model"""
  492. self.SetStatusText(_('Validating model...'), 0)
  493. errList = list()
  494. for action in self.actions:
  495. task = menuform.GUI().ParseCommand(cmd = action.GetLog(string = False),
  496. show = None)
  497. errList += task.getCmdError()
  498. self.SetStatusText('', 0)
  499. return errList
  500. def OnRemoveItem(self, event):
  501. """!Remove item from model"""
  502. pass
  503. def OnDefineRelation(self, event):
  504. """!Define relation between data and action items"""
  505. self.canvas.SetCursor(self.cursors["cross"])
  506. def OnAddAction(self, event):
  507. """!Add action to model"""
  508. if self.searchDialog is None:
  509. self.searchDialog = ModelSearchDialog(self)
  510. self.searchDialog.CentreOnParent()
  511. else:
  512. self.searchDialog.Reset()
  513. if self.searchDialog.ShowModal() == wx.ID_CANCEL:
  514. self.searchDialog.Hide()
  515. return
  516. cmd = self.searchDialog.GetCmd()
  517. self.searchDialog.Hide()
  518. self.ModelChanged()
  519. # add action to canvas
  520. width, height = self.canvas.GetSize()
  521. action = ModelAction(self, cmd = cmd, x = width/2, y = height/2)
  522. self.canvas.diagram.AddShape(action)
  523. action.Show(True)
  524. self._addEvent(action)
  525. self.actions.append(action)
  526. self.canvas.Refresh()
  527. time.sleep(.1)
  528. # show properties dialog
  529. win = action.GetPropDialog()
  530. if not win:
  531. module = menuform.GUI().ParseCommand(action.GetLog(string = False),
  532. completed = (self.GetOptData, action, action.GetParams()),
  533. parentframe = self, show = True)
  534. elif not win.IsShown():
  535. win.Show()
  536. if win:
  537. win.Raise()
  538. def OnAddData(self, event):
  539. """!Add data item to model"""
  540. # add action to canvas
  541. width, height = self.canvas.GetSize()
  542. data = ModelData(self, x = width/2, y = height/2)
  543. self.canvas.diagram.AddShape(data)
  544. data.Show(True)
  545. self._addEvent(data)
  546. self.data.append(data)
  547. self.canvas.Refresh()
  548. def OnHelp(self, event):
  549. """!Display manual page"""
  550. grass.run_command('g.manual',
  551. entry = 'wxGUI.Modeler')
  552. def OnAbout(self, event):
  553. """!Display About window"""
  554. info = wx.AboutDialogInfo()
  555. info.SetIcon(wx.Icon(os.path.join(globalvar.ETCICONDIR, 'grass.ico'), wx.BITMAP_TYPE_ICO))
  556. info.SetName(_('wxGUI Graphical Modeler'))
  557. info.SetWebSite('http://grass.osgeo.org')
  558. info.SetDescription(_('(C) 2010 by the GRASS Development Team\n\n') +
  559. '\n'.join(textwrap.wrap(_('This program is free software under the GNU General Public License'
  560. '(>=v2). Read the file COPYING that comes with GRASS for details.'), 75)))
  561. wx.AboutBox(info)
  562. def GetOptData(self, dcmd, layer, params, propwin):
  563. """!Process action data"""
  564. if params: # add data items
  565. for p in params['params']:
  566. if p.get('prompt', '') in ('raster', 'vector', 'raster3d'):
  567. try:
  568. name, mapset = p.get('value', '').split('@', 1)
  569. except (ValueError, IndexError):
  570. continue
  571. if mapset != grass.gisenv()['MAPSET']:
  572. continue
  573. # don't use fully qualified names
  574. p['value'] = p.get('value', '').split('@')[0]
  575. for idx in range(1, len(dcmd)):
  576. if p.get('name', '') in dcmd[idx]:
  577. dcmd[idx] = p.get('name', '') + '=' + p.get('value', '')
  578. break
  579. width, height = self.canvas.GetSize()
  580. x = [width/2 + 200, width/2 - 200]
  581. for p in params['params']:
  582. if p.get('prompt', '') in ('raster', 'vector', 'raster3d') and \
  583. (p.get('value', None) or \
  584. p.get('age', 'old') != 'old'):
  585. data = layer.FindData(p.get('name', ''))
  586. if data:
  587. data.SetValue(p.get('value', ''))
  588. continue
  589. data = self.FindData(p.get('value', ''),
  590. p.get('prompt', ''))
  591. if data:
  592. if p.get('age', 'old') == 'old':
  593. self._addLine(data, layer)
  594. data.AddAction(layer, direction = 'from')
  595. else:
  596. self._addLine(layer, data)
  597. data.AddAction(layer, direction = 'to')
  598. continue
  599. data = ModelData(self, name = p.get('name', ''),
  600. value = p.get('value', ''),
  601. prompt = p.get('prompt', ''),
  602. x = x.pop(), y = height/2)
  603. layer.AddData(data)
  604. self.canvas.diagram.AddShape(data)
  605. data.Show(True)
  606. self._addEvent(data)
  607. self.data.append(data)
  608. if p.get('age', 'old') == 'old':
  609. self._addLine(data, layer)
  610. data.AddAction(layer, direction = 'from')
  611. else:
  612. self._addLine(layer, data)
  613. data.AddAction(layer, direction = 'to')
  614. # valid ?
  615. valid = True
  616. for p in params['params']:
  617. if p.get('value', '') == '' and \
  618. p.get('default', '') == '':
  619. valid = False
  620. break
  621. layer.SetValid(valid)
  622. self.canvas.Refresh()
  623. if dcmd:
  624. layer.SetProperties(dcmd, params, propwin)
  625. self.SetStatusText(layer.GetLog(), 0)
  626. def _addLine(self, fromShape, toShape):
  627. """!Add connection
  628. @param fromShape from
  629. @param toShape to
  630. """
  631. line = ogl.LineShape()
  632. line.SetCanvas(self)
  633. line.SetPen(wx.BLACK_PEN)
  634. line.SetBrush(wx.BLACK_BRUSH)
  635. line.AddArrow(ogl.ARROW_ARROW)
  636. line.MakeLineControlPoints(2)
  637. fromShape.AddLine(line, toShape)
  638. self.canvas.diagram.AddShape(line)
  639. line.Show(True)
  640. def LoadModelFile(self, filename):
  641. """!Load model definition stored in GRASS Model XML file (gxm)
  642. @todo Validate against DTD
  643. Raise exception on error.
  644. """
  645. ### dtdFilename = os.path.join(globalvar.ETCWXDIR, "xml", "grass-gxm.dtd")
  646. # parse workspace file
  647. try:
  648. gxmXml = ProcessModelFile(etree.parse(filename))
  649. except:
  650. GMessage(parent = self,
  651. message = _("Reading model file <%s> failed.\n"
  652. "Invalid file, unable to parse XML document.") % filename)
  653. return
  654. self.modelFile = filename
  655. self.SetTitle(self.baseTitle + " - " + os.path.basename(self.modelFile))
  656. self.SetStatusText(_("Please wait, loading model..."), 0)
  657. # load actions
  658. for action in gxmXml.actions:
  659. actionShape = ModelAction(parent = self,
  660. x = action['pos'][0],
  661. y = action['pos'][1],
  662. width = action['size'][0],
  663. height = action['size'][1],
  664. cmd = action['cmd'])
  665. actionShape.SetId(action['id'])
  666. self.canvas.diagram.AddShape(actionShape)
  667. actionShape.Show(True)
  668. self._addEvent(actionShape)
  669. self.actions.append(actionShape)
  670. task = menuform.GUI().ParseCommand(cmd = actionShape.GetLog(string = False),
  671. show = None)
  672. valid = True
  673. for p in task.get_options()['params']:
  674. if p.get('value', '') == '' and \
  675. p.get('default', '') == '':
  676. valid = False
  677. break
  678. actionShape.SetValid(valid)
  679. # load data & connections
  680. for data in gxmXml.data:
  681. dataShape = ModelData(parent = self,
  682. x = data['pos'][0],
  683. y = data['pos'][1],
  684. width = data['size'][0],
  685. height = data['size'][1],
  686. name = data['name'],
  687. prompt = data['prompt'],
  688. value = data['value'])
  689. dataShape.SetIntermediate(data['intermediate'])
  690. self.canvas.diagram.AddShape(dataShape)
  691. dataShape.Show(True)
  692. self._addEvent(dataShape)
  693. self.data.append(dataShape)
  694. for idx in range(len(data['id'])):
  695. actionShape = self.FindAction(data['id'][idx])
  696. if data['from'][idx] is True:
  697. self._addLine(dataShape, actionShape)
  698. dataShape.AddAction(actionShape, direction = 'from')
  699. elif data['from'][idx] is False:
  700. self._addLine(actionShape, dataShape)
  701. dataShape.AddAction(actionShape, direction = 'to')
  702. actionShape.AddData(dataShape)
  703. self.SetStatusText('', 0)
  704. self.canvas.Refresh(True)
  705. def WriteModelFile(self, filename):
  706. """!Save model to model file
  707. @return True on success
  708. @return False on failure
  709. """
  710. try:
  711. file = open(filename, "w")
  712. except IOError:
  713. wx.MessageBox(parent = self,
  714. message = _("Unable to open file <%s> for writing.") % filename,
  715. caption = _("Error"),
  716. style = wx.OK | wx.ICON_ERROR | wx.CENTRE)
  717. return False
  718. try:
  719. WriteModelFile(fd = file, actions = self.actions, data = self.data)
  720. except StandardError:
  721. file.close()
  722. GMessage(parent = self,
  723. message = _("Writing current settings to model file failed."))
  724. return False
  725. file.close()
  726. return True
  727. class ModelCanvas(ogl.ShapeCanvas):
  728. """!Canvas where model is drawn"""
  729. def __init__(self, parent):
  730. ogl.OGLInitialize()
  731. ogl.ShapeCanvas.__init__(self, parent)
  732. self.diagram = ogl.Diagram()
  733. self.SetDiagram(self.diagram)
  734. self.diagram.SetCanvas(self)
  735. self.SetScrollbars(20, 20, 1000/20, 1000/20)
  736. class ModelAction(ogl.RectangleShape):
  737. """!Action class (GRASS module)"""
  738. def __init__(self, parent, x, y, cmd = None, width = 100, height = 50):
  739. self.parent = parent
  740. self.cmd = cmd
  741. if self.cmd:
  742. task = menuform.GUI().ParseCommand(cmd = self.cmd,
  743. show = None)
  744. self.params = task.get_options()
  745. else:
  746. self.params = None
  747. self.propWin = None
  748. self.id = -1 # used for gxm file
  749. self.data = list() # list of connected data items
  750. # colors
  751. self.colors = dict()
  752. self.colors['valid'] = wx.LIGHT_GREY_BRUSH
  753. self.colors['invalid'] = wx.WHITE_BRUSH
  754. ogl.RectangleShape.__init__(self, width, height)
  755. # self.Draggable(True)
  756. self.SetCanvas(self.parent)
  757. self.SetX(x)
  758. self.SetY(y)
  759. self.SetPen(wx.BLACK_PEN)
  760. self.SetBrush(self.colors['invalid'])
  761. if self.cmd and len(self.cmd) > 0:
  762. self.AddText(self.cmd[0])
  763. else:
  764. self.AddText('<<module>>')
  765. def GetId(self):
  766. """!Get id"""
  767. return self.id
  768. def SetId(self, id):
  769. """!Set id"""
  770. self.id = id
  771. def SetProperties(self, dcmd, params, propwin):
  772. """!Record properties dialog"""
  773. self.cmd = dcmd
  774. self.params = params
  775. self.propWin = propwin
  776. def GetPropDialog(self):
  777. """!Get properties dialog"""
  778. return self.propWin
  779. def GetLog(self, string = True):
  780. """!Get logging info"""
  781. if string:
  782. if self.cmd is None:
  783. return ''
  784. else:
  785. return ' '.join(self.cmd)
  786. return self.cmd
  787. def GetName(self):
  788. """!Get name"""
  789. if self.cmd and len(self.cmd) > 0:
  790. return self.cmd[0]
  791. return _('unknown')
  792. def GetParams(self):
  793. """!Get dictionary of parameters"""
  794. return self.params
  795. def SetParams(self, params, cmd):
  796. """!Set dictionary of parameters"""
  797. self.params = params
  798. self.cmd = cmd
  799. def SetValid(self, isvalid):
  800. """!Set instance to be valid/invalid"""
  801. if isvalid:
  802. self.SetBrush(self.colors['valid'])
  803. else:
  804. self.SetBrush(self.colors['invalid'])
  805. def AddData(self, item):
  806. """!Register new data item"""
  807. if item not in self.data:
  808. self.data.append(item)
  809. def FindData(self, name):
  810. """!Find data item by name"""
  811. for d in self.data:
  812. if d.GetName() == name:
  813. return d
  814. return None
  815. class ModelData(ogl.EllipseShape):
  816. """!Data item class"""
  817. def __init__(self, parent, x, y, name = '', value = '', prompt = '', width = 175, height = 50):
  818. self.parent = parent
  819. self.name = name
  820. self.value = value
  821. self.prompt = prompt
  822. self.intermediate = False
  823. self.propWin = None
  824. self.actions = { 'from' : list(), 'to' : list() }
  825. ogl.EllipseShape.__init__(self, width, height)
  826. # self.Draggable(True)
  827. self.SetCanvas(self.parent)
  828. self.SetX(x)
  829. self.SetY(y)
  830. self.SetPen(wx.BLACK_PEN)
  831. if self.prompt == 'raster':
  832. self.SetBrush(wx.Brush(wx.Colour(215, 215, 248)))
  833. elif self.prompt == 'vector':
  834. self.SetBrush(wx.Brush(wx.Colour(248, 215, 215)))
  835. else:
  836. self.SetBrush(wx.LIGHT_GREY_BRUSH)
  837. if name:
  838. self.AddText(name)
  839. else:
  840. self.AddText(_('unknown'))
  841. if value:
  842. self.AddText(value)
  843. else:
  844. self.AddText('\n')
  845. def IsIntermediate(self):
  846. """!Checks if data item is intermediate"""
  847. return self.intermediate
  848. def SetIntermediate(self, im):
  849. """!Set intermediate flag"""
  850. self.intermediate = im
  851. def OnDraw(self, dc):
  852. pen = self.GetPen()
  853. if self.intermediate:
  854. pen.SetStyle(wx.SHORT_DASH)
  855. else:
  856. pen.SetStyle(wx.SOLID)
  857. self.SetPen(pen)
  858. ogl.EllipseShape.OnDraw(self, dc)
  859. def GetLog(self, string = True):
  860. """!Get logging info"""
  861. if self.name:
  862. return self.name + '=' + self.value + ' (' + self.prompt + ')'
  863. else:
  864. return _('unknown')
  865. def GetName(self):
  866. """!Get name"""
  867. return self.name
  868. def GetPrompt(self):
  869. """!Get prompt"""
  870. return self.prompt
  871. def GetValue(self):
  872. """!Get value"""
  873. return self.value
  874. def SetValue(self, value):
  875. """!Set value"""
  876. self.value = value
  877. self.ClearText()
  878. self.AddText(self.name)
  879. if value:
  880. self.AddText(self.value)
  881. else:
  882. self.AddText('\n')
  883. for direction in ('from', 'to'):
  884. for action in self.actions[direction]:
  885. task = menuform.GUI().ParseCommand(cmd = action.GetLog(string = False),
  886. show = None)
  887. task.set_param(self.name, self.value)
  888. action.SetParams(params = task.get_options(),
  889. cmd = task.getCmd(ignoreErrors = True))
  890. def GetActions(self, direction):
  891. """!Get related actions
  892. @param direction direction - 'from' or 'to'
  893. """
  894. return self.actions[direction]
  895. def AddAction(self, action, direction):
  896. """!Record related actions
  897. @param action action to be recoreded
  898. @param direction direction of relation
  899. """
  900. self.actions[direction].append(action)
  901. def GetPropDialog(self):
  902. """!Get properties dialog"""
  903. return self.propWin
  904. def SetPropDialog(self, win):
  905. """!Get properties dialog"""
  906. self.propWin = win
  907. class ModelDataDialog(ElementDialog):
  908. """!Data item properties dialog"""
  909. def __init__(self, parent, shape, id = wx.ID_ANY, title = _("Data properties"),
  910. style = wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER):
  911. self.parent = parent
  912. self.shape = shape
  913. prompt = shape.GetPrompt()
  914. if prompt == 'raster':
  915. label = _('Name of raster map:')
  916. elif prompt == 'vector':
  917. label = _('Name of vector map:')
  918. else:
  919. label = _('Name of element:')
  920. ElementDialog.__init__(self, parent, title, label = label)
  921. self.element = gselect.Select(parent = self.panel, id = wx.ID_ANY,
  922. size = globalvar.DIALOG_GSELECT_SIZE,
  923. type = prompt)
  924. self.element.SetValue(shape.GetValue())
  925. self.Bind(wx.EVT_BUTTON, self.OnOK, self.btnOK)
  926. self.Bind(wx.EVT_BUTTON, self.OnCancel, self.btnCancel)
  927. self.PostInit()
  928. self._layout()
  929. self.SetMinSize(self.GetSize())
  930. def _layout(self):
  931. """!Do layout"""
  932. self.dataSizer.Add(self.element, proportion=0,
  933. flag=wx.EXPAND | wx.ALL, border=1)
  934. self.panel.SetSizer(self.sizer)
  935. self.sizer.Fit(self)
  936. def OnOK(self, event):
  937. """!Ok pressed"""
  938. self.shape.SetValue(self.GetElement())
  939. self.parent.canvas.Refresh()
  940. self.parent.SetStatusText('', 0)
  941. self.OnCancel(event)
  942. def OnCancel(self, event):
  943. """!Cancel pressed"""
  944. self.shape.SetPropDialog(None)
  945. self.Destroy()
  946. class ModelEvtHandler(ogl.ShapeEvtHandler):
  947. """!Model event handler class"""
  948. def __init__(self, log, frame):
  949. ogl.ShapeEvtHandler.__init__(self)
  950. self.log = log
  951. self.frame = frame
  952. def OnLeftClick(self, x, y, keys = 0, attachment = 0):
  953. """!Left mouse button pressed -> select item & update statusbar"""
  954. shape = self.GetShape()
  955. canvas = shape.GetCanvas()
  956. dc = wx.ClientDC(canvas)
  957. canvas.PrepareDC(dc)
  958. if shape.Selected():
  959. shape.Select(False, dc)
  960. else:
  961. redraw = False
  962. shapeList = canvas.GetDiagram().GetShapeList()
  963. toUnselect = list()
  964. for s in shapeList:
  965. if s.Selected():
  966. toUnselect.append(s)
  967. shape.Select(True, dc)
  968. for s in toUnselect:
  969. s.Select(False, dc)
  970. canvas.Refresh(False)
  971. self.log.SetStatusText(shape.GetLog(), 0)
  972. def OnLeftDoubleClick(self, x, y, keys = 0, attachment = 0):
  973. """!Left mouse button pressed (double-click) -> show properties"""
  974. self.OnProperties()
  975. def OnProperties(self, event = None):
  976. """!Show properties dialog"""
  977. self.frame.ModelChanged()
  978. shape = self.GetShape()
  979. # win = shape.GetPropDialog()
  980. if isinstance(shape, ModelAction):
  981. module = menuform.GUI().ParseCommand(shape.GetLog(string = False),
  982. completed = (self.frame.GetOptData, shape, shape.GetParams()),
  983. parentframe = self.frame, show = True)
  984. elif isinstance(shape, ModelData):
  985. dlg = ModelDataDialog(parent = self.frame, shape = shape)
  986. shape.SetPropDialog(dlg)
  987. dlg.CentreOnParent()
  988. dlg.Show()
  989. def OnBeginDragLeft(self, x, y, keys = 0, attachment = 0):
  990. """!Drag shape"""
  991. self.frame.ModelChanged()
  992. if self._previousHandler:
  993. self._previousHandler.OnBeginDragLeft(x, y, keys, attachment)
  994. def OnRightClick(self, x, y, keys = 0, attachment = 0):
  995. """!Right click -> pop-up menu"""
  996. if not hasattr (self, "popupID1"):
  997. self.popupID1 = wx.NewId()
  998. self.popupID2 = wx.NewId()
  999. self.popupID3 = wx.NewId()
  1000. popupMenu = wx.Menu()
  1001. popupMenu.Append(self.popupID1, text=_('Remove'))
  1002. self.frame.Bind(wx.EVT_MENU, self.OnRemove, id = self.popupID1)
  1003. popupMenu.AppendSeparator()
  1004. shape = self.GetShape()
  1005. if isinstance(shape, ModelData) and '@' not in shape.GetValue():
  1006. popupMenu.Append(self.popupID3, text=_('Intermediate'),
  1007. kind = wx.ITEM_CHECK)
  1008. if self.GetShape().IsIntermediate():
  1009. popupMenu.Check(self.popupID3, True)
  1010. self.frame.Bind(wx.EVT_MENU, self.OnIntermediate, id = self.popupID3)
  1011. popupMenu.AppendSeparator()
  1012. popupMenu.Append(self.popupID2, text=_('Properties'))
  1013. self.frame.Bind(wx.EVT_MENU, self.OnProperties, id = self.popupID2)
  1014. self.frame.PopupMenu(popupMenu)
  1015. popupMenu.Destroy()
  1016. def OnIntermediate(self, event):
  1017. """!Mark data as intermediate"""
  1018. self.frame.ModelChanged()
  1019. shape = self.GetShape()
  1020. shape.SetIntermediate(event.IsChecked())
  1021. self.frame.canvas.Refresh()
  1022. def OnRemove(self, event):
  1023. """!Remove shape"""
  1024. self.frame.ModelChanged()
  1025. shape = self.GetShape()
  1026. self.frame.canvas.GetDiagram().RemoveShape(shape)
  1027. self.frame.canvas.Refresh()
  1028. class ModelSearchDialog(wx.Dialog):
  1029. def __init__(self, parent, id = wx.ID_ANY, title = _("Select GRASS module"),
  1030. style = wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER, **kwargs):
  1031. """!Graphical modeler module search window
  1032. @param parent parent window
  1033. @param id window id
  1034. @param title window title
  1035. @param kwargs wx.Dialogs' arguments
  1036. """
  1037. self.parent = parent
  1038. wx.Dialog.__init__(self, parent = parent, id = id, title = title, **kwargs)
  1039. self.SetName("ModelerDialog")
  1040. self.SetIcon(wx.Icon(os.path.join(globalvar.ETCICONDIR, 'grass.ico'), wx.BITMAP_TYPE_ICO))
  1041. self.panel = wx.Panel(parent = self, id = wx.ID_ANY)
  1042. self.findBox = wx.StaticBox(parent = self.panel, id = wx.ID_ANY,
  1043. label=" %s " % _("Find module(s) by"))
  1044. self.cmdBox = wx.StaticBox(parent = self.panel, id = wx.ID_ANY,
  1045. label=" %s " % _("Command"))
  1046. self.searchBy = wx.Choice(parent = self.panel, id = wx.ID_ANY,
  1047. choices = [_("description"),
  1048. _("keywords")])
  1049. self.searchBy.SetSelection(0)
  1050. self.search = wx.TextCtrl(parent = self.panel, id = wx.ID_ANY,
  1051. value = "", size = (-1, 25))
  1052. self.searchTip = menuform.StaticWrapText(parent = self.panel, id = wx.ID_ANY,
  1053. size = (-1, 35))
  1054. self.searchChoice = wx.Choice(parent = self.panel, id = wx.ID_ANY)
  1055. self.cmd_prompt = prompt.GPromptSTC(parent = self)
  1056. # get commands
  1057. items = self.cmd_prompt.GetCommandItems()
  1058. self.searchTip.SetLabel(_("%d modules found") % len(items))
  1059. self.searchChoice.SetItems(items)
  1060. self.btnCancel = wx.Button(self.panel, wx.ID_CANCEL)
  1061. self.btnOk = wx.Button(self.panel, wx.ID_OK)
  1062. self.btnOk.SetDefault()
  1063. self.search.Bind(wx.EVT_TEXT, self.OnSearchModule)
  1064. self.searchChoice.Bind(wx.EVT_CHOICE, self.OnSelectModule)
  1065. self._layout()
  1066. self.SetSize((500, 275))
  1067. def _layout(self):
  1068. btnSizer = wx.StdDialogButtonSizer()
  1069. btnSizer.AddButton(self.btnCancel)
  1070. btnSizer.AddButton(self.btnOk)
  1071. btnSizer.Realize()
  1072. findSizer = wx.StaticBoxSizer(self.findBox, wx.HORIZONTAL)
  1073. gridSizer = wx.GridBagSizer(hgap = 3, vgap = 3)
  1074. gridSizer.AddGrowableCol(1)
  1075. cmdSizer = wx.StaticBoxSizer(self.cmdBox, wx.VERTICAL)
  1076. gridSizer.Add(item = self.searchBy,
  1077. flag=wx.ALIGN_CENTER_VERTICAL, pos = (0, 0))
  1078. gridSizer.Add(item = self.search,
  1079. flag=wx.ALIGN_CENTER_VERTICAL | wx.EXPAND, pos = (0, 1))
  1080. gridSizer.Add(item = self.searchTip,
  1081. flag=wx.ALIGN_CENTER_VERTICAL | wx.EXPAND, pos = (1, 0), span = (1, 2))
  1082. gridSizer.Add(item = self.searchChoice,
  1083. flag=wx.ALIGN_CENTER_VERTICAL | wx.EXPAND, pos = (2, 0), span = (1, 2))
  1084. findSizer.Add(item = gridSizer, proportion = 1)
  1085. cmdSizer.Add(item=self.cmd_prompt, proportion=1,
  1086. flag=wx.EXPAND | wx.ALL, border=1)
  1087. mainSizer = wx.BoxSizer(wx.VERTICAL)
  1088. mainSizer.Add(item=findSizer, proportion=0,
  1089. flag=wx.EXPAND | wx.ALL, border=5)
  1090. mainSizer.Add(item=cmdSizer, proportion=1,
  1091. flag=wx.EXPAND | wx.LEFT | wx.RIGHT | wx.BOTTOM, border = 5)
  1092. mainSizer.Add(item=btnSizer, proportion=0,
  1093. flag=wx.EXPAND | wx.ALL | wx.ALIGN_CENTER, border=5)
  1094. self.panel.SetSizer(mainSizer)
  1095. mainSizer.Fit(self.panel)
  1096. self.Layout()
  1097. def GetPanel(self):
  1098. """!Get dialog panel"""
  1099. return self.panel
  1100. def GetCmd(self):
  1101. """!Get command"""
  1102. line = self.cmd_prompt.GetCurLine()[0].strip()
  1103. if len(line) == 0:
  1104. list()
  1105. try:
  1106. cmd = shlex.split(str(line))
  1107. except UnicodeError:
  1108. cmd = shlex.split(utils.EncodeString((line)))
  1109. return cmd
  1110. def OnSearchModule(self, event):
  1111. """!Search module by keywords or description"""
  1112. text = event.GetString()
  1113. if not text:
  1114. self.cmd_prompt.SetFilter(None)
  1115. return
  1116. modules = dict()
  1117. iFound = 0
  1118. for module, data in self.cmd_prompt.moduleDesc.iteritems():
  1119. found = False
  1120. if self.searchBy.GetSelection() == 0: # -> description
  1121. if text in data['desc']:
  1122. found = True
  1123. else: # -> keywords
  1124. if self.cmd_prompt.CheckKey(text, data['keywords']):
  1125. found = True
  1126. if found:
  1127. iFound += 1
  1128. try:
  1129. group, name = module.split('.')
  1130. except ValueError:
  1131. continue # TODO
  1132. if not modules.has_key(group):
  1133. modules[group] = list()
  1134. modules[group].append(name)
  1135. self.cmd_prompt.SetFilter(modules)
  1136. self.searchTip.SetLabel(_("%d modules found") % iFound)
  1137. self.searchChoice.SetItems(self.cmd_prompt.GetCommandItems())
  1138. def OnSelectModule(self, event):
  1139. """!Module selected from choice, update command prompt"""
  1140. cmd = event.GetString().split(' ', 1)[0]
  1141. text = cmd + ' '
  1142. pos = len(text)
  1143. self.cmd_prompt.SetText(text)
  1144. self.cmd_prompt.SetSelectionStart(pos)
  1145. self.cmd_prompt.SetCurrentPos(pos)
  1146. self.cmd_prompt.SetFocus()
  1147. desc = self.cmd_prompt.GetCommandDesc(cmd)
  1148. self.searchTip.SetLabel(desc)
  1149. def OnOk(self, event):
  1150. self.btnOk.SetFocus()
  1151. def Reset(self):
  1152. """!Reset dialog"""
  1153. self.searchBy.SetSelection(0)
  1154. self.search.SetValue('')
  1155. self.cmd_prompt.OnCmdErase(None)
  1156. class ProcessModelFile:
  1157. """!Process GRASS model file (gxm)"""
  1158. def __init__(self, tree):
  1159. """!A ElementTree handler for the GXM XML file, as defined in
  1160. grass-gxm.dtd.
  1161. """
  1162. self.tree = tree
  1163. self.root = self.tree.getroot()
  1164. # list of actions, data
  1165. self.actions = list()
  1166. self.data = list()
  1167. self._processActions()
  1168. self._processData()
  1169. def _filterValue(self, value):
  1170. """!Filter value
  1171. @param value
  1172. """
  1173. value = value.replace('&lt;', '<')
  1174. value = value.replace('&gt;', '>')
  1175. return value
  1176. def _getNodeText(self, node, tag, default = ''):
  1177. """!Get node text"""
  1178. p = node.find(tag)
  1179. if p is not None:
  1180. if p.text:
  1181. return utils.normalize_whitespace(p.text)
  1182. else:
  1183. return ''
  1184. return default
  1185. def _processActions(self):
  1186. """!Process model file"""
  1187. for action in self.root.findall('action'):
  1188. pos, size = self._getDim(action)
  1189. task = action.find('task')
  1190. if task:
  1191. cmd = self._processTask(task)
  1192. else:
  1193. cmd = None
  1194. aId = int(action.get('id', -1))
  1195. self.actions.append({ 'pos' : pos,
  1196. 'size': size,
  1197. 'cmd' : cmd,
  1198. 'id' : aId })
  1199. def _getDim(self, node):
  1200. """!Get position and size of shape"""
  1201. pos = size = None
  1202. posAttr = node.get('pos', None)
  1203. if posAttr:
  1204. posVal = map(int, posAttr.split(','))
  1205. try:
  1206. pos = (posVal[0], posVal[1])
  1207. except:
  1208. pos = None
  1209. sizeAttr = node.get('size', None)
  1210. if sizeAttr:
  1211. sizeVal = map(int, sizeAttr.split(','))
  1212. try:
  1213. size = (sizeVal[0], sizeVal[1])
  1214. except:
  1215. size = None
  1216. return pos, size
  1217. def _processData(self):
  1218. """!Process model file"""
  1219. for data in self.root.findall('data'):
  1220. pos, size = self._getDim(data)
  1221. param = data.find('data-parameter')
  1222. name = prompt = value = None
  1223. if param is not None:
  1224. name = param.get('name', None)
  1225. prompt = param.get('prompt', None)
  1226. value = self._filterValue(self._getNodeText(param, 'value'))
  1227. if data.find('intermediate') is None:
  1228. intermediate = False
  1229. else:
  1230. intermediate = True
  1231. aId = list()
  1232. fromDir = list()
  1233. for action in data.findall('data-action'):
  1234. aId.append(int(action.get('id', None)))
  1235. if action.get('dir', 'to') == 'to':
  1236. fromDir.append(False)
  1237. else:
  1238. fromDir.append(True)
  1239. self.data.append({ 'pos' : pos,
  1240. 'size': size,
  1241. 'name' : name,
  1242. 'prompt' : prompt,
  1243. 'value' : value,
  1244. 'intermediate' : intermediate,
  1245. 'id' : aId,
  1246. 'from' : fromDir })
  1247. def _processTask(self, node):
  1248. """!Process task"""
  1249. cmd = list()
  1250. name = node.get('name', None)
  1251. if not name:
  1252. return cmd
  1253. cmd.append(name)
  1254. # flags
  1255. for p in node.findall('flag'):
  1256. flag = p.get('name', '')
  1257. if len(flag) > 1:
  1258. cmd.append('--' + flag)
  1259. else:
  1260. cmd.append('-' + flag)
  1261. # parameters
  1262. for p in node.findall('parameter'):
  1263. cmd.append('%s=%s' % (p.get('name', ''),
  1264. self._filterValue(self._getNodeText(p, 'value'))))
  1265. return cmd
  1266. class WriteModelFile:
  1267. """!Generic class for writing model file"""
  1268. def __init__(self, fd, actions, data):
  1269. self.fd = fd
  1270. self.actions = actions
  1271. self.data = data
  1272. self.indent = 0
  1273. self._header()
  1274. self._actions()
  1275. self._data()
  1276. self._footer()
  1277. def _filterValue(self, value):
  1278. """!Make value XML-valid"""
  1279. value = value.replace('<', '&lt;')
  1280. value = value.replace('>', '&gt;')
  1281. return value
  1282. def _header(self):
  1283. """!Write header"""
  1284. self.fd.write('<?xml version="1.0" encoding="UTF-8"?>\n')
  1285. self.fd.write('<!DOCTYPE gxm SYSTEM "grass-gxm.dtd">\n')
  1286. self.fd.write('%s<gxm>\n' % (' ' * self.indent))
  1287. def _footer(self):
  1288. """!Write footer"""
  1289. self.fd.write('%s</gxm>\n' % (' ' * self.indent))
  1290. def _actions(self):
  1291. """!Write actions"""
  1292. id = 1
  1293. self.indent += 4
  1294. for action in self.actions:
  1295. action.SetId(id)
  1296. self.fd.write('%s<action id="%d" name="%s" pos="%d,%d" size="%d,%d">\n' % \
  1297. (' ' * self.indent, id, action.GetName(), action.GetX(), action.GetY(),
  1298. action.GetWidth(), action.GetHeight()))
  1299. self.indent += 4
  1300. self.fd.write('%s<task name="%s">\n' % (' ' * self.indent, action.GetLog(string = False)[0]))
  1301. self.indent += 4
  1302. for key, val in action.GetParams().iteritems():
  1303. if key == 'flags':
  1304. for f in val:
  1305. if f.get('value', False):
  1306. self.fd.write('%s<flag name="%s" />\n' %
  1307. (' ' * self.indent, f.get('name', '')))
  1308. else: # parameter
  1309. for p in val:
  1310. if not p.get('value', ''):
  1311. continue
  1312. self.fd.write('%s<parameter name="%s">\n' %
  1313. (' ' * self.indent, p.get('name', '')))
  1314. self.indent += 4
  1315. self.fd.write('%s<value>%s</value>\n' %
  1316. (' ' * self.indent, self._filterValue(p.get('value', ''))))
  1317. self.indent -= 4
  1318. self.fd.write('%s</parameter>\n' % (' ' * self.indent))
  1319. self.indent -= 4
  1320. self.fd.write('%s</task>\n' % (' ' * self.indent))
  1321. self.indent -= 4
  1322. self.fd.write('%s</action>\n' % (' ' * self.indent))
  1323. id += 1
  1324. self.indent -= 4
  1325. def _data(self):
  1326. """!Write data"""
  1327. self.indent += 4
  1328. for data in self.data:
  1329. self.fd.write('%s<data pos="%d,%d" size="%d,%d">\n' % \
  1330. (' ' * self.indent, data.GetX(), data.GetY(),
  1331. data.GetWidth(), data.GetHeight()))
  1332. self.indent += 4
  1333. self.fd.write('%s<data-parameter name="%s" prompt="%s">\n' % \
  1334. (' ' * self.indent, data.GetName(), data.GetPrompt()))
  1335. self.indent += 4
  1336. self.fd.write('%s<value>%s</value>\n' %
  1337. (' ' * self.indent, self._filterValue(data.GetValue())))
  1338. self.indent -= 4
  1339. self.fd.write('%s</data-parameter>\n' % (' ' * self.indent))
  1340. if data.IsIntermediate():
  1341. self.fd.write('%s<intermediate />\n' % (' ' * self.indent))
  1342. for action in data.GetActions('from'):
  1343. id = action.GetId()
  1344. self.fd.write('%s<data-action id="%d" dir="from" />\n' % \
  1345. (' ' * self.indent, id))
  1346. for action in data.GetActions('to'):
  1347. id = action.GetId()
  1348. self.fd.write('%s<data-action id="%d" dir="to" />\n' % \
  1349. (' ' * self.indent, id))
  1350. self.indent -= 4
  1351. self.fd.write('%s</data>\n' % (' ' * self.indent))
  1352. self.indent -= 4
  1353. def main():
  1354. app = wx.PySimpleApp()
  1355. wx.InitAllImageHandlers()
  1356. frame = ModelFrame(parent = None)
  1357. if len(sys.argv) > 1:
  1358. frame.LoadModelFile(sys.argv[1])
  1359. # frame.CentreOnScreen()
  1360. frame.Show()
  1361. app.MainLoop()
  1362. if __name__ == "__main__":
  1363. main()