gmodeler.py 88 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486
  1. """!
  2. @package gmodeler.py
  3. @brief Graphical modeler to create edit, and manage models
  4. Classes:
  5. - Model
  6. - ModelFrame
  7. - ModelCanvas
  8. - ModelAction
  9. - ModelSearchDialog
  10. - ModelData
  11. - ModelDataDialog
  12. - ModelRelation
  13. - ProcessModelFile
  14. - WriteModelFile
  15. - PreferencesDialog
  16. - PropertiesDialog
  17. - ModelParamDialog
  18. (C) 2010 by the GRASS Development Team
  19. This program is free software under the GNU General Public License
  20. (>=v2). Read the file COPYING that comes with GRASS for details.
  21. @author Martin Landa <landa.martin gmail.com>
  22. """
  23. import os
  24. import sys
  25. import shlex
  26. import time
  27. import traceback
  28. import getpass
  29. import stat
  30. import textwrap
  31. import tempfile
  32. import copy
  33. try:
  34. import xml.etree.ElementTree as etree
  35. except ImportError:
  36. import elementtree.ElementTree as etree # Python <= 2.4
  37. import globalvar
  38. if not os.getenv("GRASS_WXBUNDLED"):
  39. globalvar.CheckForWx()
  40. import wx
  41. import wx.lib.ogl as ogl
  42. import wx.lib.flatnotebook as FN
  43. import wx.lib.colourselect as csel
  44. import menu
  45. import menudata
  46. import toolbars
  47. import menuform
  48. import prompt
  49. import utils
  50. import goutput
  51. import gselect
  52. from debug import Debug
  53. from gcmd import GMessage, GError
  54. from gdialogs import ElementDialog, GetImageHandlers
  55. from preferences import PreferencesBaseDialog, globalSettings as UserSettings
  56. from ghelp import SearchModuleWindow
  57. from grass.script import core as grass
  58. class Model(object):
  59. """!Class representing the model"""
  60. def __init__(self, canvas = None):
  61. self.actions = list() # list of recorded actions
  62. self.data = list() # list of recorded data items
  63. self.canvas = canvas
  64. def GetCanvas(self):
  65. """!Get canvas or None"""
  66. return self.canvas
  67. def GetActions(self):
  68. """!Return list of actions"""
  69. return self.actions
  70. def GetData(self):
  71. """!Return list of data"""
  72. return self.data
  73. def Reset(self):
  74. """!Reset model"""
  75. self.actions = list()
  76. self.data = list()
  77. def AddAction(self, item):
  78. """!Add action to the model"""
  79. self.actions.append(item)
  80. def AddData(self, item):
  81. """!Add data to the model"""
  82. self.data.append(item)
  83. def RemoveItem(self, item):
  84. """!Remove item from model"""
  85. if isinstance(item, ModelAction):
  86. self.actions.remove(item)
  87. elif isinstance(item, ModelData):
  88. self.data.remove(item)
  89. def FindAction(self, id):
  90. """!Find action by id"""
  91. for action in self.actions:
  92. if action.GetId() == id:
  93. return action
  94. return None
  95. def FindData(self, value, prompt):
  96. """!Find data by value, and prompt"""
  97. for data in self.data:
  98. if data.GetValue() == value and \
  99. data.GetPrompt() == prompt:
  100. return data
  101. return None
  102. def LoadModel(self, filename):
  103. """!Load model definition stored in GRASS Model XML file (gxm)
  104. @todo Validate against DTD
  105. Raise exception on error.
  106. """
  107. dtdFilename = os.path.join(globalvar.ETCWXDIR, "xml", "grass-gxm.dtd")
  108. # parse workspace file
  109. try:
  110. gxmXml = ProcessModelFile(etree.parse(filename))
  111. except StandardError, e:
  112. raise GError(e)
  113. # load model.GetActions()
  114. for action in gxmXml.actions:
  115. actionItem = ModelAction(parent = self,
  116. x = action['pos'][0],
  117. y = action['pos'][1],
  118. width = action['size'][0],
  119. height = action['size'][1],
  120. task = action['task'])
  121. actionItem.SetId(action['id'])
  122. self.actions.append(actionItem)
  123. task = menuform.GUI().ParseCommand(cmd = actionItem.GetLog(string = False),
  124. show = None)
  125. valid = True
  126. for p in task.get_options()['params']:
  127. if p.get('value', '') == '' and \
  128. p.get('default', '') == '':
  129. valid = False
  130. break
  131. actionItem.SetValid(valid)
  132. # load data & connections
  133. for data in gxmXml.data:
  134. dataItem = ModelData(parent = self,
  135. x = data['pos'][0],
  136. y = data['pos'][1],
  137. width = data['size'][0],
  138. height = data['size'][1],
  139. name = data['name'],
  140. prompt = data['prompt'],
  141. value = data['value'])
  142. dataItem.SetIntermediate(data['intermediate'])
  143. for rel in data['rels']:
  144. actionItem = self.FindAction(rel['id'])
  145. if rel['dir'] == 'from':
  146. relation = ModelRelation(dataItem, actionItem)
  147. relation.SetControlPoints(rel['points'])
  148. dataItem.AddRelation(relation, direction = 'from')
  149. else:
  150. relation = ModelRelation(actionItem, dataItem)
  151. relation.SetControlPoints(rel['points'])
  152. dataItem.AddRelation(relation, direction = 'to')
  153. self.data.append(dataItem)
  154. actionItem.AddData(dataItem)
  155. def IsValid(self):
  156. """Return True if model is valid"""
  157. if self.Validate():
  158. return False
  159. return True
  160. def Validate(self):
  161. """!Validate model, return None if model is valid otherwise
  162. error string"""
  163. errList = list()
  164. for action in self.actions:
  165. task = menuform.GUI().ParseCommand(cmd = action.GetLog(string = False),
  166. show = None)
  167. errList += task.getCmdError()
  168. return errList
  169. def Run(self, log, onDone):
  170. """!Run model"""
  171. for action in self.actions:
  172. log.RunCmd(command = action.GetLog(string = False),
  173. onDone = onDone)
  174. def DeleteIntermediateData(self, log):
  175. """!Detele intermediate data"""
  176. rast, vect, rast3d, msg = self.GetIntermediateData()
  177. if rast:
  178. log.RunCmd(['g.remove', 'rast=%s' %','.join(rast)])
  179. if rast3d:
  180. log.RunCmd(['g.remove', 'rast3d=%s' %','.join(rast3d)])
  181. if vect:
  182. log.RunCmd(['g.remove', 'vect=%s' %','.join(vect)])
  183. def GetIntermediateData(self):
  184. """!Get info about intermediate data"""
  185. rast = list()
  186. rast3d = list()
  187. vect = list()
  188. for data in self.data:
  189. if not data.IsIntermediate():
  190. continue
  191. name = data.GetValue()
  192. prompt = data.GetPrompt()
  193. if prompt == 'raster':
  194. rast.append(name)
  195. elif prompt == 'vector':
  196. vect.append(name)
  197. elif prompt == 'rast3d':
  198. rast3d.append(name)
  199. msg = ''
  200. if rast:
  201. msg += '\n\n%s: ' % _('Raster maps')
  202. msg += ', '.join(rast)
  203. if rast3d:
  204. msg += '\n\n%s: ' % _('3D raster maps')
  205. msg += ', '.join(rast3d)
  206. if vect:
  207. msg += '\n\n%s: ' % _('Vector maps')
  208. msg += ', '.join(vect)
  209. return rast, vect, rast3d, msg
  210. def Update(self):
  211. """!Update model"""
  212. for action in self.actions:
  213. action.Update()
  214. for data in self.data:
  215. data.Update()
  216. def IsParameterized(self):
  217. """!Return True if model is parameterized"""
  218. if self.Parametrize():
  219. return True
  220. return False
  221. def Parametrize(self):
  222. """!Return parameterized options"""
  223. result = dict()
  224. idx = 0
  225. for action in self.actions:
  226. name = action.GetName()
  227. params = action.GetParams()
  228. for f in params['flags']:
  229. if f.get('parameterized', False):
  230. if not result.has_key(name):
  231. result[name] = { 'flags' : list(),
  232. 'params': list(),
  233. 'idx' : idx }
  234. result[name]['flags'].append(f)
  235. for p in params['params']:
  236. if p.get('parameterized', False):
  237. if not result.has_key(name):
  238. result[name] = { 'flags' : list(),
  239. 'params': list(),
  240. 'idx' : idx }
  241. result[name]['params'].append(p)
  242. idx += 1
  243. return result
  244. class ModelFrame(wx.Frame):
  245. def __init__(self, parent, id = wx.ID_ANY,
  246. title = _("GRASS GIS Graphical Modeler"), **kwargs):
  247. """!Graphical modeler main window
  248. @param parent parent window
  249. @param id window id
  250. @param title window title
  251. @param kwargs wx.Frames' arguments
  252. """
  253. self.parent = parent
  254. self.searchDialog = None # module search dialog
  255. self.baseTitle = title
  256. self.modelFile = None # loaded model
  257. self.modelChanged = False
  258. self.properties = None
  259. self.cursors = {
  260. "default" : wx.StockCursor(wx.CURSOR_ARROW),
  261. "cross" : wx.StockCursor(wx.CURSOR_CROSS),
  262. }
  263. wx.Frame.__init__(self, parent = parent, id = id, title = title, **kwargs)
  264. self.SetName("Modeler")
  265. self.SetIcon(wx.Icon(os.path.join(globalvar.ETCICONDIR, 'grass.ico'), wx.BITMAP_TYPE_ICO))
  266. self.menubar = menu.Menu(parent = self, data = menudata.ModelerData())
  267. self.SetMenuBar(self.menubar)
  268. self.toolbar = toolbars.ModelToolbar(parent = self)
  269. self.SetToolBar(self.toolbar)
  270. self.statusbar = self.CreateStatusBar(number = 1)
  271. self.notebook = FN.FlatNotebook(parent = self, id = wx.ID_ANY,
  272. style = FN.FNB_FANCY_TABS | FN.FNB_BOTTOM |
  273. FN.FNB_NO_NAV_BUTTONS | FN.FNB_NO_X_BUTTON)
  274. self.canvas = ModelCanvas(self)
  275. self.canvas.SetBackgroundColour(wx.WHITE)
  276. self.canvas.SetCursor(self.cursors["default"])
  277. self.model = Model(self.canvas)
  278. self.goutput = goutput.GMConsole(parent = self, pageid = 1,
  279. notebook = self.notebook)
  280. self.modelPage = self.notebook.AddPage(self.canvas, text=_('Model'))
  281. self.commandPage = self.notebook.AddPage(self.goutput, text=_('Command output'))
  282. wx.CallAfter(self.notebook.SetSelection, 0)
  283. self.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
  284. self._layout()
  285. self.SetMinSize((350, 200))
  286. self.SetSize((640, 480))
  287. # fix goutput's pane size
  288. if self.goutput:
  289. self.goutput.SetSashPosition(int(self.GetSize()[1] * .75))
  290. def _layout(self):
  291. """!Do layout"""
  292. sizer = wx.BoxSizer(wx.VERTICAL)
  293. sizer.Add(item = self.notebook, proportion = 1,
  294. flag = wx.EXPAND)
  295. self.SetAutoLayout(True)
  296. self.SetSizer(sizer)
  297. sizer.Fit(self)
  298. self.Layout()
  299. def _addEvent(self, item):
  300. """!Add event to item"""
  301. evthandler = ModelEvtHandler(self.statusbar,
  302. self)
  303. evthandler.SetShape(item)
  304. evthandler.SetPreviousHandler(item.GetEventHandler())
  305. item.SetEventHandler(evthandler)
  306. def GetCanvas(self):
  307. """!Get canvas"""
  308. return self.canvas
  309. def GetModel(self):
  310. """!Get model"""
  311. return self.model
  312. def ModelChanged(self):
  313. """!Update window title"""
  314. if not self.modelChanged:
  315. self.modelChanged = True
  316. if self.modelFile:
  317. self.SetTitle(self.baseTitle + " - " + os.path.basename(self.modelFile) + '*')
  318. def OnRemoveItem(self, event):
  319. """!Remove shape
  320. """
  321. self.GetCanvas().RemoveSelected()
  322. def OnCloseWindow(self, event):
  323. """!Close window"""
  324. self.Destroy()
  325. def OnPreferences(self, event):
  326. """!Open preferences dialog"""
  327. dlg = PreferencesDialog(parent = self)
  328. dlg.CenterOnParent()
  329. dlg.ShowModal()
  330. self.canvas.Refresh()
  331. def OnModelProperties(self, event):
  332. """!Model properties dialog"""
  333. dlg = PropertiesDialog(parent = self)
  334. dlg.CentreOnParent()
  335. if self.properties:
  336. dlg.Init(self.properties)
  337. else:
  338. dlg.Init({ 'name' : '',
  339. 'desc' : '',
  340. 'author' : getpass.getuser() })
  341. if dlg.ShowModal() == wx.ID_OK:
  342. self.properties = dlg.GetValues()
  343. dlg.Destroy()
  344. def OnDeleteData(self, event):
  345. """!Delete intermediate data"""
  346. rast, vect, rast3d, msg = self.model.GetIntermediateData()
  347. if not rast and not vect and not rast3d:
  348. GMessage(parent = self,
  349. message = _('Nothing to delete.'),
  350. msgType = 'info')
  351. return
  352. dlg = wx.MessageDialog(parent = self,
  353. message= _("Do you want to permanently delete data?%s" % msg),
  354. caption=_("Delete intermediate data?"),
  355. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION)
  356. ret = dlg.ShowModal()
  357. if ret == wx.ID_YES:
  358. dlg.Destroy()
  359. if rast:
  360. self.goutput.RunCmd(['g.remove', 'rast=%s' %','.join(rast)])
  361. if rast3d:
  362. self.goutput.RunCmd(['g.remove', 'rast3d=%s' %','.join(rast3d)])
  363. if vect:
  364. self.goutput.RunCmd(['g.remove', 'vect=%s' %','.join(vect)])
  365. self.SetStatusText(_("%d maps deleted from current mapset") % \
  366. int(len(rast) + len(rast3d) + len(vect)))
  367. return
  368. dlg.Destroy()
  369. def OnModelNew(self, event):
  370. """!Create new model"""
  371. Debug.msg(4, "ModelFrame.OnModelNew():")
  372. # ask user to save current model
  373. if self.modelFile and self.modelChanged:
  374. self.OnModelSave()
  375. elif self.modelFile is None and \
  376. (len(self.model.GetActions()) > 0 or len(self.model.GetData()) > 0):
  377. dlg = wx.MessageDialog(self, message=_("Current model is not empty. "
  378. "Do you want to store current settings "
  379. "to model file?"),
  380. caption=_("Create new model?"),
  381. style=wx.YES_NO | wx.YES_DEFAULT |
  382. wx.CANCEL | wx.ICON_QUESTION)
  383. ret = dlg.ShowModal()
  384. if ret == wx.ID_YES:
  385. self.OnModelSaveAs()
  386. elif ret == wx.ID_CANCEL:
  387. dlg.Destroy()
  388. return
  389. dlg.Destroy()
  390. # delete all items
  391. self.canvas.GetDiagram().DeleteAllShapes()
  392. self.model.Reset()
  393. self.canvas.Refresh()
  394. # no model file loaded
  395. self.modelFile = None
  396. self.modelChanged = False
  397. self.SetTitle(self.baseTitle)
  398. def OnModelOpen(self, event):
  399. """!Load model from file"""
  400. filename = ''
  401. dlg = wx.FileDialog(parent = self, message=_("Choose model file"),
  402. defaultDir = os.getcwd(),
  403. wildcard=_("GRASS Model File (*.gxm)|*.gxm"))
  404. if dlg.ShowModal() == wx.ID_OK:
  405. filename = dlg.GetPath()
  406. if not filename:
  407. return
  408. Debug.msg(4, "ModelFrame.OnModelOpen(): filename=%s" % filename)
  409. # close current model
  410. self.OnModelClose()
  411. self.LoadModelFile(filename)
  412. self.modelFile = filename
  413. self.SetTitle(self.baseTitle + " - " + os.path.basename(self.modelFile))
  414. self.SetStatusText(_('%d actions loaded into model') % len(self.model.GetActions()), 0)
  415. def OnModelSave(self, event = None):
  416. """!Save model to file"""
  417. if self.modelFile and self.modelChanged:
  418. dlg = wx.MessageDialog(self, message=_("Model file <%s> already exists. "
  419. "Do you want to overwrite this file?") % \
  420. self.modelFile,
  421. caption=_("Save model"),
  422. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION)
  423. if dlg.ShowModal() == wx.ID_NO:
  424. dlg.Destroy()
  425. else:
  426. Debug.msg(4, "ModelFrame.OnModelSave(): filename=%s" % self.modelFile)
  427. self.WriteModelFile(self.modelFile)
  428. self.SetStatusText(_('File <%s> saved') % self.modelFile, 0)
  429. self.SetTitle(self.baseTitle + " - " + os.path.basename(self.modelFile))
  430. elif not self.modelFile:
  431. self.OnModelSaveAs(None)
  432. def OnModelSaveAs(self, event):
  433. """!Create model to file as"""
  434. filename = ''
  435. dlg = wx.FileDialog(parent = self,
  436. message = _("Choose file to save current model"),
  437. defaultDir = os.getcwd(),
  438. wildcard=_("GRASS Model File (*.gxm)|*.gxm"),
  439. style=wx.FD_SAVE)
  440. if dlg.ShowModal() == wx.ID_OK:
  441. filename = dlg.GetPath()
  442. if not filename:
  443. return
  444. # check for extension
  445. if filename[-4:] != ".gxm":
  446. filename += ".gxm"
  447. if os.path.exists(filename):
  448. dlg = wx.MessageDialog(parent = self,
  449. message=_("Model file <%s> already exists. "
  450. "Do you want to overwrite this file?") % filename,
  451. caption=_("File already exists"),
  452. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION)
  453. if dlg.ShowModal() != wx.ID_YES:
  454. dlg.Destroy()
  455. return
  456. Debug.msg(4, "GMFrame.OnModelSaveAs(): filename=%s" % filename)
  457. self.WriteModelFile(filename)
  458. self.modelFile = filename
  459. self.SetTitle(self.baseTitle + " - " + os.path.basename(self.modelFile))
  460. self.SetStatusText(_('File <%s> saved') % self.modelFile, 0)
  461. def OnModelClose(self, event = None):
  462. """!Close model file"""
  463. Debug.msg(4, "ModelFrame.OnModelClose(): file=%s" % self.modelFile)
  464. # ask user to save current model
  465. if self.modelFile and self.modelChanged:
  466. self.OnModelSave()
  467. elif self.modelFile is None and \
  468. (len(self.model.GetActions()) > 0 or len(self.model.GetData()) > 0):
  469. dlg = wx.MessageDialog(self, message=_("Current model is not empty. "
  470. "Do you want to store current settings "
  471. "to model file?"),
  472. caption=_("Create new model?"),
  473. style=wx.YES_NO | wx.YES_DEFAULT |
  474. wx.CANCEL | wx.ICON_QUESTION)
  475. ret = dlg.ShowModal()
  476. if ret == wx.ID_YES:
  477. self.OnModelSaveAs()
  478. elif ret == wx.ID_CANCEL:
  479. dlg.Destroy()
  480. return
  481. dlg.Destroy()
  482. self.modelFile = None
  483. self.SetTitle(self.baseTitle)
  484. self.canvas.GetDiagram().DeleteAllShapes()
  485. self.model.Reset()
  486. self.canvas.Refresh()
  487. def OnRunModel(self, event):
  488. """!Run entire model"""
  489. if len(self.model.GetActions()) < 1:
  490. GMessage(parent = self,
  491. message = _('Model is empty. Nothing to run.'),
  492. msgType = 'info')
  493. return
  494. # validation
  495. errList = self._validateModel()
  496. if errList:
  497. dlg = wx.MessageDialog(parent = self,
  498. message = _('Model is not valid. Do you want to '
  499. 'run the model anyway?\n\n%s') % '\n'.join(errList),
  500. caption=_("Run model?"),
  501. style = wx.YES_NO | wx.NO_DEFAULT |
  502. wx.ICON_QUESTION | wx.CENTRE)
  503. ret = dlg.ShowModal()
  504. if ret != wx.ID_YES:
  505. return
  506. # parametrization
  507. params = self.model.Parametrize()
  508. if params:
  509. dlg = ModelParamDialog(parent = self,
  510. params = params)
  511. dlg.CenterOnParent()
  512. ret = dlg.ShowModal()
  513. if ret != wx.ID_OK:
  514. dlg.Destroy()
  515. return
  516. self.goutput.cmdThread.SetId(-1)
  517. for action in self.model.GetActions():
  518. name = action.GetName()
  519. if params.has_key(name):
  520. paramsOrig = action.GetParams(dcopy = True)
  521. action.MergeParams(params[name])
  522. self.SetStatusText(_('Running model...'), 0)
  523. self.goutput.RunCmd(command = action.GetLog(string = False),
  524. onDone = self.OnDone)
  525. if params.has_key(name):
  526. action.SetParams(paramsOrig)
  527. if params:
  528. dlg.Destroy()
  529. def OnDone(self, returncode):
  530. """!Computation finished"""
  531. self.SetStatusText('', 0)
  532. def OnValidateModel(self, event, showMsg = True):
  533. """!Validate entire model"""
  534. if len(self.model.GetActions()) < 1:
  535. GMessage(parent = self,
  536. message = _('Model is empty. Nothing to validate.'),
  537. msgType = 'info')
  538. return
  539. errList = self._validateModel()
  540. if errList:
  541. GMessage(parent = self,
  542. message = _('Model is not valid.\n\n%s') % '\n'.join(errList),
  543. msgType = 'warning')
  544. else:
  545. GMessage(parent = self,
  546. message = _('Model is valid.'),
  547. msgType = 'info')
  548. def OnExportImage(self, event):
  549. """!Export model to image (default image)
  550. """
  551. xminImg = 0
  552. xmaxImg = 0
  553. yminImg = 0
  554. ymaxImg = 0
  555. for shape in self.canvas.GetDiagram().GetShapeList():
  556. w, h = shape.GetBoundingBoxMax()
  557. x = shape.GetX()
  558. y = shape.GetY()
  559. xmin = x - w / 2
  560. xmax = x + w / 2
  561. ymin = y - h / 2
  562. ymax = y + h / 2
  563. if xmin < xminImg:
  564. xminImg = xmin
  565. if xmax > xmaxImg:
  566. xmaxImg = xmax
  567. if ymin < yminImg:
  568. xminImg = xmin
  569. if ymax < ymaxImg:
  570. xminImg = xmin
  571. size = wx.Size(int(xmaxImg - xminImg),
  572. int(ymaxImg - ymaxImg))
  573. bitmap = wx.EmptyBitmap(width = size.width, height = size.height)
  574. filetype, ltype = GetImageHandlers(wx.ImageFromBitmap(bitmap))
  575. dlg = wx.FileDialog(parent = self,
  576. message = _("Choose a file name to save the image (no need to add extension)"),
  577. defaultDir = "",
  578. defaultFile = "",
  579. wildcard = filetype,
  580. style=wx.SAVE | wx.FD_OVERWRITE_PROMPT)
  581. if dlg.ShowModal() == wx.ID_OK:
  582. path = dlg.GetPath()
  583. if not path:
  584. dlg.Destroy()
  585. return
  586. base, ext = os.path.splitext(path)
  587. fileType = ltype[dlg.GetFilterIndex()]['type']
  588. extType = ltype[dlg.GetFilterIndex()]['ext']
  589. if ext != extType:
  590. path = base + '.' + extType
  591. dc = wx.MemoryDC(bitmap)
  592. dc.SetBackground(wx.WHITE_BRUSH)
  593. dc.SetBackgroundMode(wx.SOLID)
  594. dc.BeginDrawing()
  595. self.canvas.GetDiagram().Clear(dc)
  596. self.canvas.GetDiagram().Redraw(dc)
  597. dc.EndDrawing()
  598. bitmap.SaveFile(path, fileType)
  599. self.SetStatusText(_("Model exported to <%s>") % path)
  600. dlg.Destroy()
  601. def OnExportPython(self, event):
  602. """!Export model to Python script"""
  603. filename = ''
  604. dlg = wx.FileDialog(parent = self,
  605. message = _("Choose file to save"),
  606. defaultDir = os.getcwd(),
  607. wildcard=_("Python script (*.py)|*.py"),
  608. style=wx.FD_SAVE)
  609. if dlg.ShowModal() == wx.ID_OK:
  610. filename = dlg.GetPath()
  611. if not filename:
  612. return
  613. # check for extension
  614. if filename[-3:] != ".py":
  615. filename += ".py"
  616. if os.path.exists(filename):
  617. dlg = wx.MessageDialog(self, message=_("File <%s> already exists. "
  618. "Do you want to overwrite this file?") % filename,
  619. caption=_("Save file"),
  620. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION)
  621. if dlg.ShowModal() == wx.ID_NO:
  622. dlg.Destroy()
  623. return
  624. dlg.Destroy()
  625. fd = open(filename, "w")
  626. try:
  627. self._writePython(fd)
  628. finally:
  629. fd.close()
  630. # executable file
  631. os.chmod(filename, stat.S_IRWXU | stat.S_IWUSR)
  632. self.SetStatusText(_("Model exported to <%s>") % filename)
  633. def _writePython(self, fd):
  634. """!Write model to file"""
  635. if self.properties:
  636. properties = self.properties
  637. else:
  638. properties = { 'name' : _("Graphical modeler script"),
  639. 'desc' : _("Script generated by wxGUI Graphical Modeler"),
  640. 'author' : getpass.getuser() }
  641. fd.write(
  642. r"""#!/usr/bin/env python
  643. #
  644. ############################################################################
  645. #
  646. # MODULE: %s
  647. #
  648. # AUTHOR(S): %s
  649. #
  650. # PURPOSE: %s
  651. #
  652. # DATE: %s
  653. #
  654. #############################################################################
  655. """ % (properties['name'],
  656. properties['author'],
  657. properties['desc'],
  658. time.asctime()))
  659. fd.write(
  660. r"""
  661. import sys
  662. import os
  663. import grass.script as grass
  664. import atexit
  665. """)
  666. fd.write(
  667. r"""
  668. def cleanup():
  669. pass
  670. """)
  671. fd.write("\ndef main():\n")
  672. for action in self.model.GetActions():
  673. task = menuform.GUI().ParseCommand(cmd = action.GetLog(string = False),
  674. show = None)
  675. opts = task.get_options()
  676. flags = ''
  677. params = list()
  678. strcmd = " grass.run_command("
  679. indent = len(strcmd)
  680. fd.write(strcmd + "'%s',\n" % task.get_name())
  681. for f in opts['flags']:
  682. if f.get('value', False) == True:
  683. name = f.get('name', '')
  684. if len(name) > 1:
  685. params.append('%s=True' % name)
  686. else:
  687. flags += name
  688. for p in opts['params']:
  689. name = p.get('name', None)
  690. value = p.get('value', None)
  691. if name and value:
  692. ptype = p.get('type', 'string')
  693. if ptype == 'string':
  694. params.append("%s='%s'" % (name, value))
  695. else:
  696. params.append("%s=%s" % (name, value))
  697. for opt in params[:-1]:
  698. fd.write("%s%s,\n" % (' ' * indent, opt))
  699. fd.write("%s%s)\n" % (' ' * indent, params[-1]))
  700. fd.write("\n return 0\n")
  701. fd.write(
  702. r"""
  703. if __name__ == "__main__":
  704. options, flags = grass.parser()
  705. atexit.register(cleanup)
  706. sys.exit(main())
  707. """)
  708. def _validateModel(self):
  709. """!Validate model"""
  710. self.SetStatusText(_('Validating model...'), 0)
  711. errList = self.model.Validate()
  712. self.SetStatusText('', 0)
  713. return errList
  714. def OnDefineRelation(self, event):
  715. """!Define relation between data and action items"""
  716. self.canvas.SetCursor(self.cursors["cross"])
  717. self.defineRelation = { 'from' : None,
  718. 'to' : None }
  719. def OnAddAction(self, event):
  720. """!Add action to model"""
  721. if self.searchDialog is None:
  722. self.searchDialog = ModelSearchDialog(self)
  723. self.searchDialog.CentreOnParent()
  724. else:
  725. self.searchDialog.Reset()
  726. if self.searchDialog.ShowModal() == wx.ID_CANCEL:
  727. self.searchDialog.Hide()
  728. return
  729. cmd = self.searchDialog.GetCmd()
  730. self.searchDialog.Hide()
  731. self.ModelChanged()
  732. # add action to canvas
  733. width, height = self.canvas.GetSize()
  734. action = ModelAction(self, cmd = cmd, x = width/2, y = height/2)
  735. self.canvas.diagram.AddShape(action)
  736. action.Show(True)
  737. self._addEvent(action)
  738. self.model.AddAction(action)
  739. self.canvas.Refresh()
  740. time.sleep(.1)
  741. # show properties dialog
  742. win = action.GetPropDialog()
  743. if not win and action.GetLog(string = False):
  744. module = menuform.GUI().ParseCommand(action.GetLog(string = False),
  745. completed = (self.GetOptData, action, action.GetParams()),
  746. parentframe = self, show = True)
  747. elif win and not win.IsShown():
  748. win.Show()
  749. if win:
  750. win.Raise()
  751. def OnAddData(self, event):
  752. """!Add data item to model"""
  753. # add action to canvas
  754. width, height = self.canvas.GetSize()
  755. data = ModelData(self, x = width/2, y = height/2)
  756. self.canvas.diagram.AddShape(data)
  757. data.Show(True)
  758. self._addEvent(data)
  759. self.model.AddData(data)
  760. self.canvas.Refresh()
  761. def OnHelp(self, event):
  762. """!Display manual page"""
  763. grass.run_command('g.manual',
  764. entry = 'wxGUI.Modeler')
  765. def OnAbout(self, event):
  766. """!Display About window"""
  767. info = wx.AboutDialogInfo()
  768. info.SetIcon(wx.Icon(os.path.join(globalvar.ETCICONDIR, 'grass.ico'), wx.BITMAP_TYPE_ICO))
  769. info.SetName(_('wxGUI Graphical Modeler'))
  770. info.SetWebSite('http://grass.osgeo.org')
  771. info.SetDescription(_('(C) 2010 by the GRASS Development Team\n\n') +
  772. '\n'.join(textwrap.wrap(_('This program is free software under the GNU General Public License'
  773. '(>=v2). Read the file COPYING that comes with GRASS for details.'), 75)))
  774. wx.AboutBox(info)
  775. def GetOptData(self, dcmd, layer, params, propwin):
  776. """!Process action data"""
  777. if params: # add data items
  778. for p in params['params']:
  779. if p.get('prompt', '') in ('raster', 'vector', 'raster3d'):
  780. try:
  781. name, mapset = p.get('value', '').split('@', 1)
  782. except (ValueError, IndexError):
  783. continue
  784. if mapset != grass.gisenv()['MAPSET']:
  785. continue
  786. # don't use fully qualified names
  787. p['value'] = p.get('value', '').split('@')[0]
  788. for idx in range(1, len(dcmd)):
  789. if p.get('name', '') in dcmd[idx]:
  790. dcmd[idx] = p.get('name', '') + '=' + p.get('value', '')
  791. break
  792. width, height = self.canvas.GetSize()
  793. x = [width/2 + 200, width/2 - 200]
  794. for p in params['params']:
  795. if p.get('prompt', '') in ('raster', 'vector', 'raster3d') and \
  796. (p.get('value', None) or \
  797. p.get('age', 'old') != 'old'):
  798. data = layer.FindData(p.get('name', ''))
  799. if data:
  800. data.SetValue(p.get('value', ''))
  801. continue
  802. data = self.model.FindData(p.get('value', ''),
  803. p.get('prompt', ''))
  804. if data:
  805. if p.get('age', 'old') == 'old':
  806. rel = ModelRelation(data, layer)
  807. data.AddRelation(rel, direction = 'from')
  808. self.AddLine(rel)
  809. else:
  810. rel = ModelRelation(layer, data)
  811. data.AddRelation(rel, direction = 'to')
  812. self.AddLine(rel)
  813. continue
  814. data = ModelData(self, name = p.get('name', ''),
  815. value = p.get('value', ''),
  816. prompt = p.get('prompt', ''),
  817. x = x.pop(), y = height/2)
  818. layer.AddData(data)
  819. self.canvas.diagram.AddShape(data)
  820. data.Show(True)
  821. self._addEvent(data)
  822. self.model.AddData(data)
  823. if p.get('age', 'old') == 'old':
  824. rel = ModelRelation(data, layer)
  825. data.AddRelation(rel, direction = 'from')
  826. self.AddLine(rel)
  827. else:
  828. rel = ModelRelation(layer, data)
  829. data.AddRelation(rel, direction = 'to')
  830. self.AddLine(rel)
  831. # valid ?
  832. valid = True
  833. for p in params['params']:
  834. if p.get('value', '') == '' and \
  835. p.get('default', '') == '':
  836. valid = False
  837. break
  838. layer.SetValid(valid)
  839. self.canvas.Refresh()
  840. if dcmd:
  841. layer.SetProperties(params, propwin)
  842. self.SetStatusText(layer.GetLog(), 0)
  843. def AddLine(self, rel):
  844. """!Add connection
  845. @param rel relation
  846. """
  847. fromShape = rel.GetFrom()
  848. toShape = rel.GetTo()
  849. rel.SetCanvas(self)
  850. rel.SetPen(wx.BLACK_PEN)
  851. rel.SetBrush(wx.BLACK_BRUSH)
  852. rel.AddArrow(ogl.ARROW_ARROW)
  853. points = rel.GetControlPoints()
  854. rel.MakeLineControlPoints(2)
  855. if points:
  856. for x, y in points:
  857. rel.InsertLineControlPoint(point = wx.RealPoint(x, y))
  858. self._addEvent(rel)
  859. fromShape.AddLine(rel, toShape)
  860. self.canvas.diagram.AddShape(rel)
  861. rel.Show(True)
  862. def LoadModelFile(self, filename):
  863. """!Load model definition stored in GRASS Model XML file (gxm)
  864. """
  865. try:
  866. self.model.LoadModel(filename)
  867. except GError, e:
  868. GMessage(parent = self,
  869. message = _("Reading model file <%s> failed.\n"
  870. "Invalid file, unable to parse XML document.") % filename)
  871. self.modelFile = filename
  872. self.SetTitle(self.baseTitle + " - " + os.path.basename(self.modelFile))
  873. self.SetStatusText(_("Please wait, loading model..."), 0)
  874. # load actions
  875. for action in self.model.GetActions():
  876. self._addEvent(action)
  877. self.canvas.diagram.AddShape(action)
  878. action.Show(True)
  879. # load data & relations
  880. for data in self.model.GetData():
  881. self._addEvent(data)
  882. self.canvas.diagram.AddShape(data)
  883. data.Show(True)
  884. for rel in data.GetRelations():
  885. self.AddLine(rel)
  886. self.SetStatusText('', 0)
  887. self.canvas.Refresh(True)
  888. def WriteModelFile(self, filename):
  889. """!Save model to model file, recover original file on error.
  890. @return True on success
  891. @return False on failure
  892. """
  893. tmpfile = tempfile.TemporaryFile(mode='w+b')
  894. try:
  895. WriteModelFile(fd = tmpfile,
  896. actions = self.model.GetActions(),
  897. data = self.model.GetData())
  898. except StandardError:
  899. GMessage(parent = self,
  900. message = _("Writing current settings to model file failed."))
  901. return False
  902. try:
  903. mfile = open(filename, "w")
  904. tmpfile.seek(0)
  905. for line in tmpfile.readlines():
  906. mfile.write(line)
  907. except IOError:
  908. wx.MessageBox(parent = self,
  909. message = _("Unable to open file <%s> for writing.") % filename,
  910. caption = _("Error"),
  911. style = wx.OK | wx.ICON_ERROR | wx.CENTRE)
  912. return False
  913. mfile.close()
  914. return True
  915. class ModelCanvas(ogl.ShapeCanvas):
  916. """!Canvas where model is drawn"""
  917. def __init__(self, parent):
  918. self.parent = parent
  919. ogl.OGLInitialize()
  920. ogl.ShapeCanvas.__init__(self, parent)
  921. self.diagram = ogl.Diagram()
  922. self.SetDiagram(self.diagram)
  923. self.diagram.SetCanvas(self)
  924. self.SetScrollbars(20, 20, 1000/20, 1000/20)
  925. self.Bind(wx.EVT_CHAR, self.OnChar)
  926. def OnChar(self, event):
  927. """!Key pressed"""
  928. kc = event.GetKeyCode()
  929. diagram = self.GetDiagram()
  930. if kc == wx.WXK_DELETE:
  931. self.RemoveSelected()
  932. def RemoveSelected(self):
  933. """!Remove selected shapes"""
  934. self.parent.ModelChanged()
  935. diagram = self.GetDiagram()
  936. for shape in diagram.GetShapeList():
  937. if not shape.Selected():
  938. continue
  939. self.parent.GetModel().RemoveItem(shape)
  940. shape.Select(False)
  941. diagram.RemoveShape(shape)
  942. self.Refresh()
  943. class ModelAction(ogl.RectangleShape):
  944. """!Action class (GRASS module)"""
  945. def __init__(self, parent, x, y, cmd = None, task = None, width = None, height = None):
  946. self.parent = parent
  947. self.task = task
  948. if not width:
  949. width = UserSettings.Get(group='modeler', key='action', subkey=('size', 'width'))
  950. if not height:
  951. height = UserSettings.Get(group='modeler', key='action', subkey=('size', 'height'))
  952. if cmd:
  953. self.task = menuform.GUI().ParseCommand(cmd = cmd,
  954. show = None)
  955. else:
  956. if task:
  957. self.task = task
  958. else:
  959. self.task = None
  960. self.propWin = None
  961. self.id = -1 # used for gxm file
  962. self.data = list() # list of connected data items
  963. self.isValid = False
  964. if self.parent.GetCanvas():
  965. ogl.RectangleShape.__init__(self, width, height)
  966. self.SetCanvas(self.parent)
  967. self.SetX(x)
  968. self.SetY(y)
  969. self.SetPen(wx.BLACK_PEN)
  970. self._setBrush(False)
  971. cmd = self.task.getCmd(ignoreErrors = True)
  972. if cmd and len(cmd) > 0:
  973. self.AddText(cmd[0])
  974. else:
  975. self.AddText('<<%s>>' % _("module"))
  976. def _setBrush(self, isvalid):
  977. """!Set brush"""
  978. if isvalid is None:
  979. color = UserSettings.Get(group='modeler', key='action',
  980. subkey=('color', 'running'))
  981. elif isvalid:
  982. color = UserSettings.Get(group='modeler', key='action',
  983. subkey=('color', 'valid'))
  984. else:
  985. color = UserSettings.Get(group='modeler', key='action',
  986. subkey=('color', 'invalid'))
  987. wxColor = wx.Color(color[0], color[1], color[2])
  988. self.SetBrush(wx.Brush(wxColor))
  989. def GetId(self):
  990. """!Get id"""
  991. return self.id
  992. def SetId(self, id):
  993. """!Set id"""
  994. self.id = id
  995. def SetProperties(self, params, propwin):
  996. """!Record properties dialog"""
  997. self.task.params = params['params']
  998. self.task.flags = params['flags']
  999. self.propWin = propwin
  1000. def GetPropDialog(self):
  1001. """!Get properties dialog"""
  1002. return self.propWin
  1003. def GetLog(self, string = True):
  1004. """!Get logging info"""
  1005. cmd = self.task.getCmd(ignoreErrors = True)
  1006. if string:
  1007. if cmd is None:
  1008. return ''
  1009. else:
  1010. return ' '.join(cmd)
  1011. return cmd
  1012. def GetName(self):
  1013. """!Get name"""
  1014. cmd = self.task.getCmd(ignoreErrors = True)
  1015. if cmd and len(cmd) > 0:
  1016. return cmd[0]
  1017. return _('unknown')
  1018. def GetParams(self, dcopy = False):
  1019. """!Get dictionary of parameters"""
  1020. if dcopy:
  1021. return copy.deepcopy(self.task.get_options())
  1022. return self.task.get_options()
  1023. def SetParams(self, params):
  1024. """!Set dictionary of parameters"""
  1025. self.task.params = params['params']
  1026. self.task.flags = params['flags']
  1027. def MergeParams(self, params):
  1028. """!Merge dictionary of parameters"""
  1029. for f in params['flags']:
  1030. self.task.set_flag(f['name'],
  1031. f.get('value', False))
  1032. for p in params['params']:
  1033. self.task.set_param(p['name'],
  1034. p.get('value', ''))
  1035. def SetValid(self, isvalid):
  1036. """!Set instance to be valid/invalid"""
  1037. self.isValid = isvalid
  1038. self._setBrush(isvalid)
  1039. def AddData(self, item):
  1040. """!Register new data item"""
  1041. if item not in self.data:
  1042. self.data.append(item)
  1043. def FindData(self, name):
  1044. """!Find data item by name"""
  1045. for d in self.data:
  1046. if d.GetName() == name:
  1047. return d
  1048. return None
  1049. def Update(self, running = False):
  1050. """!Update action"""
  1051. if running:
  1052. self._setBrush(None)
  1053. else:
  1054. self._setBrush(self.isValid)
  1055. class ModelData(ogl.EllipseShape):
  1056. """!Data item class"""
  1057. def __init__(self, parent, x, y, name = '', value = '', prompt = '', width = None, height = None):
  1058. self.parent = parent
  1059. self.name = name
  1060. self.value = value
  1061. self.prompt = prompt
  1062. self.intermediate = False
  1063. self.propWin = None
  1064. if not width:
  1065. width = UserSettings.Get(group='modeler', key='data', subkey=('size', 'width'))
  1066. if not height:
  1067. height = UserSettings.Get(group='modeler', key='data', subkey=('size', 'height'))
  1068. self.rels = { 'from' : list(), 'to' : list() } # list of recorded relations
  1069. if self.parent.GetCanvas():
  1070. ogl.EllipseShape.__init__(self, width, height)
  1071. self.SetCanvas(self.parent)
  1072. self.SetX(x)
  1073. self.SetY(y)
  1074. self.SetPen(wx.BLACK_PEN)
  1075. self._setBrush()
  1076. if name:
  1077. self.AddText(name)
  1078. else:
  1079. self.AddText(_('unknown'))
  1080. if value:
  1081. self.AddText(value)
  1082. else:
  1083. self.AddText('\n')
  1084. def IsIntermediate(self):
  1085. """!Checks if data item is intermediate"""
  1086. return self.intermediate
  1087. def SetIntermediate(self, im):
  1088. """!Set intermediate flag"""
  1089. self.intermediate = im
  1090. def OnDraw(self, dc):
  1091. pen = self.GetPen()
  1092. if self.intermediate:
  1093. pen.SetStyle(wx.SHORT_DASH)
  1094. else:
  1095. pen.SetStyle(wx.SOLID)
  1096. self.SetPen(pen)
  1097. ogl.EllipseShape.OnDraw(self, dc)
  1098. def GetLog(self, string = True):
  1099. """!Get logging info"""
  1100. if self.name:
  1101. return self.name + '=' + self.value + ' (' + self.prompt + ')'
  1102. else:
  1103. return _('unknown')
  1104. def GetName(self):
  1105. """!Get name"""
  1106. return self.name
  1107. def GetPrompt(self):
  1108. """!Get prompt"""
  1109. return self.prompt
  1110. def GetValue(self):
  1111. """!Get value"""
  1112. return self.value
  1113. def SetValue(self, value):
  1114. """!Set value"""
  1115. self.value = value
  1116. self.ClearText()
  1117. self.AddText(self.name)
  1118. if value:
  1119. self.AddText(self.value)
  1120. else:
  1121. self.AddText('\n')
  1122. for direction in ('from', 'to'):
  1123. for rel in self.rels[direction]:
  1124. if direction == 'from':
  1125. action = rel.GetTo()
  1126. else:
  1127. action = rel.GetFrom()
  1128. task = menuform.GUI().ParseCommand(cmd = action.GetLog(string = False),
  1129. show = None)
  1130. task.set_param(self.name, self.value)
  1131. action.SetParams(params = task.get_options())
  1132. def GetRelations(self, direction = None):
  1133. """!Get relations from/to"""
  1134. if not direction:
  1135. return self.rels['from'] + self.rels['to']
  1136. return self.rels[direction]
  1137. def AddRelation(self, rel, direction):
  1138. """!Record new relation
  1139. @param direction direction - 'from' or 'to'
  1140. """
  1141. self.rels[direction].append(rel)
  1142. def GetPropDialog(self):
  1143. """!Get properties dialog"""
  1144. return self.propWin
  1145. def SetPropDialog(self, win):
  1146. """!Get properties dialog"""
  1147. self.propWin = win
  1148. def _setBrush(self):
  1149. """!Set brush"""
  1150. if self.prompt == 'raster':
  1151. color = UserSettings.Get(group='modeler', key='data',
  1152. subkey=('color', 'raster'))
  1153. elif self.prompt == 'raster3d':
  1154. color = UserSettings.Get(group='modeler', key='data',
  1155. subkey=('color', 'raster3d'))
  1156. elif self.prompt == 'vector':
  1157. color = UserSettings.Get(group='modeler', key='data',
  1158. subkey=('color', 'vector'))
  1159. else:
  1160. color = UserSettings.Get(group='modeler', key='action',
  1161. subkey=('color', 'invalid'))
  1162. wxColor = wx.Color(color[0], color[1], color[2])
  1163. self.SetBrush(wx.Brush(wxColor))
  1164. def Update(self):
  1165. """!Update action"""
  1166. self._setBrush()
  1167. class ModelDataDialog(ElementDialog):
  1168. """!Data item properties dialog"""
  1169. def __init__(self, parent, shape, id = wx.ID_ANY, title = _("Data properties"),
  1170. style = wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER):
  1171. self.parent = parent
  1172. self.shape = shape
  1173. prompt = shape.GetPrompt()
  1174. if prompt == 'raster':
  1175. label = _('Name of raster map:')
  1176. elif prompt == 'vector':
  1177. label = _('Name of vector map:')
  1178. else:
  1179. label = _('Name of element:')
  1180. ElementDialog.__init__(self, parent, title, label = label)
  1181. self.element = gselect.Select(parent = self.panel, id = wx.ID_ANY,
  1182. size = globalvar.DIALOG_GSELECT_SIZE,
  1183. type = prompt)
  1184. self.element.SetValue(shape.GetValue())
  1185. self.Bind(wx.EVT_BUTTON, self.OnOK, self.btnOK)
  1186. self.Bind(wx.EVT_BUTTON, self.OnCancel, self.btnCancel)
  1187. self.PostInit()
  1188. self._layout()
  1189. self.SetMinSize(self.GetSize())
  1190. def _layout(self):
  1191. """!Do layout"""
  1192. self.dataSizer.Add(self.element, proportion=0,
  1193. flag=wx.EXPAND | wx.ALL, border=1)
  1194. self.panel.SetSizer(self.sizer)
  1195. self.sizer.Fit(self)
  1196. def OnOK(self, event):
  1197. """!Ok pressed"""
  1198. self.shape.SetValue(self.GetElement())
  1199. self.parent.canvas.Refresh()
  1200. self.parent.SetStatusText('', 0)
  1201. self.OnCancel(event)
  1202. def OnCancel(self, event):
  1203. """!Cancel pressed"""
  1204. self.shape.SetPropDialog(None)
  1205. self.Destroy()
  1206. class ModelEvtHandler(ogl.ShapeEvtHandler):
  1207. """!Model event handler class"""
  1208. def __init__(self, log, frame):
  1209. ogl.ShapeEvtHandler.__init__(self)
  1210. self.log = log
  1211. self.frame = frame
  1212. self.x = self.y = None
  1213. def OnLeftClick(self, x, y, keys = 0, attachment = 0):
  1214. """!Left mouse button pressed -> select item & update statusbar"""
  1215. shape = self.GetShape()
  1216. canvas = shape.GetCanvas()
  1217. dc = wx.ClientDC(canvas)
  1218. canvas.PrepareDC(dc)
  1219. if hasattr(self.frame, 'defineRelation'):
  1220. drel = self.frame.defineRelation
  1221. if drel['from'] is None:
  1222. drel['from'] = shape
  1223. elif drel['to'] is None:
  1224. drel['to'] = shape
  1225. rel = ModelRelation(drel['from'], drel['to'])
  1226. self.frame.AddLine(rel)
  1227. del self.frame.defineRelation
  1228. if shape.Selected():
  1229. shape.Select(False, dc)
  1230. else:
  1231. redraw = False
  1232. shapeList = canvas.GetDiagram().GetShapeList()
  1233. toUnselect = list()
  1234. for s in shapeList:
  1235. if s.Selected():
  1236. toUnselect.append(s)
  1237. shape.Select(True, dc)
  1238. for s in toUnselect:
  1239. s.Select(False, dc)
  1240. canvas.Refresh(False)
  1241. if hasattr(shape, "GetLog"):
  1242. self.log.SetStatusText(shape.GetLog(), 0)
  1243. def OnLeftDoubleClick(self, x, y, keys = 0, attachment = 0):
  1244. """!Left mouse button pressed (double-click) -> show properties"""
  1245. self.OnProperties()
  1246. def OnProperties(self, event = None):
  1247. """!Show properties dialog"""
  1248. self.frame.ModelChanged()
  1249. shape = self.GetShape()
  1250. if isinstance(shape, ModelAction):
  1251. module = menuform.GUI().ParseCommand(shape.GetLog(string = False),
  1252. completed = (self.frame.GetOptData, shape, shape.GetParams()),
  1253. parentframe = self.frame, show = True)
  1254. elif isinstance(shape, ModelData):
  1255. dlg = ModelDataDialog(parent = self.frame, shape = shape)
  1256. shape.SetPropDialog(dlg)
  1257. dlg.CentreOnParent()
  1258. dlg.Show()
  1259. def OnBeginDragLeft(self, x, y, keys = 0, attachment = 0):
  1260. """!Drag shape"""
  1261. self.frame.ModelChanged()
  1262. if self._previousHandler:
  1263. self._previousHandler.OnBeginDragLeft(x, y, keys, attachment)
  1264. def OnRightClick(self, x, y, keys = 0, attachment = 0):
  1265. """!Right click -> pop-up menu"""
  1266. if not hasattr (self, "popupID1"):
  1267. self.popupID1 = wx.NewId()
  1268. self.popupID2 = wx.NewId()
  1269. self.popupID3 = wx.NewId()
  1270. # record coordinates
  1271. self.x = x
  1272. self.y = y
  1273. shape = self.GetShape()
  1274. popupMenu = wx.Menu()
  1275. popupMenu.Append(self.popupID1, text=_('Remove'))
  1276. self.frame.Bind(wx.EVT_MENU, self.OnRemove, id = self.popupID1)
  1277. if isinstance(shape, ModelRelation):
  1278. popupMenu.AppendSeparator()
  1279. popupMenu.Append(self.popupID2, text=_('Add control point'))
  1280. self.frame.Bind(wx.EVT_MENU, self.OnAddPoint, id = self.popupID2)
  1281. popupMenu.Append(self.popupID3, text=_('Remove control point'))
  1282. self.frame.Bind(wx.EVT_MENU, self.OnRemovePoint, id = self.popupID3)
  1283. if len(shape.GetLineControlPoints()) == 2:
  1284. popupMenu.Enable(self.popupID3, False)
  1285. if isinstance(shape, ModelData) and '@' not in shape.GetValue():
  1286. popupMenu.AppendSeparator()
  1287. popupMenu.Append(self.popupID3, text=_('Intermediate'),
  1288. kind = wx.ITEM_CHECK)
  1289. if self.GetShape().IsIntermediate():
  1290. popupMenu.Check(self.popupID3, True)
  1291. self.frame.Bind(wx.EVT_MENU, self.OnIntermediate, id = self.popupID3)
  1292. if isinstance(shape, ModelData) or \
  1293. isinstance(shape, ModelAction):
  1294. popupMenu.AppendSeparator()
  1295. popupMenu.Append(self.popupID2, text=_('Properties'))
  1296. self.frame.Bind(wx.EVT_MENU, self.OnProperties, id = self.popupID2)
  1297. self.frame.PopupMenu(popupMenu)
  1298. popupMenu.Destroy()
  1299. def OnAddPoint(self, event):
  1300. """!Add control point"""
  1301. shape = self.GetShape()
  1302. shape.InsertLineControlPoint(point = wx.RealPoint(self.x, self.y))
  1303. shape.ResetShapes()
  1304. shape.Select(True)
  1305. self.frame.canvas.Refresh()
  1306. def OnRemovePoint(self, event):
  1307. """!Remove control point"""
  1308. shape = self.GetShape()
  1309. shape.DeleteLineControlPoint()
  1310. shape.Select(False)
  1311. shape.Select(True)
  1312. self.frame.canvas.Refresh()
  1313. def OnIntermediate(self, event):
  1314. """!Mark data as intermediate"""
  1315. self.frame.ModelChanged()
  1316. shape = self.GetShape()
  1317. shape.SetIntermediate(event.IsChecked())
  1318. self.frame.canvas.Refresh()
  1319. def OnRemove(self, event):
  1320. """!Remove shape
  1321. """
  1322. self.frame.GetCanvas().RemoveSelected()
  1323. class ModelSearchDialog(wx.Dialog):
  1324. def __init__(self, parent, id = wx.ID_ANY, title = _("Select GRASS module"),
  1325. style = wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER, **kwargs):
  1326. """!Graphical modeler module search window
  1327. @param parent parent window
  1328. @param id window id
  1329. @param title window title
  1330. @param kwargs wx.Dialogs' arguments
  1331. """
  1332. self.parent = parent
  1333. wx.Dialog.__init__(self, parent = parent, id = id, title = title, **kwargs)
  1334. self.SetName("ModelerDialog")
  1335. self.SetIcon(wx.Icon(os.path.join(globalvar.ETCICONDIR, 'grass.ico'), wx.BITMAP_TYPE_ICO))
  1336. self.panel = wx.Panel(parent = self, id = wx.ID_ANY)
  1337. self.cmdBox = wx.StaticBox(parent = self.panel, id = wx.ID_ANY,
  1338. label=" %s " % _("Command"))
  1339. self.cmd_prompt = prompt.GPromptSTC(parent = self)
  1340. self.search = SearchModuleWindow(parent = self.panel, cmdPrompt = self.cmd_prompt, showTip = True)
  1341. # get commands
  1342. items = self.cmd_prompt.GetCommandItems()
  1343. self.btnCancel = wx.Button(self.panel, wx.ID_CANCEL)
  1344. self.btnOk = wx.Button(self.panel, wx.ID_OK)
  1345. self.btnOk.SetDefault()
  1346. self.btnOk.Enable(False)
  1347. self.cmd_prompt.Bind(wx.EVT_KEY_UP, self.OnText)
  1348. self.Bind(wx.EVT_BUTTON, self.OnOk, self.btnOk)
  1349. self._layout()
  1350. self.SetSize((500, 275))
  1351. def _layout(self):
  1352. btnSizer = wx.StdDialogButtonSizer()
  1353. btnSizer.AddButton(self.btnCancel)
  1354. btnSizer.AddButton(self.btnOk)
  1355. btnSizer.Realize()
  1356. mainSizer = wx.BoxSizer(wx.VERTICAL)
  1357. mainSizer.Add(item=self.search, proportion=0,
  1358. flag=wx.EXPAND | wx.ALL, border=3)
  1359. mainSizer.Add(item=self.cmd_prompt, proportion=1,
  1360. flag=wx.EXPAND | wx.LEFT | wx.RIGHT | wx.TOP, border=3)
  1361. mainSizer.Add(item=btnSizer, proportion=0,
  1362. flag=wx.EXPAND | wx.ALL | wx.ALIGN_CENTER, border=5)
  1363. self.panel.SetSizer(mainSizer)
  1364. mainSizer.Fit(self.panel)
  1365. self.Layout()
  1366. def GetPanel(self):
  1367. """!Get dialog panel"""
  1368. return self.panel
  1369. def GetCmd(self):
  1370. """!Get command"""
  1371. line = self.cmd_prompt.GetCurLine()[0].strip()
  1372. if len(line) == 0:
  1373. list()
  1374. try:
  1375. cmd = shlex.split(str(line))
  1376. except UnicodeError:
  1377. cmd = shlex.split(utils.EncodeString((line)))
  1378. return cmd
  1379. def OnOk(self, event):
  1380. self.btnOk.SetFocus()
  1381. cmd = self.GetCmd()
  1382. if len(cmd) < 1:
  1383. GMessage(parent = self,
  1384. message = _("Command not defined.\n\n"
  1385. "Unable to add new action to the model."))
  1386. return
  1387. if cmd[0] not in globalvar.grassCmd['all']:
  1388. GMessage(parent = self,
  1389. message = _("'%s' is not a GRASS module.\n\n"
  1390. "Unable to add new action to the model.") % cmd[0])
  1391. return
  1392. self.EndModal(wx.ID_OK)
  1393. def OnText(self, event):
  1394. if self.cmd_prompt.AutoCompActive():
  1395. return
  1396. entry = self.cmd_prompt.GetTextLeft()
  1397. if len(entry) > 0:
  1398. self.btnOk.Enable()
  1399. else:
  1400. self.btnOk.Enable(False)
  1401. event.Skip()
  1402. def Reset(self):
  1403. """!Reset dialog"""
  1404. self.search.Reset()
  1405. self.cmd_prompt.OnCmdErase(None)
  1406. class ModelRelation(ogl.LineShape):
  1407. """!Data - action relation"""
  1408. def __init__(self, fromShape, toShape):
  1409. self.fromShape = fromShape
  1410. self.toShape = toShape
  1411. self._points = None
  1412. ogl.LineShape.__init__(self)
  1413. def GetFrom(self):
  1414. """!Get id of 'from' shape"""
  1415. return self.fromShape
  1416. def GetTo(self):
  1417. """!Get id of 'to' shape"""
  1418. return self.toShape
  1419. def ResetShapes(self):
  1420. """!Reset related objects"""
  1421. self.fromShape.ResetControlPoints()
  1422. self.toShape.ResetControlPoints()
  1423. self.ResetControlPoints()
  1424. def SetControlPoints(self, points):
  1425. """!Set control points"""
  1426. self._points = points
  1427. def GetControlPoints(self):
  1428. """!Get list of control points"""
  1429. return self._points
  1430. class ProcessModelFile:
  1431. """!Process GRASS model file (gxm)"""
  1432. def __init__(self, tree):
  1433. """!A ElementTree handler for the GXM XML file, as defined in
  1434. grass-gxm.dtd.
  1435. """
  1436. self.tree = tree
  1437. self.root = self.tree.getroot()
  1438. # list of actions, data
  1439. self.actions = list()
  1440. self.data = list()
  1441. self._processActions()
  1442. self._processData()
  1443. def _filterValue(self, value):
  1444. """!Filter value
  1445. @param value
  1446. """
  1447. value = value.replace('&lt;', '<')
  1448. value = value.replace('&gt;', '>')
  1449. return value
  1450. def _getNodeText(self, node, tag, default = ''):
  1451. """!Get node text"""
  1452. p = node.find(tag)
  1453. if p is not None:
  1454. if p.text:
  1455. return utils.normalize_whitespace(p.text)
  1456. else:
  1457. return ''
  1458. return default
  1459. def _processActions(self):
  1460. """!Process model file"""
  1461. for action in self.root.findall('action'):
  1462. pos, size = self._getDim(action)
  1463. task = action.find('task')
  1464. if task:
  1465. task = self._processTask(task)
  1466. else:
  1467. task = None
  1468. aId = int(action.get('id', -1))
  1469. self.actions.append({ 'pos' : pos,
  1470. 'size' : size,
  1471. 'task' : task,
  1472. 'id' : aId })
  1473. def _getDim(self, node):
  1474. """!Get position and size of shape"""
  1475. pos = size = None
  1476. posAttr = node.get('pos', None)
  1477. if posAttr:
  1478. posVal = map(int, posAttr.split(','))
  1479. try:
  1480. pos = (posVal[0], posVal[1])
  1481. except:
  1482. pos = None
  1483. sizeAttr = node.get('size', None)
  1484. if sizeAttr:
  1485. sizeVal = map(int, sizeAttr.split(','))
  1486. try:
  1487. size = (sizeVal[0], sizeVal[1])
  1488. except:
  1489. size = None
  1490. return pos, size
  1491. def _processData(self):
  1492. """!Process model file"""
  1493. for data in self.root.findall('data'):
  1494. pos, size = self._getDim(data)
  1495. param = data.find('data-parameter')
  1496. name = prompt = value = None
  1497. if param is not None:
  1498. name = param.get('name', None)
  1499. prompt = param.get('prompt', None)
  1500. value = self._filterValue(self._getNodeText(param, 'value'))
  1501. if data.find('intermediate') is None:
  1502. intermediate = False
  1503. else:
  1504. intermediate = True
  1505. rels = list()
  1506. for rel in data.findall('relation'):
  1507. defrel = { 'id' : int(rel.get('id', -1)),
  1508. 'dir' : rel.get('dir', 'to') }
  1509. points = list()
  1510. for point in rel.findall('point'):
  1511. x = self._filterValue(self._getNodeText(point, 'x'))
  1512. y = self._filterValue(self._getNodeText(point, 'y'))
  1513. points.append((float(x), float(y)))
  1514. defrel['points'] = points
  1515. rels.append(defrel)
  1516. self.data.append({ 'pos' : pos,
  1517. 'size': size,
  1518. 'name' : name,
  1519. 'prompt' : prompt,
  1520. 'value' : value,
  1521. 'intermediate' : intermediate,
  1522. 'rels' : rels })
  1523. def _processTask(self, node):
  1524. """!Process task
  1525. @return grassTask instance
  1526. @return None on error
  1527. """
  1528. cmd = list()
  1529. parameterized = list()
  1530. name = node.get('name', None)
  1531. if not name:
  1532. return None
  1533. cmd.append(name)
  1534. # flags
  1535. for f in node.findall('flag'):
  1536. flag = f.get('name', '')
  1537. if f.get('parameterized', '0') == '1':
  1538. parameterized.append(('flag', flag))
  1539. if f.get('value', '1') == '0':
  1540. continue
  1541. if len(flag) > 1:
  1542. cmd.append('--' + flag)
  1543. else:
  1544. cmd.append('-' + flag)
  1545. # parameters
  1546. for p in node.findall('parameter'):
  1547. name = p.get('name', '')
  1548. if p.find('parameterized') is not None:
  1549. parameterized.append(('param', name))
  1550. cmd.append('%s=%s' % (name,
  1551. self._filterValue(self._getNodeText(p, 'value'))))
  1552. task = menuform.GUI().ParseCommand(cmd = cmd,
  1553. show = None)
  1554. for opt, name in parameterized:
  1555. if opt == 'flag':
  1556. task.set_flag(name, True, element = 'parameterized')
  1557. else:
  1558. task.set_param(name, True, element = 'parameterized')
  1559. return task
  1560. class WriteModelFile:
  1561. """!Generic class for writing model file"""
  1562. def __init__(self, fd, actions, data):
  1563. self.fd = fd
  1564. self.actions = actions
  1565. self.data = data
  1566. self.indent = 0
  1567. self._header()
  1568. self._actions()
  1569. self._data()
  1570. self._footer()
  1571. def _filterValue(self, value):
  1572. """!Make value XML-valid"""
  1573. value = value.replace('<', '&lt;')
  1574. value = value.replace('>', '&gt;')
  1575. return value
  1576. def _header(self):
  1577. """!Write header"""
  1578. self.fd.write('<?xml version="1.0" encoding="UTF-8"?>\n')
  1579. self.fd.write('<!DOCTYPE gxm SYSTEM "grass-gxm.dtd">\n')
  1580. self.fd.write('%s<gxm>\n' % (' ' * self.indent))
  1581. def _footer(self):
  1582. """!Write footer"""
  1583. self.fd.write('%s</gxm>\n' % (' ' * self.indent))
  1584. def _actions(self):
  1585. """!Write actions"""
  1586. id = 1
  1587. self.indent += 4
  1588. for action in self.actions:
  1589. action.SetId(id)
  1590. self.fd.write('%s<action id="%d" name="%s" pos="%d,%d" size="%d,%d">\n' % \
  1591. (' ' * self.indent, id, action.GetName(), action.GetX(), action.GetY(),
  1592. action.GetWidth(), action.GetHeight()))
  1593. self.indent += 4
  1594. self.fd.write('%s<task name="%s">\n' % (' ' * self.indent, action.GetLog(string = False)[0]))
  1595. self.indent += 4
  1596. for key, val in action.GetParams().iteritems():
  1597. if key == 'flags':
  1598. for f in val:
  1599. if f.get('value', False) or f.get('parameterized', False):
  1600. if f.get('parameterized', False):
  1601. if f.get('value', False) == False:
  1602. self.fd.write('%s<flag name="%s" value="0" parameterized="1" />\n' %
  1603. (' ' * self.indent, f.get('name', '')))
  1604. else:
  1605. self.fd.write('%s<flag name="%s" parameterized="1" />\n' %
  1606. (' ' * self.indent, f.get('name', '')))
  1607. else:
  1608. self.fd.write('%s<flag name="%s" />\n' %
  1609. (' ' * self.indent, f.get('name', '')))
  1610. else: # parameter
  1611. for p in val:
  1612. if not p.get('value', ''):
  1613. continue
  1614. self.fd.write('%s<parameter name="%s">\n' %
  1615. (' ' * self.indent, p.get('name', '')))
  1616. self.indent += 4
  1617. if p.get('parameterized', False):
  1618. self.fd.write('%s<parameterized />\n' % (' ' * self.indent))
  1619. self.fd.write('%s<value>%s</value>\n' %
  1620. (' ' * self.indent, self._filterValue(p.get('value', ''))))
  1621. self.indent -= 4
  1622. self.fd.write('%s</parameter>\n' % (' ' * self.indent))
  1623. self.indent -= 4
  1624. self.fd.write('%s</task>\n' % (' ' * self.indent))
  1625. self.indent -= 4
  1626. self.fd.write('%s</action>\n' % (' ' * self.indent))
  1627. id += 1
  1628. self.indent -= 4
  1629. def _data(self):
  1630. """!Write data"""
  1631. self.indent += 4
  1632. for data in self.data:
  1633. self.fd.write('%s<data pos="%d,%d" size="%d,%d">\n' % \
  1634. (' ' * self.indent, data.GetX(), data.GetY(),
  1635. data.GetWidth(), data.GetHeight()))
  1636. self.indent += 4
  1637. self.fd.write('%s<data-parameter name="%s" prompt="%s">\n' % \
  1638. (' ' * self.indent, data.GetName(), data.GetPrompt()))
  1639. self.indent += 4
  1640. self.fd.write('%s<value>%s</value>\n' %
  1641. (' ' * self.indent, self._filterValue(data.GetValue())))
  1642. self.indent -= 4
  1643. self.fd.write('%s</data-parameter>\n' % (' ' * self.indent))
  1644. if data.IsIntermediate():
  1645. self.fd.write('%s<intermediate />\n' % (' ' * self.indent))
  1646. # relations
  1647. for ft in ('from', 'to'):
  1648. for rel in data.GetRelations(direction = ft):
  1649. if ft == 'from':
  1650. aid = rel.GetTo().GetId()
  1651. else:
  1652. aid = rel.GetFrom().GetId()
  1653. self.fd.write('%s<relation dir="%s" id="%d">\n' % \
  1654. (' ' * self.indent, ft, aid))
  1655. self.indent += 4
  1656. for point in rel.GetLineControlPoints()[1:-1]:
  1657. self.fd.write('%s<point>\n' % (' ' * self.indent))
  1658. self.indent += 4
  1659. x, y = point.Get()
  1660. self.fd.write('%s<x>%f</x>\n' % (' ' * self.indent, x))
  1661. self.fd.write('%s<y>%f</y>\n' % (' ' * self.indent, y))
  1662. self.indent -= 4
  1663. self.fd.write('%s</point>\n' % (' ' * self.indent))
  1664. self.indent -= 4
  1665. self.fd.write('%s</relation>\n' % (' ' * self.indent))
  1666. self.indent -= 4
  1667. self.fd.write('%s</data>\n' % (' ' * self.indent))
  1668. class PreferencesDialog(PreferencesBaseDialog):
  1669. """!User preferences dialog"""
  1670. def __init__(self, parent, settings = UserSettings,
  1671. title = _("Modeler settings")):
  1672. PreferencesBaseDialog.__init__(self, parent = parent, title = title,
  1673. settings = settings)
  1674. # create notebook pages
  1675. self._createActionPage(self.notebook)
  1676. self._createDataPage(self.notebook)
  1677. self.SetMinSize(self.GetBestSize())
  1678. self.SetSize(self.size)
  1679. def _createActionPage(self, notebook):
  1680. """!Create notebook page for action settings"""
  1681. panel = wx.Panel(parent = notebook, id = wx.ID_ANY)
  1682. notebook.AddPage(page = panel, text = _("Action"))
  1683. # colors
  1684. border = wx.BoxSizer(wx.VERTICAL)
  1685. box = wx.StaticBox (parent = panel, id = wx.ID_ANY,
  1686. label = " %s " % _("Color settings"))
  1687. sizer = wx.StaticBoxSizer(box, wx.VERTICAL)
  1688. gridSizer = wx.GridBagSizer (hgap = 3, vgap = 3)
  1689. gridSizer.AddGrowableCol(0)
  1690. row = 0
  1691. gridSizer.Add(item = wx.StaticText(parent = panel, id = wx.ID_ANY,
  1692. label = _("Valid:")),
  1693. flag = wx.ALIGN_LEFT |
  1694. wx.ALIGN_CENTER_VERTICAL,
  1695. pos = (row, 0))
  1696. vColor = csel.ColourSelect(parent = panel, id = wx.ID_ANY,
  1697. colour = self.settings.Get(group='modeler', key='action', subkey=('color', 'valid')),
  1698. size = globalvar.DIALOG_COLOR_SIZE)
  1699. vColor.SetName('GetColour')
  1700. self.winId['modeler:action:color:valid'] = vColor.GetId()
  1701. gridSizer.Add(item = vColor,
  1702. flag = wx.ALIGN_RIGHT |
  1703. wx.ALIGN_CENTER_VERTICAL,
  1704. pos = (row, 1))
  1705. row += 1
  1706. gridSizer.Add(item = wx.StaticText(parent = panel, id = wx.ID_ANY,
  1707. label = _("Invalid:")),
  1708. flag = wx.ALIGN_LEFT |
  1709. wx.ALIGN_CENTER_VERTICAL,
  1710. pos = (row, 0))
  1711. iColor = csel.ColourSelect(parent = panel, id = wx.ID_ANY,
  1712. colour = self.settings.Get(group='modeler', key='action', subkey=('color', 'invalid')),
  1713. size = globalvar.DIALOG_COLOR_SIZE)
  1714. iColor.SetName('GetColour')
  1715. self.winId['modeler:action:color:invalid'] = iColor.GetId()
  1716. gridSizer.Add(item = iColor,
  1717. flag = wx.ALIGN_RIGHT |
  1718. wx.ALIGN_CENTER_VERTICAL,
  1719. pos = (row, 1))
  1720. row += 1
  1721. gridSizer.Add(item = wx.StaticText(parent = panel, id = wx.ID_ANY,
  1722. label = _("Running:")),
  1723. flag = wx.ALIGN_LEFT |
  1724. wx.ALIGN_CENTER_VERTICAL,
  1725. pos = (row, 0))
  1726. rColor = csel.ColourSelect(parent = panel, id = wx.ID_ANY,
  1727. colour = self.settings.Get(group='modeler', key='action', subkey=('color', 'running')),
  1728. size = globalvar.DIALOG_COLOR_SIZE)
  1729. rColor.SetName('GetColour')
  1730. self.winId['modeler:action:color:running'] = rColor.GetId()
  1731. gridSizer.Add(item = rColor,
  1732. flag = wx.ALIGN_RIGHT |
  1733. wx.ALIGN_CENTER_VERTICAL,
  1734. pos = (row, 1))
  1735. sizer.Add(item = gridSizer, proportion = 1, flag = wx.ALL | wx.EXPAND, border = 5)
  1736. border.Add(item = sizer, proportion = 0, flag = wx.LEFT | wx.RIGHT | wx.BOTTOM | wx.EXPAND, border = 3)
  1737. # size
  1738. box = wx.StaticBox (parent = panel, id = wx.ID_ANY,
  1739. label = " %s " % _("Size settings"))
  1740. sizer = wx.StaticBoxSizer(box, wx.VERTICAL)
  1741. gridSizer = wx.GridBagSizer (hgap=3, vgap=3)
  1742. gridSizer.AddGrowableCol(0)
  1743. row = 0
  1744. gridSizer.Add(item = wx.StaticText(parent = panel, id = wx.ID_ANY,
  1745. label = _("Width:")),
  1746. flag = wx.ALIGN_LEFT |
  1747. wx.ALIGN_CENTER_VERTICAL,
  1748. pos = (row, 0))
  1749. width = wx.SpinCtrl(parent = panel, id = wx.ID_ANY,
  1750. min = 0, max = 500,
  1751. initial = self.settings.Get(group='modeler', key='action', subkey=('size', 'width')))
  1752. width.SetName('GetValue')
  1753. self.winId['modeler:action:size:width'] = width.GetId()
  1754. gridSizer.Add(item = width,
  1755. flag = wx.ALIGN_RIGHT |
  1756. wx.ALIGN_CENTER_VERTICAL,
  1757. pos = (row, 1))
  1758. row += 1
  1759. gridSizer.Add(item = wx.StaticText(parent=panel, id=wx.ID_ANY,
  1760. label=_("Height:")),
  1761. flag = wx.ALIGN_LEFT |
  1762. wx.ALIGN_CENTER_VERTICAL,
  1763. pos=(row, 0))
  1764. height = wx.SpinCtrl(parent = panel, id = wx.ID_ANY,
  1765. min = 0, max = 500,
  1766. initial = self.settings.Get(group='modeler', key='action', subkey=('size', 'height')))
  1767. height.SetName('GetValue')
  1768. self.winId['modeler:action:size:height'] = height.GetId()
  1769. gridSizer.Add(item = height,
  1770. flag = wx.ALIGN_RIGHT |
  1771. wx.ALIGN_CENTER_VERTICAL,
  1772. pos = (row, 1))
  1773. sizer.Add(item=gridSizer, proportion=1, flag=wx.ALL | wx.EXPAND, border=5)
  1774. border.Add(item=sizer, proportion=0, flag=wx.LEFT | wx.RIGHT | wx.BOTTOM | wx.EXPAND, border=3)
  1775. panel.SetSizer(border)
  1776. return panel
  1777. def _createDataPage(self, notebook):
  1778. """!Create notebook page for data settings"""
  1779. panel = wx.Panel(parent = notebook, id = wx.ID_ANY)
  1780. notebook.AddPage(page = panel, text = _("Data"))
  1781. # colors
  1782. border = wx.BoxSizer(wx.VERTICAL)
  1783. box = wx.StaticBox (parent = panel, id = wx.ID_ANY,
  1784. label = " %s " % _("Color settings"))
  1785. sizer = wx.StaticBoxSizer(box, wx.VERTICAL)
  1786. gridSizer = wx.GridBagSizer (hgap = 3, vgap = 3)
  1787. gridSizer.AddGrowableCol(0)
  1788. row = 0
  1789. gridSizer.Add(item = wx.StaticText(parent = panel, id = wx.ID_ANY,
  1790. label = _("Raster:")),
  1791. flag = wx.ALIGN_LEFT |
  1792. wx.ALIGN_CENTER_VERTICAL,
  1793. pos = (row, 0))
  1794. rColor = csel.ColourSelect(parent = panel, id = wx.ID_ANY,
  1795. colour = self.settings.Get(group='modeler', key='data', subkey=('color', 'raster')),
  1796. size = globalvar.DIALOG_COLOR_SIZE)
  1797. rColor.SetName('GetColour')
  1798. self.winId['modeler:data:color:raster'] = rColor.GetId()
  1799. gridSizer.Add(item = rColor,
  1800. flag = wx.ALIGN_RIGHT |
  1801. wx.ALIGN_CENTER_VERTICAL,
  1802. pos = (row, 1))
  1803. row += 1
  1804. gridSizer.Add(item = wx.StaticText(parent = panel, id = wx.ID_ANY,
  1805. label = _("3D raster:")),
  1806. flag = wx.ALIGN_LEFT |
  1807. wx.ALIGN_CENTER_VERTICAL,
  1808. pos = (row, 0))
  1809. r3Color = csel.ColourSelect(parent = panel, id = wx.ID_ANY,
  1810. colour = self.settings.Get(group='modeler', key='data', subkey=('color', 'raster3d')),
  1811. size = globalvar.DIALOG_COLOR_SIZE)
  1812. r3Color.SetName('GetColour')
  1813. self.winId['modeler:data:color:raster3d'] = r3Color.GetId()
  1814. gridSizer.Add(item = r3Color,
  1815. flag = wx.ALIGN_RIGHT |
  1816. wx.ALIGN_CENTER_VERTICAL,
  1817. pos = (row, 1))
  1818. row += 1
  1819. gridSizer.Add(item = wx.StaticText(parent = panel, id = wx.ID_ANY,
  1820. label = _("Vector:")),
  1821. flag = wx.ALIGN_LEFT |
  1822. wx.ALIGN_CENTER_VERTICAL,
  1823. pos = (row, 0))
  1824. vColor = csel.ColourSelect(parent = panel, id = wx.ID_ANY,
  1825. colour = self.settings.Get(group='modeler', key='data', subkey=('color', 'vector')),
  1826. size = globalvar.DIALOG_COLOR_SIZE)
  1827. vColor.SetName('GetColour')
  1828. self.winId['modeler:data:color:vector'] = vColor.GetId()
  1829. gridSizer.Add(item = vColor,
  1830. flag = wx.ALIGN_RIGHT |
  1831. wx.ALIGN_CENTER_VERTICAL,
  1832. pos = (row, 1))
  1833. sizer.Add(item = gridSizer, proportion = 1, flag = wx.ALL | wx.EXPAND, border = 5)
  1834. border.Add(item = sizer, proportion = 0, flag = wx.LEFT | wx.RIGHT | wx.BOTTOM | wx.EXPAND, border = 3)
  1835. # size
  1836. box = wx.StaticBox (parent = panel, id = wx.ID_ANY,
  1837. label = " %s " % _("Size settings"))
  1838. sizer = wx.StaticBoxSizer(box, wx.VERTICAL)
  1839. gridSizer = wx.GridBagSizer (hgap=3, vgap=3)
  1840. gridSizer.AddGrowableCol(0)
  1841. row = 0
  1842. gridSizer.Add(item = wx.StaticText(parent = panel, id = wx.ID_ANY,
  1843. label = _("Width:")),
  1844. flag = wx.ALIGN_LEFT |
  1845. wx.ALIGN_CENTER_VERTICAL,
  1846. pos = (row, 0))
  1847. width = wx.SpinCtrl(parent = panel, id = wx.ID_ANY,
  1848. min = 0, max = 500,
  1849. initial = self.settings.Get(group='modeler', key='data', subkey=('size', 'width')))
  1850. width.SetName('GetValue')
  1851. self.winId['modeler:data:size:width'] = width.GetId()
  1852. gridSizer.Add(item = width,
  1853. flag = wx.ALIGN_RIGHT |
  1854. wx.ALIGN_CENTER_VERTICAL,
  1855. pos = (row, 1))
  1856. row += 1
  1857. gridSizer.Add(item = wx.StaticText(parent=panel, id=wx.ID_ANY,
  1858. label=_("Height:")),
  1859. flag = wx.ALIGN_LEFT |
  1860. wx.ALIGN_CENTER_VERTICAL,
  1861. pos=(row, 0))
  1862. height = wx.SpinCtrl(parent = panel, id = wx.ID_ANY,
  1863. min = 0, max = 500,
  1864. initial = self.settings.Get(group='modeler', key='data', subkey=('size', 'height')))
  1865. height.SetName('GetValue')
  1866. self.winId['modeler:data:size:height'] = height.GetId()
  1867. gridSizer.Add(item = height,
  1868. flag = wx.ALIGN_RIGHT |
  1869. wx.ALIGN_CENTER_VERTICAL,
  1870. pos = (row, 1))
  1871. sizer.Add(item=gridSizer, proportion=1, flag=wx.ALL | wx.EXPAND, border=5)
  1872. border.Add(item=sizer, proportion=0, flag=wx.LEFT | wx.RIGHT | wx.BOTTOM | wx.EXPAND, border=3)
  1873. panel.SetSizer(border)
  1874. return panel
  1875. def OnApply(self, event):
  1876. """!Button 'Apply' pressed"""
  1877. PreferencesBaseDialog.OnApply(self, event)
  1878. self.parent.GetModel().Update()
  1879. self.parent.GetCanvas().Refresh()
  1880. def OnSave(self, event):
  1881. """!Button 'Save' pressed"""
  1882. PreferencesBaseDialog.OnSave(self, event)
  1883. self.parent.GetModel().Update()
  1884. self.parent.GetCanvas().Refresh()
  1885. class PropertiesDialog(wx.Dialog):
  1886. """!Model properties dialog
  1887. """
  1888. def __init__(self, parent, id = wx.ID_ANY,
  1889. title = _('Model properties'),
  1890. size = (350, 400),
  1891. style = wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER):
  1892. wx.Dialog.__init__(self, parent, id, title, size = size,
  1893. style = style)
  1894. self.name = wx.TextCtrl(parent = self, id = wx.ID_ANY,
  1895. size = (300, 25))
  1896. self.desc = wx.TextCtrl(parent = self, id = wx.ID_ANY,
  1897. style = wx.TE_MULTILINE,
  1898. size = (300, 50))
  1899. self.author = wx.TextCtrl(parent = self, id = wx.ID_ANY,
  1900. size = (300, 25))
  1901. # buttons
  1902. self.btnOk = wx.Button(self, wx.ID_OK)
  1903. self.btnCancel = wx.Button(self, wx.ID_CANCEL)
  1904. self.btnOk.SetDefault()
  1905. self.btnOk.SetToolTipString(_("Apply properties"))
  1906. self.btnOk.SetDefault()
  1907. self.btnCancel.SetToolTipString(_("Close dialog and ignore changes"))
  1908. self.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
  1909. self._layout()
  1910. def _layout(self):
  1911. gridSizer = wx.GridBagSizer (hgap=3, vgap=3)
  1912. gridSizer.AddGrowableCol(0)
  1913. gridSizer.AddGrowableRow(1)
  1914. gridSizer.Add(item = wx.StaticText(parent = self, id = wx.ID_ANY,
  1915. label = _("Name:")),
  1916. flag = wx.ALIGN_LEFT |
  1917. wx.ALIGN_CENTER_VERTICAL,
  1918. pos = (0, 0))
  1919. gridSizer.Add(item = self.name,
  1920. flag = wx.ALIGN_LEFT |
  1921. wx.ALIGN_CENTER_VERTICAL | wx.EXPAND,
  1922. pos = (0, 1))
  1923. gridSizer.Add(item = wx.StaticText(parent = self, id = wx.ID_ANY,
  1924. label = _("Description:")),
  1925. flag = wx.ALIGN_LEFT |
  1926. wx.ALIGN_CENTER_VERTICAL,
  1927. pos = (1, 0))
  1928. gridSizer.Add(item = self.desc,
  1929. flag = wx.ALIGN_LEFT |
  1930. wx.ALIGN_CENTER_VERTICAL | wx.EXPAND,
  1931. pos = (1, 1))
  1932. gridSizer.Add(item = wx.StaticText(parent = self, id = wx.ID_ANY,
  1933. label = _("Author(s):")),
  1934. flag = wx.ALIGN_LEFT |
  1935. wx.ALIGN_CENTER_VERTICAL,
  1936. pos = (2, 0))
  1937. gridSizer.Add(item = self.author,
  1938. flag = wx.ALIGN_LEFT |
  1939. wx.ALIGN_CENTER_VERTICAL | wx.EXPAND,
  1940. pos = (2, 1))
  1941. btnStdSizer = wx.StdDialogButtonSizer()
  1942. btnStdSizer.AddButton(self.btnCancel)
  1943. btnStdSizer.AddButton(self.btnOk)
  1944. btnStdSizer.Realize()
  1945. mainSizer = wx.BoxSizer(wx.VERTICAL)
  1946. mainSizer.Add(item=gridSizer, proportion=1,
  1947. flag=wx.EXPAND | wx.ALL, border=5)
  1948. mainSizer.Add(item=btnStdSizer, proportion=0,
  1949. flag=wx.EXPAND | wx.ALL | wx.ALIGN_RIGHT, border=5)
  1950. self.SetSizer(mainSizer)
  1951. mainSizer.Fit(self)
  1952. def OnCloseWindow(self, event):
  1953. self.Hide()
  1954. def GetValues(self):
  1955. """!Get values"""
  1956. return { 'name' : self.name.GetValue(),
  1957. 'desc' : self.desc.GetValue(),
  1958. 'author' : self.author.GetValue() }
  1959. def Init(self, prop):
  1960. """!Initialize dialog"""
  1961. self.name.SetValue(prop['name'])
  1962. self.desc.SetValue(prop['desc'])
  1963. self.author.SetValue(prop['author'])
  1964. class ModelParamDialog(wx.Dialog):
  1965. def __init__(self, parent, params, id = wx.ID_ANY, title = _("Model parameters"),
  1966. style = wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER, **kwargs):
  1967. """!Model parameters dialog
  1968. """
  1969. self.parent = parent
  1970. self.params = params
  1971. wx.Dialog.__init__(self, parent = parent, id = id, title = title, style = style, **kwargs)
  1972. self.notebook = FN.FlatNotebook(self, id = wx.ID_ANY,
  1973. style = FN.FNB_FANCY_TABS |
  1974. FN.FNB_BOTTOM |
  1975. FN.FNB_NO_NAV_BUTTONS |
  1976. FN.FNB_NO_X_BUTTON)
  1977. panel = self._createPages()
  1978. wx.CallAfter(self.notebook.SetSelection, 0)
  1979. self.btnCancel = wx.Button(parent = self, id = wx.ID_CANCEL)
  1980. self.btnRun = wx.Button(parent = self, id = wx.ID_OK,
  1981. label = _("&Run"))
  1982. self.btnRun.SetDefault()
  1983. self._layout()
  1984. size = self.GetBestSize()
  1985. self.SetMinSize(size)
  1986. self.SetSize((size.width, size.height +
  1987. panel.constrained_size[1] -
  1988. panel.panelMinHeight))
  1989. def _layout(self):
  1990. btnSizer = wx.StdDialogButtonSizer()
  1991. btnSizer.AddButton(self.btnCancel)
  1992. btnSizer.AddButton(self.btnRun)
  1993. btnSizer.Realize()
  1994. mainSizer = wx.BoxSizer(wx.VERTICAL)
  1995. mainSizer.Add(item = self.notebook, proportion = 1,
  1996. flag = wx.EXPAND)
  1997. mainSizer.Add(item=btnSizer, proportion=0,
  1998. flag=wx.EXPAND | wx.ALL | wx.ALIGN_CENTER, border=5)
  1999. self.SetSizer(mainSizer)
  2000. mainSizer.Fit(self)
  2001. def _createPages(self):
  2002. """!Create for each parameterized module its own page"""
  2003. nameOrdered = [''] * len(self.params.keys())
  2004. for name, params in self.params.iteritems():
  2005. nameOrdered[params['idx']] = name
  2006. for name in nameOrdered:
  2007. params = self.params[name]
  2008. panel = self._createPage(name, params)
  2009. self.notebook.AddPage(panel, text = name)
  2010. return panel
  2011. def _createPage(self, name, params):
  2012. """!Define notebook page"""
  2013. task = menuform.grassTask(name)
  2014. task.flags = params['flags']
  2015. task.params = params['params']
  2016. panel = menuform.cmdPanel(parent = self, id = wx.ID_ANY, task = task)
  2017. return panel
  2018. def main():
  2019. app = wx.PySimpleApp()
  2020. wx.InitAllImageHandlers()
  2021. frame = ModelFrame(parent = None)
  2022. if len(sys.argv) > 1:
  2023. frame.LoadModelFile(sys.argv[1])
  2024. # frame.CentreOnScreen()
  2025. frame.Show()
  2026. app.MainLoop()
  2027. if __name__ == "__main__":
  2028. main()