menuform.py 100 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477
  1. #!/usr/bin/env python
  2. """
  3. @brief Construct simple wxPython GUI from a GRASS command interface
  4. description.
  5. Classes:
  6. - grassTask
  7. - processTask
  8. - helpPanel
  9. - mainFrame
  10. - cmdPanel
  11. - GrassGUIApp
  12. - GUI
  13. - FloatValidator
  14. This program is just a coarse approach to automatically build a GUI
  15. from a xml-based GRASS user interface description.
  16. You need to have Python 2.4, wxPython 2.8 and python-xml.
  17. The XML stream is read from executing the command given in the
  18. command line, thus you may call it for instance this way:
  19. python menuform.py r.basins.fill
  20. Or you set an alias or wrap the call up in a nice shell script, GUI
  21. environment ... please contribute your idea.
  22. Updated to wxPython 2.8 syntax and contrib widgets. Methods added to
  23. make it callable by gui. Method added to automatically re-run with
  24. pythonw on a Mac.
  25. @todo
  26. - verify option value types
  27. Copyright(C) 2000-2010 by the GRASS Development Team
  28. This program is free software under the GPL(>=v2) Read the file
  29. COPYING coming with GRASS for details.
  30. @author Jan-Oliver Wagner <jan@intevation.de>
  31. @author Bernhard Reiter <bernhard@intevation.de>
  32. @author Michael Barton, Arizona State University
  33. @author Daniel Calvelo <dca.gis@gmail.com>
  34. @author Martin Landa <landa.martin@gmail.com>
  35. """
  36. import sys
  37. import re
  38. import string
  39. import textwrap
  40. import os
  41. import time
  42. import types
  43. import copy
  44. import locale
  45. import types
  46. from threading import Thread
  47. import Queue
  48. import shlex
  49. import tempfile
  50. ### i18N
  51. import gettext
  52. gettext.install('grasswxpy', os.path.join(os.getenv("GISBASE"), 'locale'), unicode = True)
  53. import globalvar
  54. if not os.getenv("GRASS_WXBUNDLED"):
  55. globalvar.CheckForWx()
  56. import wx
  57. import wx.html
  58. try:
  59. import wx.lib.agw.flatnotebook as FN
  60. except ImportError:
  61. import wx.lib.flatnotebook as FN
  62. import wx.lib.colourselect as csel
  63. import wx.lib.filebrowsebutton as filebrowse
  64. import wx.lib.scrolledpanel as scrolled
  65. from wx.lib.expando import ExpandoTextCtrl, EVT_ETC_LAYOUT_NEEDED
  66. from wx.lib.newevent import NewEvent
  67. try:
  68. import xml.etree.ElementTree as etree
  69. except ImportError:
  70. import elementtree.ElementTree as etree # Python <= 2.4
  71. import gdialogs
  72. from ghelp import HelpPanel
  73. gisbase = os.getenv("GISBASE")
  74. if gisbase is None:
  75. print >>sys.stderr, "We don't seem to be properly installed, or we are being run outside GRASS. Expect glitches."
  76. gisbase = os.path.join(os.path.dirname(sys.argv[0]), os.path.pardir)
  77. wxbase = gisbase
  78. else:
  79. wxbase = os.path.join(globalvar.ETCWXDIR)
  80. sys.path.append(wxbase)
  81. imagepath = os.path.join(wxbase, "images")
  82. sys.path.append(imagepath)
  83. from grass.script import core as grass
  84. import gselect
  85. import gcmd
  86. import goutput
  87. import utils
  88. from preferences import globalSettings as UserSettings
  89. try:
  90. import subprocess
  91. except:
  92. from compat import subprocess
  93. wxUpdateDialog, EVT_DIALOG_UPDATE = NewEvent()
  94. # From lib/gis/col_str.c, except purple which is mentioned
  95. # there but not given RGB values
  96. str2rgb = {'aqua': (100, 128, 255),
  97. 'black': (0, 0, 0),
  98. 'blue': (0, 0, 255),
  99. 'brown': (180, 77, 25),
  100. 'cyan': (0, 255, 255),
  101. 'gray': (128, 128, 128),
  102. 'green': (0, 255, 0),
  103. 'grey': (128, 128, 128),
  104. 'indigo': (0, 128, 255),
  105. 'magenta': (255, 0, 255),
  106. 'orange': (255, 128, 0),
  107. 'purple': (128, 0, 128),
  108. 'red': (255, 0, 0),
  109. 'violet': (128, 0, 255),
  110. 'white': (255, 255, 255),
  111. 'yellow': (255, 255, 0)}
  112. rgb2str = {}
  113. for (s,r) in str2rgb.items():
  114. rgb2str[ r ] = s
  115. def color_resolve(color):
  116. if len(color)>0 and color[0] in "0123456789":
  117. rgb = tuple(map(int, color.split(':')))
  118. label = color
  119. else:
  120. # Convert color names to RGB
  121. try:
  122. rgb = str2rgb[color]
  123. label = color
  124. except KeyError:
  125. rgb = (200, 200, 200)
  126. label = _('Select Color')
  127. return (rgb, label)
  128. def text_beautify(someString , width = 70):
  129. """!Make really long texts shorter, clean up whitespace and remove
  130. trailing punctuation.
  131. """
  132. if width > 0:
  133. return escape_ampersand(string.strip(
  134. os.linesep.join(textwrap.wrap(utils.normalize_whitespace(someString), width)),
  135. ".,;:"))
  136. else:
  137. return escape_ampersand(string.strip(utils.normalize_whitespace(someString), ".,;:"))
  138. def escape_ampersand(text):
  139. """!Escapes ampersands with additional ampersand for GUI"""
  140. return string.replace(text, "&", "&&")
  141. class UpdateThread(Thread):
  142. """!Update dialog widgets in the thread"""
  143. def __init__(self, parent, event, eventId, task):
  144. Thread.__init__(self)
  145. self.parent = parent
  146. self.event = event
  147. self.eventId = eventId
  148. self.task = task
  149. self.setDaemon(True)
  150. # list of functions which updates the dialog
  151. self.data = {}
  152. def run(self):
  153. # get widget id
  154. if not self.eventId:
  155. for p in self.task.params:
  156. if p.get('gisprompt', False) == False:
  157. continue
  158. prompt = p.get('element', '')
  159. if prompt == 'vector':
  160. name = p.get('name', '')
  161. if name in ('map', 'input'):
  162. self.eventId = p['wxId'][0]
  163. if self.eventId is None:
  164. return
  165. p = self.task.get_param(self.eventId, element = 'wxId', raiseError = False)
  166. if not p or \
  167. not p.has_key('wxId-bind'):
  168. return
  169. # get widget prompt
  170. pType = p.get('prompt', '')
  171. if not pType:
  172. return
  173. # check for map/input parameter
  174. pMap = self.task.get_param('map', raiseError = False)
  175. if not pMap:
  176. pMap = self.task.get_param('input', raiseError = False)
  177. if pMap:
  178. map = pMap.get('value', '')
  179. else:
  180. map = None
  181. # avoid running db.describe several times
  182. cparams = dict()
  183. cparams[map] = { 'dbInfo' : None,
  184. 'layers' : None, }
  185. # update reference widgets
  186. for uid in p['wxId-bind']:
  187. win = self.parent.FindWindowById(uid)
  188. name = win.GetName()
  189. map = layer = None
  190. driver = db = table = None
  191. if name in ('LayerSelect', 'LayerNameSelect',
  192. 'ColumnSelect'):
  193. if p.get('element', '') == 'vector': # -> vector
  194. # get map name
  195. map = p.get('value', '')
  196. # get layer
  197. for bid in p['wxId-bind']:
  198. p = self.task.get_param(bid, element = 'wxId', raiseError = False)
  199. if not p:
  200. continue
  201. if p.get('element', '') == 'layer':
  202. layer = p.get('value', '')
  203. if layer != '':
  204. layer = p.get('value', 1)
  205. else:
  206. layer = p.get('default', 1)
  207. break
  208. elif p.get('element', '') == 'layer': # -> layer
  209. # get layer
  210. layer = p.get('value', '')
  211. if layer != '':
  212. layer = p.get('value', 1)
  213. else:
  214. layer = p.get('default', 1)
  215. # get map name
  216. pMap = self.task.get_param(p['wxId'][0], element = 'wxId-bind', raiseError = False)
  217. if pMap:
  218. map = pMap.get('value', '')
  219. if name == 'TableSelect' or \
  220. (name == 'ColumnSelect' and not map):
  221. pDriver = self.task.get_param('dbdriver', element = 'prompt', raiseError = False)
  222. if pDriver:
  223. driver = pDriver.get('value', '')
  224. pDb = self.task.get_param('dbname', element = 'prompt', raiseError = False)
  225. if pDb:
  226. db = pDb.get('value', '')
  227. if name == 'ColumnSelect':
  228. pTable = self.task.get_param('dbtable', element = 'element', raiseError = False)
  229. if pTable:
  230. table = pTable.get('value', '')
  231. if name == 'LayerSelect':
  232. if not cparams[map]['layers']:
  233. win.InsertLayers(vector = map)
  234. cparams[map]['layers'] = win.GetItems()
  235. elif name == 'LayerNameSelect':
  236. # determine format
  237. native = True
  238. for id in pMap['wxId']:
  239. winVec = self.parent.FindWindowById(id)
  240. if winVec.GetName() == 'VectorFormat' and \
  241. winVec.GetSelection() != 0:
  242. native = False
  243. break
  244. if not native:
  245. if map:
  246. self.data[win.InsertLayers] = { 'dsn' : map.rstrip('@OGR') }
  247. else:
  248. self.data[win.InsertLayers] = { }
  249. elif name == 'TableSelect':
  250. self.data[win.InsertTables] = { 'driver' : driver,
  251. 'database' : db }
  252. elif name == 'ColumnSelect':
  253. if map:
  254. try:
  255. if not cparams[map]['dbInfo']:
  256. cparams[map]['dbInfo'] = gselect.VectorDBInfo(map)
  257. except KeyError:
  258. pass
  259. self.data[win.InsertColumns] = { 'vector' : map, 'layer' : layer,
  260. 'dbInfo' : cparams[map]['dbInfo'] }
  261. else: # table
  262. if driver and db:
  263. self.data[win.InsertTableColumns] = { 'table' : pTable.get('value'),
  264. 'driver' : driver,
  265. 'database' : db }
  266. elif pTable:
  267. self.data[win.InsertTableColumns] = { 'table' : pTable.get('value') }
  268. elif name == 'SubGroupSelect':
  269. pGroup = self.task.get_param('group', element = 'element', raiseError = False)
  270. if pGroup:
  271. self.data[win.Insert] = { 'group' : pGroup.get('value', '')}
  272. elif name == 'LocationSelect':
  273. pDbase = self.task.get_param('dbase', element = 'element', raiseError = False)
  274. if pDbase:
  275. self.data[win.UpdateItems] = { 'dbase' : pDbase.get('value', '')}
  276. elif name == 'MapsetSelect':
  277. pDbase = self.task.get_param('dbase', element = 'element', raiseError = False)
  278. pLocation = self.task.get_param('location', element = 'element', raiseError = False)
  279. if pDbase and pLocation:
  280. self.data[win.UpdateItems] = { 'dbase' : pDbase.get('value', ''),
  281. 'location' : pLocation.get('value', '')}
  282. elif name == 'ProjSelect':
  283. pDbase = self.task.get_param('dbase', element = 'element', raiseError = False)
  284. pLocation = self.task.get_param('location', element = 'element', raiseError = False)
  285. pMapset = self.task.get_param('mapset', element = 'element', raiseError = False)
  286. if pDbase and pLocation and pMapset:
  287. self.data[win.UpdateItems] = { 'dbase' : pDbase.get('value', ''),
  288. 'location' : pLocation.get('value', ''),
  289. 'mapset' : pMapset.get('value', '')}
  290. def UpdateDialog(parent, event, eventId, task):
  291. return UpdateThread(parent, event, eventId, task)
  292. class UpdateQThread(Thread):
  293. """!Update dialog widgets in the thread"""
  294. requestId = 0
  295. def __init__(self, parent, requestQ, resultQ, **kwds):
  296. Thread.__init__(self, **kwds)
  297. self.parent = parent # cmdPanel
  298. self.setDaemon(True)
  299. self.requestQ = requestQ
  300. self.resultQ = resultQ
  301. self.start()
  302. def Update(self, callable, *args, **kwds):
  303. UpdateQThread.requestId += 1
  304. self.request = None
  305. self.requestQ.put((UpdateQThread.requestId, callable, args, kwds))
  306. return UpdateQThread.requestId
  307. def run(self):
  308. while True:
  309. requestId, callable, args, kwds = self.requestQ.get()
  310. requestTime = time.time()
  311. self.request = callable(*args, **kwds)
  312. self.resultQ.put((requestId, self.request.run()))
  313. event = wxUpdateDialog(data = self.request.data)
  314. wx.PostEvent(self.parent, event)
  315. class grassTask:
  316. """!This class holds the structures needed for both filling by the
  317. parser and use by the interface constructor.
  318. Use as either grassTask() for empty definition or
  319. grassTask('grass.command') for parsed filling.
  320. """
  321. def __init__(self, grassModule = None):
  322. self.path = grassModule
  323. self.name = _('unknown')
  324. self.params = list()
  325. self.description = ''
  326. self.label = ''
  327. self.flags = list()
  328. self.keywords = list()
  329. self.errorMsg = ''
  330. self.firstParam = None
  331. if grassModule is not None:
  332. try:
  333. processTask(tree = etree.fromstring(getInterfaceDescription(grassModule)),
  334. task = self)
  335. except gcmd.GException, e:
  336. self.errorMsg = str(e)
  337. self.define_first()
  338. def define_first(self):
  339. """!Define first parameter"""
  340. if len(self.params) > 0:
  341. self.firstParam = self.params[0]['name']
  342. def get_error_msg(self):
  343. """!Get error message ('' for no error)"""
  344. return self.errorMsg
  345. def get_name(self):
  346. """!Get task name"""
  347. return self.name
  348. def get_list_params(self, element = 'name'):
  349. """!Get list of parameters"""
  350. params = []
  351. for p in self.params:
  352. params.append(p['name'])
  353. return params
  354. def get_list_flags(self, element = 'name'):
  355. """!Get list of parameters"""
  356. flags = []
  357. for p in self.flags:
  358. flags.append(p['name'])
  359. return flags
  360. def get_param(self, value, element = 'name', raiseError = True):
  361. """!Find and return a param by name."""
  362. try:
  363. for p in self.params:
  364. val = p[element]
  365. if val is None:
  366. continue
  367. if type(val) in (types.ListType, types.TupleType):
  368. if value in val:
  369. return p
  370. elif type(val) == types.StringType:
  371. if p[element][:len(value)] == value:
  372. return p
  373. else:
  374. if p[element] == value:
  375. return p
  376. except KeyError:
  377. pass
  378. if raiseError:
  379. raise ValueError, _("Parameter element '%(element)s' not found: '%(value)s'") % \
  380. { 'element' : element, 'value' : value }
  381. else:
  382. return None
  383. def set_param(self, aParam, aValue, element = 'value'):
  384. """!Set param value/values.
  385. """
  386. try:
  387. param = self.get_param(aParam)
  388. except ValueError:
  389. return
  390. param[element] = aValue
  391. def get_flag(self, aFlag):
  392. """!Find and return a flag by name.
  393. """
  394. for f in self.flags:
  395. if f['name'] == aFlag:
  396. return f
  397. raise ValueError, _("Flag not found: %s") % aFlag
  398. def set_flag(self, aFlag, aValue, element = 'value'):
  399. """!Enable / disable flag.
  400. """
  401. try:
  402. param = self.get_flag(aFlag)
  403. except ValueError:
  404. return
  405. param[element] = aValue
  406. def getCmdError(self):
  407. """!Get error string produced by getCmd(ignoreErrors = False)
  408. @return list of errors
  409. """
  410. errorList = list()
  411. # determine if suppress_required flag is given
  412. for f in self.flags:
  413. if f['value'] and f['suppress_required']:
  414. return errorList
  415. for p in self.params:
  416. if not p.get('value', '') and p.get('required', False):
  417. if not p.get('default', ''):
  418. desc = p.get('label', '')
  419. if not desc:
  420. desc = p['description']
  421. errorList.append(_("Parameter '%(name)s' (%(desc)s) is missing.") % \
  422. {'name' : p['name'], 'desc' : desc })
  423. return errorList
  424. def getCmd(self, ignoreErrors = False):
  425. """!Produce an array of command name and arguments for feeding
  426. into some execve-like command processor.
  427. If ignoreErrors = = True then it will return whatever has been
  428. built so far, even though it would not be a correct command
  429. for GRASS.
  430. """
  431. cmd = [self.name]
  432. suppress_required = False
  433. for flag in self.flags:
  434. if flag['value']:
  435. if len(flag['name']) > 1: # e.g. overwrite
  436. cmd += [ '--' + flag['name'] ]
  437. else:
  438. cmd += [ '-' + flag['name'] ]
  439. if flag['suppress_required']:
  440. suppress_required = True
  441. for p in self.params:
  442. if p.get('value','') == '' and p.get('required', False):
  443. if p.get('default', '') != '':
  444. cmd += [ '%s=%s' % (p['name'], p['default']) ]
  445. elif ignoreErrors is True and not suppress_required:
  446. cmd += [ '%s=%s' % (p['name'], _('<required>')) ]
  447. elif p.get('value','') != '' and p['value'] != p.get('default','') :
  448. # Output only values that have been set, and different from defaults
  449. cmd += [ '%s=%s' % (p['name'], p['value']) ]
  450. errList = self.getCmdError()
  451. if ignoreErrors is False and errList:
  452. raise ValueError, '\n'.join(errList)
  453. return cmd
  454. def set_options(self, opts):
  455. """!Set flags and parameters
  456. @param opts list of flags and parameters"""
  457. for opt in opts:
  458. if opt[0] == '-': # flag
  459. self.set_flag(opt.lstrip('-'), True)
  460. else: # parameter
  461. key, value = opt.split('=', 1)
  462. self.set_param(key, value)
  463. def get_options(self):
  464. """!Get options"""
  465. return { 'flags' : self.flags,
  466. 'params' : self.params }
  467. def has_required(self):
  468. """!Check if command has at least one required paramater"""
  469. for p in self.params:
  470. if p.get('required', False):
  471. return True
  472. return False
  473. class processTask:
  474. """!A ElementTree handler for the --interface-description output,
  475. as defined in grass-interface.dtd. Extend or modify this and the
  476. DTD if the XML output of GRASS' parser is extended or modified.
  477. @param tree root tree node
  478. @param task grassTask instance or None
  479. @return grassTask instance
  480. """
  481. def __init__(self, tree, task = None):
  482. if task:
  483. self.task = task
  484. else:
  485. self.task = grassTask()
  486. self.root = tree
  487. self.__processModule()
  488. self.__processParams()
  489. self.__processFlags()
  490. self.task.define_first()
  491. def __processModule(self):
  492. """!Process module description"""
  493. self.task.name = self.root.get('name', default = 'unknown')
  494. # keywords
  495. for keyword in self._getNodeText(self.root, 'keywords').split(','):
  496. self.task.keywords.append(keyword.strip())
  497. self.task.label = self._getNodeText(self.root, 'label')
  498. self.task.description = self._getNodeText(self.root, 'description')
  499. def __processParams(self):
  500. """!Process parameters"""
  501. for p in self.root.findall('parameter'):
  502. # gisprompt
  503. node_gisprompt = p.find('gisprompt')
  504. gisprompt = False
  505. age = element = prompt = None
  506. if node_gisprompt is not None:
  507. gisprompt = True
  508. age = node_gisprompt.get('age', '')
  509. element = node_gisprompt.get('element', '')
  510. prompt = node_gisprompt.get('prompt', '')
  511. # value(s)
  512. values = []
  513. values_desc = []
  514. node_values = p.find('values')
  515. if node_values is not None:
  516. for pv in node_values.findall('value'):
  517. values.append(self._getNodeText(pv, 'name'))
  518. desc = self._getNodeText(pv, 'description')
  519. if desc:
  520. values_desc.append(desc)
  521. # keydesc
  522. key_desc = []
  523. node_key_desc = p.find('keydesc')
  524. if node_key_desc is not None:
  525. for ki in node_key_desc.findall('item'):
  526. key_desc.append(ki.text)
  527. if p.get('multiple', 'no') == 'yes':
  528. multiple = True
  529. else:
  530. multiple = False
  531. if p.get('required', 'no') == 'yes':
  532. required = True
  533. else:
  534. required = False
  535. self.task.params.append({
  536. "name" : p.get('name'),
  537. "type" : p.get('type'),
  538. "required" : required,
  539. "multiple" : multiple,
  540. "label" : self._getNodeText(p, 'label'),
  541. "description" : self._getNodeText(p, 'description'),
  542. 'gisprompt' : gisprompt,
  543. 'age' : age,
  544. 'element' : element,
  545. 'prompt' : prompt,
  546. "guisection" : self._getNodeText(p, 'guisection'),
  547. "guidependency" : self._getNodeText(p, 'guidependency'),
  548. "default" : self._getNodeText(p, 'default'),
  549. "values" : values,
  550. "values_desc" : values_desc,
  551. "value" : '',
  552. "key_desc" : key_desc })
  553. def __processFlags(self):
  554. """!Process flags"""
  555. for p in self.root.findall('flag'):
  556. if p.find('suppress_required') is not None:
  557. suppress_required = True
  558. else:
  559. suppress_required = False
  560. self.task.flags.append({
  561. "name" : p.get('name'),
  562. "label" : self._getNodeText(p, 'label'),
  563. "description" : self._getNodeText(p, 'description'),
  564. "guisection" : self._getNodeText(p, 'guisection'),
  565. "suppress_required" : suppress_required,
  566. "value" : False })
  567. def _getNodeText(self, node, tag, default = ''):
  568. """!Get node text"""
  569. p = node.find(tag)
  570. if p is not None:
  571. return utils.normalize_whitespace(p.text)
  572. return default
  573. def GetTask(self):
  574. """!Get grassTask instance"""
  575. return self.task
  576. class mainFrame(wx.Frame):
  577. """!This is the Frame containing the dialog for options input.
  578. The dialog is organized in a notebook according to the guisections
  579. defined by each GRASS command.
  580. If run with a parent, it may Apply, Ok or Cancel; the latter two
  581. close the dialog. The former two trigger a callback.
  582. If run standalone, it will allow execution of the command.
  583. The command is checked and sent to the clipboard when clicking
  584. 'Copy'.
  585. """
  586. def __init__(self, parent, ID, task_description,
  587. get_dcmd = None, layer = None):
  588. self.get_dcmd = get_dcmd
  589. self.layer = layer
  590. self.task = task_description
  591. self.parent = parent # LayerTree | Modeler | None | ...
  592. if parent and parent.GetName() == 'Modeler':
  593. self.modeler = self.parent
  594. else:
  595. self.modeler = None
  596. # module name + keywords
  597. if self.task.name.split('.')[-1] in ('py', 'sh'):
  598. title = str(self.task.name.rsplit('.',1)[0])
  599. else:
  600. title = self.task.name
  601. try:
  602. if self.task.keywords != ['']:
  603. title += " [" + ', '.join(self.task.keywords) + "]"
  604. except ValueError:
  605. pass
  606. wx.Frame.__init__(self, parent = parent, id = ID, title = title,
  607. pos = wx.DefaultPosition, style = wx.DEFAULT_FRAME_STYLE | wx.TAB_TRAVERSAL,
  608. name = "MainFrame")
  609. self.locale = wx.Locale(language = wx.LANGUAGE_DEFAULT)
  610. self.panel = wx.Panel(parent = self, id = wx.ID_ANY)
  611. # statusbar
  612. self.CreateStatusBar()
  613. # icon
  614. self.SetIcon(wx.Icon(os.path.join(globalvar.ETCICONDIR, 'grass_dialog.ico'), wx.BITMAP_TYPE_ICO))
  615. guisizer = wx.BoxSizer(wx.VERTICAL)
  616. # set apropriate output window
  617. if self.parent:
  618. self.standalone = False
  619. else:
  620. self.standalone = True
  621. # logo + description
  622. topsizer = wx.BoxSizer(wx.HORIZONTAL)
  623. # GRASS logo
  624. self.logo = wx.StaticBitmap(parent = self.panel,
  625. bitmap = wx.Bitmap(name = os.path.join(imagepath,
  626. 'grass_form.png'),
  627. type = wx.BITMAP_TYPE_PNG))
  628. topsizer.Add(item = self.logo, proportion = 0, border = 3,
  629. flag = wx.ALL | wx.ALIGN_CENTER_VERTICAL)
  630. # add module description
  631. if self.task.label:
  632. module_desc = self.task.label + ' ' + self.task.description
  633. else:
  634. module_desc = self.task.description
  635. self.description = gdialogs.StaticWrapText(parent = self.panel,
  636. label = module_desc)
  637. topsizer.Add(item = self.description, proportion = 1, border = 5,
  638. flag = wx.ALL | wx.ALIGN_CENTER_VERTICAL | wx.EXPAND)
  639. guisizer.Add(item = topsizer, proportion = 0, flag = wx.EXPAND)
  640. self.panel.SetSizerAndFit(guisizer)
  641. self.Layout()
  642. # notebooks
  643. self.notebookpanel = cmdPanel(parent = self.panel, task = self.task,
  644. mainFrame = self)
  645. self.goutput = self.notebookpanel.goutput
  646. self.notebookpanel.OnUpdateValues = self.updateValuesHook
  647. guisizer.Add(item = self.notebookpanel, proportion = 1, flag = wx.EXPAND)
  648. # status bar
  649. status_text = _("Enter parameters for '") + self.task.name + "'"
  650. try:
  651. self.task.getCmd()
  652. self.updateValuesHook()
  653. except ValueError:
  654. self.SetStatusText(status_text)
  655. # buttons
  656. btnsizer = wx.BoxSizer(orient = wx.HORIZONTAL)
  657. # cancel
  658. self.btn_cancel = wx.Button(parent = self.panel, id = wx.ID_CLOSE)
  659. self.btn_cancel.SetToolTipString(_("Close this window without executing the command (Ctrl+Q)"))
  660. btnsizer.Add(item = self.btn_cancel, proportion = 0, flag = wx.ALL | wx.ALIGN_CENTER, border = 10)
  661. self.btn_cancel.Bind(wx.EVT_BUTTON, self.OnCancel)
  662. if self.get_dcmd is not None: # A callback has been set up
  663. btn_apply = wx.Button(parent = self.panel, id = wx.ID_APPLY)
  664. btn_ok = wx.Button(parent = self.panel, id = wx.ID_OK)
  665. btn_ok.SetDefault()
  666. btnsizer.Add(item = btn_apply, proportion = 0,
  667. flag = wx.ALL | wx.ALIGN_CENTER,
  668. border = 10)
  669. btnsizer.Add(item = btn_ok, proportion = 0,
  670. flag = wx.ALL | wx.ALIGN_CENTER,
  671. border = 10)
  672. btn_apply.Bind(wx.EVT_BUTTON, self.OnApply)
  673. btn_ok.Bind(wx.EVT_BUTTON, self.OnOK)
  674. else: # We're standalone
  675. # run
  676. self.btn_run = wx.Button(parent = self.panel, id = wx.ID_OK, label = _("&Run"))
  677. self.btn_run.SetToolTipString(_("Run the command (Ctrl+R)"))
  678. self.btn_run.SetDefault()
  679. # copy
  680. self.btn_clipboard = wx.Button(parent = self.panel, id = wx.ID_COPY, label = _("C&opy"))
  681. self.btn_clipboard.SetToolTipString(_("Copy the current command string to the clipboard (Ctrl+C)"))
  682. btnsizer.Add(item = self.btn_run, proportion = 0,
  683. flag = wx.ALL | wx.ALIGN_CENTER,
  684. border = 10)
  685. btnsizer.Add(item = self.btn_clipboard, proportion = 0,
  686. flag = wx.ALL | wx.ALIGN_CENTER,
  687. border = 10)
  688. self.btn_run.Bind(wx.EVT_BUTTON, self.OnRun)
  689. self.btn_clipboard.Bind(wx.EVT_BUTTON, self.OnCopy)
  690. # help
  691. self.btn_help = wx.Button(parent = self.panel, id = wx.ID_HELP)
  692. self.btn_help.SetToolTipString(_("Show manual page of the command (Ctrl+H)"))
  693. self.btn_help.Bind(wx.EVT_BUTTON, self.OnHelp)
  694. if not hasattr(self.notebookpanel, "manual_tab_id"):
  695. self.btn_help.Hide()
  696. # add help button
  697. btnsizer.Add(item = self.btn_help, proportion = 0, flag = wx.ALL | wx.ALIGN_CENTER, border = 10)
  698. guisizer.Add(item = btnsizer, proportion = 0, flag = wx.ALIGN_CENTER | wx.LEFT | wx.RIGHT,
  699. border = 30)
  700. if self.parent and not self.modeler:
  701. addLayer = False
  702. for p in self.task.params:
  703. if p.get('age', 'old') == 'new' and \
  704. p.get('prompt', '') in ('raster', 'vector', '3d-raster'):
  705. addLayer = True
  706. if addLayer:
  707. # add newly created map into layer tree
  708. self.addbox = wx.CheckBox(parent = self.panel,
  709. label = _('Add created map(s) into layer tree'), style = wx.NO_BORDER)
  710. self.addbox.SetValue(UserSettings.Get(group = 'cmd', key = 'addNewLayer', subkey = 'enabled'))
  711. guisizer.Add(item = self.addbox, proportion = 0,
  712. flag = wx.EXPAND | wx.LEFT | wx.RIGHT | wx.BOTTOM,
  713. border = 5)
  714. if self.get_dcmd is None:
  715. # close dialog when command is terminated
  716. self.closebox = wx.CheckBox(parent = self.panel,
  717. label = _('Close dialog on finish'), style = wx.NO_BORDER)
  718. self.closebox.SetValue(UserSettings.Get(group = 'cmd', key = 'closeDlg', subkey = 'enabled'))
  719. self.closebox.SetToolTipString(_("Close dialog when command is successfully finished. "
  720. "Change this settings in Preferences dialog ('Command' tab)."))
  721. guisizer.Add(item = self.closebox, proportion = 0,
  722. flag = wx.EXPAND | wx.LEFT | wx.RIGHT | wx.BOTTOM,
  723. border = 5)
  724. self.Bind(wx.EVT_CLOSE, self.OnCancel)
  725. self.Bind(wx.EVT_KEY_UP, self.OnKeyUp)
  726. # do layout
  727. # called automatically by SetSizer()
  728. self.panel.SetAutoLayout(True)
  729. self.panel.SetSizerAndFit(guisizer)
  730. sizeFrame = self.GetBestSize()
  731. self.SetMinSize(sizeFrame)
  732. if hasattr(self, "closebox"):
  733. scale = 0.33
  734. else:
  735. scale = 0.50
  736. self.SetSize(wx.Size(sizeFrame[0], sizeFrame[1] + scale * max(self.notebookpanel.panelMinHeight,
  737. self.notebookpanel.constrained_size[1])))
  738. # thread to update dialog
  739. # create queues
  740. self.requestQ = Queue.Queue()
  741. self.resultQ = Queue.Queue()
  742. self.updateThread = UpdateQThread(self.notebookpanel, self.requestQ, self.resultQ)
  743. self.Layout()
  744. # keep initial window size limited for small screens
  745. width, height = self.GetSizeTuple()
  746. self.SetSize(wx.Size(min(width, 650),
  747. min(height, 500)))
  748. # fix goutput's pane size
  749. if self.goutput:
  750. self.goutput.SetSashPosition(int(self.GetSize()[1] * .75))
  751. def updateValuesHook(self, event = None):
  752. """!Update status bar data"""
  753. self.SetStatusText(' '.join(self.notebookpanel.createCmd(ignoreErrors = True)))
  754. if event:
  755. event.Skip()
  756. def OnKeyUp(self, event):
  757. """!Key released (check hot-keys)"""
  758. try:
  759. kc = chr(event.GetKeyCode())
  760. except ValueError:
  761. event.Skip()
  762. return
  763. if not event.ControlDown():
  764. event.Skip()
  765. return
  766. if kc == 'Q':
  767. self.OnCancel(None)
  768. elif kc == 'S':
  769. self.OnAbort(None)
  770. elif kc == 'H':
  771. self.OnHelp(None)
  772. elif kc == 'R':
  773. self.OnRun(None)
  774. elif kc == 'C':
  775. self.OnCopy(None)
  776. event.Skip()
  777. def OnDone(self, cmd, returncode):
  778. """!This function is launched from OnRun() when command is
  779. finished
  780. @param returncode command's return code (0 for success)
  781. """
  782. if not self.parent or returncode != 0:
  783. return
  784. if self.parent.GetName() not in ('LayerTree', 'LayerManager'):
  785. return
  786. if self.parent.GetName() == 'LayerTree':
  787. display = self.parent.GetMapDisplay()
  788. else: # Layer Manager
  789. display = self.parent.GetLayerTree().GetMapDisplay()
  790. if not display or not display.IsAutoRendered():
  791. return
  792. mapLayers = map(lambda x: x.GetName(),
  793. display.GetRender().GetListOfLayers(l_type = 'raster') +
  794. display.GetRender().GetListOfLayers(l_type = 'vector'))
  795. task = GUI().ParseCommand(cmd, show = None)
  796. for p in task.get_options()['params']:
  797. if p.get('prompt', '') not in ('raster', 'vector'):
  798. continue
  799. mapName = p.get('value', '')
  800. if '@' not in mapName:
  801. mapName = mapName + '@' + grass.gisenv()['MAPSET']
  802. if mapName in mapLayers:
  803. display.GetWindow().UpdateMap(render = True)
  804. return
  805. def OnOK(self, event):
  806. """!OK button pressed"""
  807. cmd = self.OnApply(event)
  808. if cmd is not None and self.get_dcmd is not None:
  809. self.OnCancel(event)
  810. def OnApply(self, event):
  811. """!Apply the command"""
  812. if self.modeler:
  813. cmd = self.createCmd(ignoreErrors = True)
  814. else:
  815. cmd = self.createCmd()
  816. if cmd is not None and self.get_dcmd is not None:
  817. # return d.* command to layer tree for rendering
  818. self.get_dcmd(cmd, self.layer, {"params": self.task.params,
  819. "flags" : self.task.flags},
  820. self)
  821. # echo d.* command to output console
  822. # self.parent.writeDCommand(cmd)
  823. return cmd
  824. def OnRun(self, event):
  825. """!Run the command"""
  826. cmd = self.createCmd()
  827. if not cmd or len(cmd) < 1:
  828. return
  829. if self.standalone or cmd[0][0:2] != "d.":
  830. # Send any non-display command to parent window (probably wxgui.py)
  831. # put to parents switch to 'Command output'
  832. if self.notebookpanel.notebook.GetSelection() != self.notebookpanel.goutputId:
  833. self.notebookpanel.notebook.SetSelection(self.notebookpanel.goutputId)
  834. try:
  835. if self.task.path:
  836. cmd[0] = self.task.path # full path
  837. self.goutput.RunCmd(cmd, onDone = self.OnDone)
  838. except AttributeError, e:
  839. print >> sys.stderr, "%s: Propably not running in wxgui.py session?" % (e)
  840. print >> sys.stderr, "parent window is: %s" % (str(self.parent))
  841. else:
  842. gcmd.Command(cmd)
  843. # update buttons status
  844. for btn in (self.btn_run,
  845. self.btn_cancel,
  846. self.btn_clipboard,
  847. self.btn_help):
  848. btn.Enable(False)
  849. def OnAbort(self, event):
  850. """!Abort running command"""
  851. event = goutput.wxCmdAbort(aborted = True)
  852. wx.PostEvent(self.goutput, event)
  853. def OnCopy(self, event):
  854. """!Copy the command"""
  855. cmddata = wx.TextDataObject()
  856. # list -> string
  857. cmdstring = ' '.join(self.createCmd(ignoreErrors = True))
  858. cmddata.SetText(cmdstring)
  859. if wx.TheClipboard.Open():
  860. # wx.TheClipboard.UsePrimarySelection(True)
  861. wx.TheClipboard.SetData(cmddata)
  862. wx.TheClipboard.Close()
  863. self.SetStatusText(_("'%s' copied to clipboard") % \
  864. (cmdstring))
  865. def OnCancel(self, event):
  866. """!Cancel button pressed"""
  867. self.MakeModal(False)
  868. if self.get_dcmd and \
  869. self.parent and \
  870. self.parent.GetName() in ('LayerTree',
  871. 'MapWindow'):
  872. # display decorations and
  873. # pressing OK or cancel after setting layer properties
  874. if self.task.name in ['d.barscale','d.legend','d.histogram'] \
  875. or len(self.parent.GetPyData(self.layer)[0]['cmd']) >= 1:
  876. self.Hide()
  877. # canceled layer with nothing set
  878. elif len(self.parent.GetPyData(self.layer)[0]['cmd']) < 1:
  879. self.parent.Delete(self.layer)
  880. self.Destroy()
  881. else:
  882. # cancel for non-display commands
  883. self.Destroy()
  884. def OnHelp(self, event):
  885. """!Show manual page (switch to the 'Manual' notebook page)"""
  886. if hasattr(self.notebookpanel, "manual_tab_id"):
  887. self.notebookpanel.notebook.SetSelection(self.notebookpanel.manual_tab_id)
  888. self.notebookpanel.OnPageChange(None)
  889. if event:
  890. event.Skip()
  891. def createCmd(self, ignoreErrors = False):
  892. """!Create command string (python list)"""
  893. return self.notebookpanel.createCmd(ignoreErrors = ignoreErrors)
  894. class cmdPanel(wx.Panel):
  895. """!A panel containing a notebook dividing in tabs the different
  896. guisections of the GRASS cmd.
  897. """
  898. def __init__(self, parent, task, id = wx.ID_ANY, mainFrame = None, *args, **kwargs):
  899. if mainFrame:
  900. self.parent = mainFrame
  901. else:
  902. self.parent = parent
  903. self.task = task
  904. wx.Panel.__init__(self, parent, id = id, *args, **kwargs)
  905. # Determine tab layout
  906. sections = []
  907. is_section = {}
  908. not_hidden = [ p for p in self.task.params + self.task.flags if not p.get('hidden','no') == 'yes' ]
  909. self.label_id = [] # wrap titles on resize
  910. self.Bind(wx.EVT_SIZE, self.OnSize)
  911. for task in not_hidden:
  912. if task.get('required', False):
  913. # All required go into Main, even if they had defined another guisection
  914. task['guisection'] = _('Required')
  915. if task.get('guisection','') == '':
  916. # Undefined guisections end up into Options
  917. task['guisection'] = _('Optional')
  918. if not is_section.has_key(task['guisection']):
  919. # We do it like this to keep the original order, except for Main which goes first
  920. is_section[task['guisection']] = 1
  921. sections.append(task['guisection'])
  922. else:
  923. is_section[ task['guisection'] ] += 1
  924. del is_section
  925. # 'Required' tab goes first, 'Optional' as the last one
  926. for (newidx,content) in [ (0,_('Required')), (len(sections)-1,_('Optional')) ]:
  927. if content in sections:
  928. idx = sections.index(content)
  929. sections[idx:idx+1] = []
  930. sections[newidx:newidx] = [content]
  931. panelsizer = wx.BoxSizer(orient = wx.VERTICAL)
  932. # Build notebook
  933. nbStyle = globalvar.FNPageStyle
  934. if globalvar.hasAgw:
  935. self.notebook = FN.FlatNotebook(self, id = wx.ID_ANY, agwStyle = nbStyle)
  936. else:
  937. self.notebook = FN.FlatNotebook(self, id = wx.ID_ANY, style = nbStyle)
  938. self.notebook.SetTabAreaColour(globalvar.FNPageColor)
  939. self.notebook.Bind(FN.EVT_FLATNOTEBOOK_PAGE_CHANGED, self.OnPageChange)
  940. tab = {}
  941. tabsizer = {}
  942. for section in sections:
  943. tab[section] = scrolled.ScrolledPanel(parent = self.notebook)
  944. tab[section].SetScrollRate(10, 10)
  945. tabsizer[section] = wx.BoxSizer(orient = wx.VERTICAL)
  946. self.notebook.AddPage(tab[section], text = section)
  947. # are we running from command line?
  948. ### add 'command output' tab regardless standalone dialog
  949. if self.parent.GetName() == "MainFrame" and self.parent.get_dcmd is None:
  950. self.goutput = goutput.GMConsole(parent = self, margin = False,
  951. pageid = self.notebook.GetPageCount())
  952. self.goutputId = self.notebook.GetPageCount()
  953. self.outpage = self.notebook.AddPage(self.goutput, text = _("Command output"))
  954. else:
  955. self.goutput = None
  956. self.goutputId = -1
  957. self.manual_tab = HelpPanel(parent = self, grass_command = self.task.name)
  958. if not self.manual_tab.IsFile():
  959. self.manual_tab.Hide()
  960. else:
  961. self.notebook.AddPage(self.manual_tab, text = _("Manual"))
  962. self.manual_tab_id = self.notebook.GetPageCount() - 1
  963. self.notebook.SetSelection(0)
  964. panelsizer.Add(item = self.notebook, proportion = 1, flag = wx.EXPAND)
  965. #
  966. # flags
  967. #
  968. text_style = wx.FONTWEIGHT_NORMAL
  969. visible_flags = [ f for f in self.task.flags if not f.get('hidden', 'no') == 'yes' ]
  970. for f in visible_flags:
  971. which_sizer = tabsizer[ f['guisection'] ]
  972. which_panel = tab[ f['guisection'] ]
  973. # if label is given: description -> tooltip
  974. if f.get('label','') != '':
  975. title = text_beautify(f['label'])
  976. tooltip = text_beautify(f['description'], width = -1)
  977. else:
  978. title = text_beautify(f['description'])
  979. tooltip = None
  980. title_sizer = wx.BoxSizer(wx.HORIZONTAL)
  981. rtitle_txt = wx.StaticText(parent = which_panel,
  982. label = '(' + f['name'] + ')')
  983. chk = wx.CheckBox(parent = which_panel, label = title, style = wx.NO_BORDER)
  984. self.label_id.append(chk.GetId())
  985. if tooltip:
  986. chk.SetToolTipString(tooltip)
  987. chk.SetValue(f.get('value', False))
  988. title_sizer.Add(item = chk, proportion = 1,
  989. flag = wx.EXPAND)
  990. title_sizer.Add(item = rtitle_txt, proportion = 0,
  991. flag = wx.ALIGN_RIGHT | wx.ALIGN_CENTER_VERTICAL)
  992. which_sizer.Add(item = title_sizer, proportion = 0,
  993. flag = wx.EXPAND | wx.TOP | wx.LEFT | wx.RIGHT, border = 5)
  994. f['wxId'] = [ chk.GetId(), ]
  995. chk.Bind(wx.EVT_CHECKBOX, self.OnSetValue)
  996. if self.parent.GetName() == 'MainFrame' and self.parent.modeler:
  997. parChk = wx.CheckBox(parent = which_panel, id = wx.ID_ANY,
  998. label = _("Parameterized in model"))
  999. parChk.SetName('ModelParam')
  1000. parChk.SetValue(f.get('parameterized', False))
  1001. if f.has_key('wxId'):
  1002. f['wxId'].append(parChk.GetId())
  1003. else:
  1004. f['wxId'] = [ parChk.GetId() ]
  1005. parChk.Bind(wx.EVT_CHECKBOX, self.OnSetValue)
  1006. which_sizer.Add(item = parChk, proportion = 0,
  1007. flag = wx.LEFT, border = 20)
  1008. if f['name'] in ('verbose', 'quiet'):
  1009. chk.Bind(wx.EVT_CHECKBOX, self.OnVerbosity)
  1010. vq = UserSettings.Get(group = 'cmd', key = 'verbosity', subkey = 'selection')
  1011. if f['name'] == vq:
  1012. chk.SetValue(True)
  1013. f['value'] = True
  1014. elif f['name'] == 'overwrite' and not f.has_key('value'):
  1015. chk.SetValue(UserSettings.Get(group = 'cmd', key = 'overwrite', subkey = 'enabled'))
  1016. f['value'] = UserSettings.Get(group = 'cmd', key = 'overwrite', subkey = 'enabled')
  1017. #
  1018. # parameters
  1019. #
  1020. visible_params = [ p for p in self.task.params if not p.get('hidden', 'no') == 'yes' ]
  1021. try:
  1022. first_param = visible_params[0]
  1023. except IndexError:
  1024. first_param = None
  1025. for p in visible_params:
  1026. which_sizer = tabsizer[ p['guisection'] ]
  1027. which_panel = tab[ p['guisection'] ]
  1028. # if label is given -> label and description -> tooltip
  1029. # otherwise description -> lavel
  1030. if p.get('label','') != '':
  1031. title = text_beautify(p['label'])
  1032. tooltip = text_beautify(p['description'], width = -1)
  1033. else:
  1034. title = text_beautify(p['description'])
  1035. tooltip = None
  1036. txt = None
  1037. # text style (required -> bold)
  1038. if not p.get('required', False):
  1039. text_style = wx.FONTWEIGHT_NORMAL
  1040. else:
  1041. text_style = wx.FONTWEIGHT_BOLD
  1042. # title sizer (description, name, type)
  1043. if (len(p.get('values', [])) > 0) and \
  1044. p.get('multiple', False) and \
  1045. p.get('gisprompt',False) == False and \
  1046. p.get('type', '') == 'string':
  1047. title_txt = wx.StaticBox(parent = which_panel, id = wx.ID_ANY)
  1048. else:
  1049. title_sizer = wx.BoxSizer(wx.HORIZONTAL)
  1050. title_txt = wx.StaticText(parent = which_panel)
  1051. if p['key_desc']:
  1052. ltype = ','.join(p['key_desc'])
  1053. else:
  1054. ltype = p['type']
  1055. rtitle_txt = wx.StaticText(parent = which_panel,
  1056. label = '(' + p['name'] + '=' + ltype + ')')
  1057. title_sizer.Add(item = title_txt, proportion = 1,
  1058. flag = wx.LEFT | wx.TOP | wx.EXPAND, border = 5)
  1059. title_sizer.Add(item = rtitle_txt, proportion = 0,
  1060. flag = wx.ALIGN_RIGHT | wx.RIGHT | wx.TOP, border = 5)
  1061. which_sizer.Add(item = title_sizer, proportion = 0,
  1062. flag = wx.EXPAND)
  1063. self.label_id.append(title_txt.GetId())
  1064. # title expansion
  1065. if p.get('multiple', False) and len(p.get('values','')) == 0:
  1066. title = _("[multiple]") + " " + title
  1067. if p.get('value','') == '' :
  1068. p['value'] = p.get('default','')
  1069. if (len(p.get('values', [])) > 0):
  1070. valuelist = map(str, p.get('values',[]))
  1071. valuelist_desc = map(unicode, p.get('values_desc',[]))
  1072. if p.get('multiple', False) and \
  1073. p.get('gisprompt',False) == False and \
  1074. p.get('type', '') == 'string':
  1075. title_txt.SetLabel(" %s: (%s, %s) " % (title, p['name'], p['type']))
  1076. if valuelist_desc:
  1077. hSizer = wx.StaticBoxSizer(box = title_txt, orient = wx.VERTICAL)
  1078. else:
  1079. hSizer = wx.StaticBoxSizer(box = title_txt, orient = wx.HORIZONTAL)
  1080. isEnabled = {}
  1081. # copy default values
  1082. if p['value'] == '':
  1083. p['value'] = p.get('default', '')
  1084. for defval in p.get('value', '').split(','):
  1085. isEnabled[ defval ] = 'yes'
  1086. # for multi checkboxes, this is an array of all wx IDs
  1087. # for each individual checkbox
  1088. p[ 'wxId' ] = list()
  1089. idx = 0
  1090. for val in valuelist:
  1091. try:
  1092. label = valuelist_desc[idx]
  1093. except IndexError:
  1094. label = val
  1095. chkbox = wx.CheckBox(parent = which_panel,
  1096. label = text_beautify(label))
  1097. p[ 'wxId' ].append(chkbox.GetId())
  1098. if isEnabled.has_key(val):
  1099. chkbox.SetValue(True)
  1100. hSizer.Add(item = chkbox, proportion = 0,
  1101. flag = wx.ADJUST_MINSIZE | wx.ALL, border = 1)
  1102. chkbox.Bind(wx.EVT_CHECKBOX, self.OnCheckBoxMulti)
  1103. idx += 1
  1104. which_sizer.Add(item = hSizer, proportion = 0,
  1105. flag = wx.EXPAND | wx.TOP | wx.RIGHT | wx.LEFT, border = 5)
  1106. elif p.get('gisprompt', False) == False:
  1107. if len(valuelist) == 1: # -> textctrl
  1108. title_txt.SetLabel("%s (%s %s):" % (title, _('valid range'),
  1109. str(valuelist[0])))
  1110. if p.get('type', '') == 'integer' and \
  1111. not p.get('multiple', False):
  1112. # for multiple integers use textctrl instead of spinsctrl
  1113. try:
  1114. minValue, maxValue = map(int, valuelist[0].split('-'))
  1115. except ValueError:
  1116. minValue = -1e6
  1117. maxValue = 1e6
  1118. txt2 = wx.SpinCtrl(parent = which_panel, id = wx.ID_ANY, size = globalvar.DIALOG_SPIN_SIZE,
  1119. min = minValue, max = maxValue)
  1120. txt2.SetName("SpinCtrl")
  1121. style = wx.BOTTOM | wx.LEFT
  1122. else:
  1123. txt2 = wx.TextCtrl(parent = which_panel, value = p.get('default',''))
  1124. txt2.SetName("TextCtrl")
  1125. style = wx.EXPAND | wx.BOTTOM | wx.LEFT
  1126. value = self._GetValue(p)
  1127. # parameter previously set
  1128. if value:
  1129. if txt2.GetName() == "SpinCtrl":
  1130. txt2.SetValue(int(value))
  1131. else:
  1132. txt2.SetValue(value)
  1133. which_sizer.Add(item = txt2, proportion = 0,
  1134. flag = style, border = 5)
  1135. p['wxId'] = [ txt2.GetId(), ]
  1136. txt2.Bind(wx.EVT_TEXT, self.OnSetValue)
  1137. else:
  1138. # list of values (combo)
  1139. title_txt.SetLabel(title + ':')
  1140. cb = wx.ComboBox(parent = which_panel, id = wx.ID_ANY, value = p.get('default',''),
  1141. size = globalvar.DIALOG_COMBOBOX_SIZE,
  1142. choices = valuelist, style = wx.CB_DROPDOWN)
  1143. value = self._GetValue(p)
  1144. if value:
  1145. cb.SetValue(value) # parameter previously set
  1146. which_sizer.Add(item = cb, proportion = 0,
  1147. flag = wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT, border = 5)
  1148. p['wxId'] = [cb.GetId(),]
  1149. cb.Bind(wx.EVT_COMBOBOX, self.OnSetValue)
  1150. cb.Bind(wx.EVT_TEXT, self.OnSetValue)
  1151. # text entry
  1152. if (p.get('type','string') in ('string','integer','float')
  1153. and len(p.get('values',[])) == 0
  1154. and p.get('gisprompt',False) == False
  1155. and p.get('prompt','') != 'color'):
  1156. title_txt.SetLabel(title + ':')
  1157. if p.get('multiple', False) or \
  1158. p.get('type', 'string') == 'string' or \
  1159. len(p.get('key_desc', [])) > 1:
  1160. txt3 = wx.TextCtrl(parent = which_panel, value = p.get('default',''))
  1161. value = self._GetValue(p)
  1162. if value:
  1163. # parameter previously set
  1164. txt3.SetValue(str(value))
  1165. txt3.Bind(wx.EVT_TEXT, self.OnSetValue)
  1166. style = wx.EXPAND | wx.BOTTOM | wx.LEFT | wx.RIGHT
  1167. else:
  1168. minValue = -1e9
  1169. maxValue = 1e9
  1170. if p.get('type', '') == 'integer':
  1171. txt3 = wx.SpinCtrl(parent = which_panel, value = p.get('default',''),
  1172. size = globalvar.DIALOG_SPIN_SIZE,
  1173. min = minValue, max = maxValue)
  1174. style = wx.BOTTOM | wx.LEFT | wx.RIGHT
  1175. value = self._GetValue(p)
  1176. if value:
  1177. txt3.SetValue(int(value)) # parameter previously set
  1178. txt3.Bind(wx.EVT_SPINCTRL, self.OnSetValue)
  1179. else:
  1180. txt3 = wx.TextCtrl(parent = which_panel, value = p.get('default',''),
  1181. validator = FloatValidator())
  1182. style = wx.EXPAND | wx.BOTTOM | wx.LEFT | wx.RIGHT
  1183. value = self._GetValue(p)
  1184. if value:
  1185. txt3.SetValue(str(value)) # parameter previously set
  1186. txt3.Bind(wx.EVT_TEXT, self.OnSetValue)
  1187. which_sizer.Add(item = txt3, proportion = 0,
  1188. flag = style, border = 5)
  1189. p['wxId'] = [ txt3.GetId(), ]
  1190. #
  1191. # element selection tree combobox (maps, icons, regions, etc.)
  1192. #
  1193. if p.get('gisprompt', False) == True:
  1194. title_txt.SetLabel(title + ':')
  1195. # GIS element entry
  1196. if p.get('prompt','') not in ('color',
  1197. 'color_none',
  1198. 'subgroup',
  1199. 'dbdriver',
  1200. 'dbname',
  1201. 'dbtable',
  1202. 'dbcolumn',
  1203. 'layer',
  1204. 'layer_all',
  1205. 'location',
  1206. 'mapset',
  1207. 'dbase') and \
  1208. p.get('element', '') != 'file':
  1209. multiple = p.get('multiple', False)
  1210. if p.get('age', '') == 'new':
  1211. mapsets = [grass.gisenv()['MAPSET'],]
  1212. else:
  1213. mapsets = None
  1214. if self.task.name in ('r.proj', 'v.proj') \
  1215. and p.get('name', '') == 'input':
  1216. if self.task.name == 'r.proj':
  1217. isRaster = True
  1218. else:
  1219. isRaster = False
  1220. selection = gselect.ProjSelect(parent = which_panel,
  1221. isRaster = isRaster)
  1222. p['wxId'] = [ selection.GetId(), ]
  1223. selection.Bind(wx.EVT_COMBOBOX, self.OnSetValue)
  1224. formatSelector = False
  1225. selection.Bind(wx.EVT_TEXT, self.OnUpdateSelection)
  1226. else:
  1227. selection = gselect.Select(parent = which_panel, id = wx.ID_ANY,
  1228. size = globalvar.DIALOG_GSELECT_SIZE,
  1229. type = p.get('element', ''),
  1230. multiple = multiple, mapsets = mapsets)
  1231. formatSelector = True
  1232. # A select.Select is a combobox with two children: a textctl and a popupwindow;
  1233. # we target the textctl here
  1234. p['wxId'] = [selection.GetChildren()[0].GetId(), ]
  1235. selection.GetChildren()[0].Bind(wx.EVT_TEXT, self.OnSetValue)
  1236. if p.get('prompt', '') == 'vector':
  1237. selection.Bind(wx.EVT_TEXT, self.OnUpdateSelection)
  1238. if formatSelector and p.get('age', '') == 'old':
  1239. # OGR supported (read-only)
  1240. self.hsizer = wx.BoxSizer(wx.HORIZONTAL)
  1241. self.hsizer.Add(item = selection,
  1242. flag = wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT | wx.RIGHT | wx.TOP | wx.ALIGN_TOP,
  1243. border = 5)
  1244. # format (native / ogr)
  1245. rbox = wx.RadioBox(parent = which_panel, id = wx.ID_ANY,
  1246. label = " %s " % _("Format"),
  1247. style = wx.RA_SPECIFY_ROWS,
  1248. choices = [_("Native / Linked OGR"), _("Direct OGR")])
  1249. if p.get('value', '').lower().rfind('@ogr') > -1:
  1250. rbox.SetSelection(1)
  1251. rbox.SetName('VectorFormat')
  1252. rbox.Bind(wx.EVT_RADIOBOX, self.OnVectorFormat)
  1253. self.hsizer.Add(item = rbox,
  1254. flag = wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT |
  1255. wx.RIGHT | wx.ALIGN_TOP,
  1256. border = 5)
  1257. ogrSelection = gselect.GdalSelect(parent = self, panel = which_panel, ogr = True,
  1258. default = 'dir',
  1259. exclude = ['file'])
  1260. self.Bind(gselect.EVT_GDALSELECT, self.OnUpdateSelection)
  1261. self.Bind(gselect.EVT_GDALSELECT, self.OnSetValue)
  1262. ogrSelection.SetName('OgrSelect')
  1263. ogrSelection.Hide()
  1264. which_sizer.Add(item = self.hsizer, proportion = 0)
  1265. p['wxId'].append(rbox.GetId())
  1266. p['wxId'].append(ogrSelection.GetId())
  1267. for win in ogrSelection.GetDsnWin():
  1268. p['wxId'].append(win.GetId())
  1269. else:
  1270. which_sizer.Add(item = selection, proportion = 0,
  1271. flag = wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT | wx.RIGHT | wx.TOP | wx.ALIGN_CENTER_VERTICAL,
  1272. border = 5)
  1273. elif p.get('prompt', '') == 'group':
  1274. selection.Bind(wx.EVT_TEXT, self.OnUpdateSelection)
  1275. which_sizer.Add(item = selection, proportion = 0,
  1276. flag = wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT | wx.RIGHT | wx.TOP | wx.ALIGN_CENTER_VERTICAL,
  1277. border = 5)
  1278. else:
  1279. which_sizer.Add(item = selection, proportion = 0,
  1280. flag = wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT | wx.RIGHT | wx.TOP | wx.ALIGN_CENTER_VERTICAL,
  1281. border = 5)
  1282. # subgroup
  1283. elif p.get('prompt', '') == 'subgroup':
  1284. selection = gselect.SubGroupSelect(parent = which_panel)
  1285. p['wxId'] = [ selection.GetId() ]
  1286. selection.Bind(wx.EVT_COMBOBOX, self.OnSetValue)
  1287. which_sizer.Add(item = selection, proportion = 0,
  1288. flag = wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT | wx.RIGHT | wx.TOP | wx.ALIGN_CENTER_VERTICAL,
  1289. border = 5)
  1290. # layer, dbdriver, dbname, dbcolumn, dbtable entry
  1291. elif p.get('prompt', '') in ('dbdriver',
  1292. 'dbname',
  1293. 'dbtable',
  1294. 'dbcolumn',
  1295. 'layer',
  1296. 'layer_all',
  1297. 'location',
  1298. 'mapset',
  1299. 'dbase'):
  1300. if p.get('multiple', 'no') == 'yes':
  1301. win = wx.TextCtrl(parent = which_panel, value = p.get('default',''),
  1302. size = globalvar.DIALOG_TEXTCTRL_SIZE)
  1303. win.Bind(wx.EVT_TEXT, self.OnSetValue)
  1304. else:
  1305. value = p.get('value', '')
  1306. if not value:
  1307. value = p.get('default', '')
  1308. if p.get('prompt', '') in ('layer',
  1309. 'layer_all'):
  1310. if p.get('prompt', '') == 'layer_all':
  1311. all = True
  1312. else:
  1313. all = False
  1314. win = wx.BoxSizer(wx.HORIZONTAL)
  1315. if p.get('age', 'old') == 'old':
  1316. win1 = gselect.LayerSelect(parent = which_panel,
  1317. all = all,
  1318. default = p['default'])
  1319. win1.Bind(wx.EVT_CHOICE, self.OnUpdateSelection)
  1320. win1.Bind(wx.EVT_CHOICE, self.OnSetValue)
  1321. else:
  1322. win1 = wx.SpinCtrl(parent = which_panel, id = wx.ID_ANY,
  1323. min = 1, max = 100, initial = int(p['default']))
  1324. win1.Bind(wx.EVT_SPINCTRL, self.OnSetValue)
  1325. win2 = gselect.LayerNameSelect(parent = which_panel)
  1326. if p.get('value','') != '':
  1327. win2.SetItems([p['value']])
  1328. win2.SetSelection(0)
  1329. win2.Bind(wx.EVT_COMBOBOX, self.OnSetValue)
  1330. p['wxId'] = [ win1.GetId(), win2.GetId() ]
  1331. win.Add(item = win1, proportion = 0)
  1332. win.Add(item = win2, proportion = 0,
  1333. flag = wx.LEFT | wx.ALIGN_CENTER_VERTICAL,
  1334. border = 5)
  1335. elif p.get('prompt', '') == 'dbdriver':
  1336. win = gselect.DriverSelect(parent = which_panel,
  1337. choices = p.get('values', []),
  1338. value = value)
  1339. win.Bind(wx.EVT_COMBOBOX, self.OnUpdateSelection)
  1340. win.Bind(wx.EVT_COMBOBOX, self.OnSetValue)
  1341. elif p.get('prompt', '') == 'dbname':
  1342. win = gselect.DatabaseSelect(parent = which_panel,
  1343. value = value)
  1344. win.Bind(wx.EVT_TEXT, self.OnUpdateSelection)
  1345. win.Bind(wx.EVT_TEXT, self.OnSetValue)
  1346. elif p.get('prompt', '') == 'dbtable':
  1347. if p.get('age', 'old') == 'old':
  1348. win = gselect.TableSelect(parent = which_panel)
  1349. win.Bind(wx.EVT_COMBOBOX, self.OnUpdateSelection)
  1350. win.Bind(wx.EVT_COMBOBOX, self.OnSetValue)
  1351. else:
  1352. win = wx.TextCtrl(parent = which_panel, value = p.get('default',''),
  1353. size = globalvar.DIALOG_TEXTCTRL_SIZE)
  1354. win.Bind(wx.EVT_TEXT, self.OnSetValue)
  1355. elif p.get('prompt', '') == 'dbcolumn':
  1356. win = gselect.ColumnSelect(parent = which_panel,
  1357. value = value,
  1358. param = p)
  1359. win.Bind(wx.EVT_COMBOBOX, self.OnSetValue)
  1360. win.Bind(wx.EVT_TEXT, self.OnSetValue)
  1361. elif p.get('prompt', '') == 'location':
  1362. win = gselect.LocationSelect(parent = which_panel,
  1363. value = value)
  1364. win.Bind(wx.EVT_COMBOBOX, self.OnUpdateSelection)
  1365. win.Bind(wx.EVT_COMBOBOX, self.OnSetValue)
  1366. elif p.get('prompt', '') == 'mapset':
  1367. win = gselect.MapsetSelect(parent = which_panel,
  1368. value = value)
  1369. win.Bind(wx.EVT_COMBOBOX, self.OnUpdateSelection)
  1370. win.Bind(wx.EVT_COMBOBOX, self.OnSetValue)
  1371. elif p.get('prompt', '') == 'dbase':
  1372. win = gselect.DbaseSelect(parent = which_panel,
  1373. changeCallback = self.OnSetValue)
  1374. win.Bind(wx.EVT_TEXT, self.OnUpdateSelection)
  1375. p['wxId'] = [ win.GetChildren()[1].GetId() ]
  1376. if not p.has_key('wxId'):
  1377. try:
  1378. p['wxId'] = [ win.GetId(), ]
  1379. except AttributeError:
  1380. pass
  1381. which_sizer.Add(item = win, proportion = 0,
  1382. flag = wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT, border = 5)
  1383. # color entry
  1384. elif p.get('prompt', '') in ('color',
  1385. 'color_none'):
  1386. default_color = (200,200,200)
  1387. label_color = _("Select Color")
  1388. if p.get('default','') != '':
  1389. default_color, label_color = color_resolve(p['default'])
  1390. if p.get('value','') != '': # parameter previously set
  1391. default_color, label_color = color_resolve(p['value'])
  1392. if p.get('prompt', '') == 'color_none':
  1393. this_sizer = wx.BoxSizer(orient = wx.HORIZONTAL)
  1394. else:
  1395. this_sizer = which_sizer
  1396. btn_colour = csel.ColourSelect(parent = which_panel, id = wx.ID_ANY,
  1397. label = label_color, colour = default_color,
  1398. pos = wx.DefaultPosition, size = (150,-1))
  1399. this_sizer.Add(item = btn_colour, proportion = 0,
  1400. flag = wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT, border = 5)
  1401. # For color selectors, this is a two-member array, holding the IDs of
  1402. # the selector proper and either a "transparent" button or None
  1403. p['wxId'] = [btn_colour.GetId(),]
  1404. btn_colour.Bind(csel.EVT_COLOURSELECT, self.OnColorChange)
  1405. if p.get('prompt', '') == 'color_none':
  1406. none_check = wx.CheckBox(which_panel, wx.ID_ANY, _("Transparent"))
  1407. if p.get('value','') != '' and p.get('value',[''])[0] == "none":
  1408. none_check.SetValue(True)
  1409. else:
  1410. none_check.SetValue(False)
  1411. this_sizer.Add(item = none_check, proportion = 0,
  1412. flag = wx.ADJUST_MINSIZE | wx.LEFT | wx.RIGHT | wx.TOP, border = 5)
  1413. which_sizer.Add(this_sizer)
  1414. none_check.Bind(wx.EVT_CHECKBOX, self.OnColorChange)
  1415. p['wxId'].append(none_check.GetId())
  1416. else:
  1417. p['wxId'].append(None)
  1418. # file selector
  1419. elif p.get('prompt','') != 'color' and p.get('element', '') == 'file':
  1420. fbb = filebrowse.FileBrowseButton(parent = which_panel, id = wx.ID_ANY, fileMask = '*',
  1421. size = globalvar.DIALOG_GSELECT_SIZE, labelText = '',
  1422. dialogTitle = _('Choose %s') % \
  1423. p.get('description',_('File')),
  1424. buttonText = _('Browse'),
  1425. startDirectory = os.getcwd(), fileMode = 0,
  1426. changeCallback = self.OnSetValue)
  1427. value = self._GetValue(p)
  1428. if value:
  1429. fbb.SetValue(value) # parameter previously set
  1430. which_sizer.Add(item = fbb, proportion = 0,
  1431. flag = wx.EXPAND | wx.RIGHT, border = 5)
  1432. # A file browse button is a combobox with two children:
  1433. # a textctl and a button;
  1434. # we have to target the button here
  1435. p['wxId'] = [ fbb.GetChildren()[1].GetId() ]
  1436. if p.get('age', 'new') == 'old' and \
  1437. UserSettings.Get(group = 'cmd', key = 'interactiveInput', subkey = 'enabled'):
  1438. # widget for interactive input
  1439. ifbb = wx.TextCtrl(parent = which_panel, id = wx.ID_ANY,
  1440. style = wx.TE_MULTILINE,
  1441. size = (-1, 75))
  1442. if p.get('value', '') and os.path.isfile(p['value']):
  1443. f = open(p['value'])
  1444. ifbb.SetValue(''.join(f.readlines()))
  1445. f.close()
  1446. ifbb.Bind(wx.EVT_TEXT, self.OnFileText)
  1447. which_sizer.Add(item = wx.StaticText(parent = which_panel, id = wx.ID_ANY,
  1448. label = _('or enter values interactively')),
  1449. proportion = 0,
  1450. flag = wx.EXPAND | wx.RIGHT | wx.LEFT | wx.BOTTOM, border = 5)
  1451. which_sizer.Add(item = ifbb, proportion = 1,
  1452. flag = wx.EXPAND | wx.RIGHT | wx.LEFT, border = 5)
  1453. p['wxId'].append(ifbb.GetId())
  1454. if self.parent.GetName() == 'MainFrame' and self.parent.modeler:
  1455. parChk = wx.CheckBox(parent = which_panel, id = wx.ID_ANY,
  1456. label = _("Parameterized in model"))
  1457. parChk.SetName('ModelParam')
  1458. parChk.SetValue(p.get('parameterized', False))
  1459. if p.has_key('wxId'):
  1460. p['wxId'].append(parChk.GetId())
  1461. else:
  1462. p['wxId'] = [ parChk.GetId() ]
  1463. parChk.Bind(wx.EVT_CHECKBOX, self.OnSetValue)
  1464. which_sizer.Add(item = parChk, proportion = 0,
  1465. flag = wx.LEFT, border = 20)
  1466. if title_txt is not None:
  1467. # create tooltip if given
  1468. if len(p['values_desc']) > 0:
  1469. if tooltip:
  1470. tooltip += 2 * os.linesep
  1471. else:
  1472. tooltip = ''
  1473. if len(p['values']) == len(p['values_desc']):
  1474. for i in range(len(p['values'])):
  1475. tooltip += p['values'][i] + ': ' + p['values_desc'][i] + os.linesep
  1476. tooltip.strip(os.linesep)
  1477. if tooltip:
  1478. title_txt.SetToolTipString(tooltip)
  1479. if p == first_param:
  1480. if p.has_key('wxId') and len(p['wxId']) > 0:
  1481. self.FindWindowById(p['wxId'][0]).SetFocus()
  1482. #
  1483. # set widget relations for OnUpdateSelection
  1484. #
  1485. pMap = None
  1486. pLayer = []
  1487. pDriver = None
  1488. pDatabase = None
  1489. pTable = None
  1490. pColumn = []
  1491. pGroup = None
  1492. pSubGroup = None
  1493. pDbase = None
  1494. pLocation = None
  1495. pMapset = None
  1496. for p in self.task.params:
  1497. if p.get('gisprompt', False) == False:
  1498. continue
  1499. guidep = p.get('guidependency', '')
  1500. if guidep:
  1501. # fixed options dependency defined
  1502. options = guidep.split(',')
  1503. for opt in options:
  1504. pOpt = self.task.get_param(opt, element = 'name', raiseError = False)
  1505. if id:
  1506. if not p.has_key('wxId-bind'):
  1507. p['wxId-bind'] = list()
  1508. p['wxId-bind'] += pOpt['wxId']
  1509. continue
  1510. prompt = p.get('element', '')
  1511. if prompt in ('cell', 'vector'):
  1512. name = p.get('name', '')
  1513. if name in ('map', 'input'):
  1514. pMap = p
  1515. elif prompt == 'layer':
  1516. pLayer.append(p)
  1517. elif prompt == 'dbcolumn':
  1518. pColumn.append(p)
  1519. elif prompt == 'dbdriver':
  1520. pDriver = p
  1521. elif prompt == 'dbname':
  1522. pDatabase = p
  1523. elif prompt == 'dbtable':
  1524. pTable = p
  1525. elif prompt == 'group':
  1526. pGroup = p
  1527. elif prompt == 'subgroup':
  1528. pSubGroup = p
  1529. elif prompt == 'dbase':
  1530. pDbase = p
  1531. elif prompt == 'location':
  1532. pLocation = p
  1533. elif prompt == 'mapset':
  1534. pMapset = p
  1535. # collect ids
  1536. pColumnIds = []
  1537. for p in pColumn:
  1538. pColumnIds += p['wxId']
  1539. pLayerIds = []
  1540. for p in pLayer:
  1541. pLayerIds += p['wxId']
  1542. # set wxId-bindings
  1543. if pMap:
  1544. pMap['wxId-bind'] = copy.copy(pColumnIds)
  1545. if pLayer:
  1546. pMap['wxId-bind'] += pLayerIds
  1547. if pLayer:
  1548. for p in pLayer:
  1549. p['wxId-bind'] = copy.copy(pColumnIds)
  1550. if pDriver and pTable:
  1551. pDriver['wxId-bind'] = pTable['wxId']
  1552. if pDatabase and pTable:
  1553. pDatabase['wxId-bind'] = pTable['wxId']
  1554. if pTable and pColumnIds:
  1555. pTable['wxId-bind'] = pColumnIds
  1556. if pGroup and pSubGroup:
  1557. pGroup['wxId-bind'] = pSubGroup['wxId']
  1558. if pDbase and pLocation:
  1559. pDbase['wxId-bind'] = pLocation['wxId']
  1560. if pLocation and pMapset:
  1561. pLocation['wxId-bind'] = pMapset['wxId']
  1562. if pLocation and pMapset and pMap:
  1563. pLocation['wxId-bind'] += pMap['wxId']
  1564. pMapset['wxId-bind'] = pMap['wxId']
  1565. #
  1566. # determine panel size
  1567. #
  1568. maxsizes = (0, 0)
  1569. for section in sections:
  1570. tab[section].SetSizer(tabsizer[section])
  1571. tabsizer[section].Fit(tab[section])
  1572. tab[section].Layout()
  1573. minsecsizes = tabsizer[section].GetSize()
  1574. maxsizes = map(lambda x: max(maxsizes[x], minsecsizes[x]), (0, 1))
  1575. # TODO: be less arbitrary with these 600
  1576. self.panelMinHeight = 100
  1577. self.constrained_size = (min(600, maxsizes[0]) + 25, min(400, maxsizes[1]) + 25)
  1578. for section in sections:
  1579. tab[section].SetMinSize((self.constrained_size[0], self.panelMinHeight))
  1580. if self.manual_tab.IsLoaded():
  1581. self.manual_tab.SetMinSize((self.constrained_size[0], self.panelMinHeight))
  1582. self.SetSizer(panelsizer)
  1583. panelsizer.Fit(self.notebook)
  1584. self.Bind(EVT_DIALOG_UPDATE, self.OnUpdateDialog)
  1585. def _GetValue(self, p):
  1586. """!Get value or default value of given parameter
  1587. @param p parameter directory
  1588. """
  1589. if p.get('value', '') != '':
  1590. return p['value']
  1591. return p.get('default', '')
  1592. def OnFileText(self, event):
  1593. """File input interactively entered"""
  1594. text = event.GetString()
  1595. p = self.task.get_param(value = event.GetId(), element = 'wxId', raiseError = False)
  1596. if not p:
  1597. return # should not happen
  1598. win = self.FindWindowById(p['wxId'][0])
  1599. if text:
  1600. filename = win.GetValue()
  1601. if not filename:
  1602. # outFile = tempfile.NamedTemporaryFile(mode = 'w+b')
  1603. filename = grass.tempfile()
  1604. win.SetValue(filename)
  1605. f = open(filename, "w")
  1606. try:
  1607. f.write(text)
  1608. finally:
  1609. f.close()
  1610. else:
  1611. win.SetValue('')
  1612. def OnVectorFormat(self, event):
  1613. """!Change vector format (native / ogr)"""
  1614. sel = event.GetSelection()
  1615. idEvent = event.GetId()
  1616. p = self.task.get_param(value = idEvent, element = 'wxId', raiseError = False)
  1617. if not p:
  1618. return # should not happen
  1619. # detect windows
  1620. winNative = None
  1621. winOgr = None
  1622. for id in p['wxId']:
  1623. if id == idEvent:
  1624. continue
  1625. name = self.FindWindowById(id).GetName()
  1626. if name == 'Select':
  1627. winNative = self.FindWindowById(id + 1) # fix the mystery (also in nviz_tools.py)
  1628. elif name == 'OgrSelect':
  1629. winOgr = self.FindWindowById(id)
  1630. # enable / disable widgets & update values
  1631. rbox = self.FindWindowByName('VectorFormat')
  1632. self.hsizer.Remove(rbox)
  1633. if sel == 0: # -> native
  1634. winOgr.Hide()
  1635. self.hsizer.Remove(winOgr)
  1636. self.hsizer.Add(item = winNative,
  1637. flag = wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT | wx.RIGHT | wx.TOP | wx.ALIGN_TOP,
  1638. border = 5)
  1639. winNative.Show()
  1640. p['value'] = winNative.GetValue()
  1641. elif sel == 1: # -> OGR
  1642. sizer = wx.BoxSizer(wx.VERTICAL)
  1643. winNative.Hide()
  1644. self.hsizer.Remove(winNative)
  1645. sizer.Add(item = winOgr)
  1646. winOgr.Show()
  1647. p['value'] = winOgr.GetDsn()
  1648. self.hsizer.Add(item = sizer,
  1649. flag = wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT | wx.RIGHT | wx.TOP | wx.ALIGN_TOP,
  1650. border = 5)
  1651. self.hsizer.Add(item = rbox,
  1652. flag = wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT |
  1653. wx.RIGHT | wx.ALIGN_TOP,
  1654. border = 5)
  1655. self.hsizer.Layout()
  1656. self.Layout()
  1657. self.OnUpdateValues()
  1658. self.OnUpdateSelection(event)
  1659. def OnUpdateDialog(self, event):
  1660. for fn, kwargs in event.data.iteritems():
  1661. fn(**kwargs)
  1662. self.parent.updateValuesHook()
  1663. def OnVerbosity(self, event):
  1664. """!Verbosity level changed"""
  1665. verbose = self.FindWindowById(self.task.get_flag('verbose')['wxId'][0])
  1666. quiet = self.FindWindowById(self.task.get_flag('quiet')['wxId'][0])
  1667. if event.IsChecked():
  1668. if event.GetId() == verbose.GetId():
  1669. if quiet.IsChecked():
  1670. quiet.SetValue(False)
  1671. self.task.get_flag('quiet')['value'] = False
  1672. else:
  1673. if verbose.IsChecked():
  1674. verbose.SetValue(False)
  1675. self.task.get_flag('verbose')['value'] = False
  1676. event.Skip()
  1677. def OnPageChange(self, event):
  1678. if not event:
  1679. sel = self.notebook.GetSelection()
  1680. else:
  1681. sel = event.GetSelection()
  1682. if hasattr(self, "manual_tab_id") and \
  1683. sel == self.manual_tab_id:
  1684. # calling LoadPage() is strangely time-consuming (only first call)
  1685. # FIXME: move to helpPage.__init__()
  1686. if not self.manual_tab.IsLoaded():
  1687. wx.Yield()
  1688. self.manual_tab.LoadPage()
  1689. self.Layout()
  1690. def OnColorChange(self, event):
  1691. myId = event.GetId()
  1692. for p in self.task.params:
  1693. if 'wxId' in p and myId in p['wxId']:
  1694. has_button = p['wxId'][1] is not None
  1695. if has_button and wx.FindWindowById(p['wxId'][1]).GetValue() == True:
  1696. p[ 'value' ] = 'none'
  1697. else:
  1698. colorchooser = wx.FindWindowById(p['wxId'][0])
  1699. new_color = colorchooser.GetValue()[:]
  1700. # This is weird: new_color is a 4-tuple and new_color[:] is a 3-tuple
  1701. # under wx2.8.1
  1702. new_label = rgb2str.get(new_color, ':'.join(map(str,new_color)))
  1703. colorchooser.SetLabel(new_label)
  1704. colorchooser.SetColour(new_color)
  1705. colorchooser.Refresh()
  1706. p[ 'value' ] = colorchooser.GetLabel()
  1707. self.OnUpdateValues()
  1708. def OnUpdateValues(self, event = None):
  1709. """!If we were part of a richer interface, report back the
  1710. current command being built.
  1711. This method should be set by the parent of this panel if
  1712. needed. It's a hook, actually. Beware of what is 'self' in
  1713. the method def, though. It will be called with no arguments.
  1714. """
  1715. pass
  1716. def OnCheckBoxMulti(self, event):
  1717. """!Fill the values as a ','-separated string according to
  1718. current status of the checkboxes.
  1719. """
  1720. me = event.GetId()
  1721. theParam = None
  1722. for p in self.task.params:
  1723. if 'wxId' in p and me in p['wxId']:
  1724. theParam = p
  1725. myIndex = p['wxId'].index(me)
  1726. # Unpack current value list
  1727. currentValues = {}
  1728. for isThere in theParam.get('value', '').split(','):
  1729. currentValues[isThere] = 1
  1730. theValue = theParam['values'][myIndex]
  1731. if event.Checked():
  1732. currentValues[ theValue ] = 1
  1733. else:
  1734. del currentValues[ theValue ]
  1735. # Keep the original order, so that some defaults may be recovered
  1736. currentValueList = []
  1737. for v in theParam['values']:
  1738. if currentValues.has_key(v):
  1739. currentValueList.append(v)
  1740. # Pack it back
  1741. theParam['value'] = ','.join(currentValueList)
  1742. self.OnUpdateValues()
  1743. def OnSetValue(self, event):
  1744. """!Retrieve the widget value and set the task value field
  1745. accordingly.
  1746. Use for widgets that have a proper GetValue() method, i.e. not
  1747. for selectors.
  1748. """
  1749. myId = event.GetId()
  1750. me = wx.FindWindowById(myId)
  1751. name = me.GetName()
  1752. found = False
  1753. for porf in self.task.params + self.task.flags:
  1754. if not porf.has_key('wxId'):
  1755. continue
  1756. if myId in porf['wxId']:
  1757. found = True
  1758. break
  1759. if not found:
  1760. return
  1761. if name in ('LayerSelect', 'DriverSelect', 'TableSelect',
  1762. 'LocationSelect', 'MapsetSelect', 'ProjSelect'):
  1763. porf['value'] = me.GetStringSelection()
  1764. elif name == 'GdalSelect':
  1765. porf['value'] = event.dsn
  1766. elif name == 'ModelParam':
  1767. porf['parameterized'] = me.IsChecked()
  1768. else:
  1769. porf['value'] = me.GetValue()
  1770. self.OnUpdateValues(event)
  1771. event.Skip()
  1772. def OnUpdateSelection(self, event):
  1773. """!Update dialog (layers, tables, columns, etc.)
  1774. """
  1775. if not hasattr(self.parent, "updateThread"):
  1776. if event:
  1777. event.Skip()
  1778. return
  1779. if event:
  1780. self.parent.updateThread.Update(UpdateDialog,
  1781. self,
  1782. event,
  1783. event.GetId(),
  1784. self.task)
  1785. else:
  1786. self.parent.updateThread.Update(UpdateDialog,
  1787. self,
  1788. None,
  1789. None,
  1790. self.task)
  1791. def createCmd(self, ignoreErrors = False):
  1792. """!Produce a command line string (list) or feeding into GRASS.
  1793. If ignoreErrors == True then it will return whatever has been
  1794. built so far, even though it would not be a correct command
  1795. for GRASS.
  1796. """
  1797. try:
  1798. cmd = self.task.getCmd(ignoreErrors = ignoreErrors)
  1799. except ValueError, err:
  1800. dlg = wx.MessageDialog(parent = self,
  1801. message = unicode(err),
  1802. caption = _("Error in %s") % self.task.name,
  1803. style = wx.OK | wx.ICON_ERROR | wx.CENTRE)
  1804. dlg.ShowModal()
  1805. dlg.Destroy()
  1806. cmd = None
  1807. return cmd
  1808. def OnSize(self, event):
  1809. width = event.GetSize()[0]
  1810. fontsize = self.GetFont().GetPointSize()
  1811. text_width = max(width / (fontsize - 3), 70)
  1812. for id in self.label_id:
  1813. win = self.FindWindowById(id)
  1814. label = win.GetLabel()
  1815. label_new = '\n'.join(textwrap.wrap(label, text_width))
  1816. win.SetLabel(label_new)
  1817. event.Skip()
  1818. def getInterfaceDescription(cmd):
  1819. """!Returns the XML description for the GRASS cmd.
  1820. The DTD must be located in $GISBASE/etc/grass-interface.dtd,
  1821. otherwise the parser will not succeed.
  1822. @param cmd command (name of GRASS module)
  1823. """
  1824. try:
  1825. cmdout, cmderr = grass.Popen([cmd, '--interface-description'], stdout = grass.PIPE,
  1826. stderr = grass.PIPE).communicate()
  1827. except OSError, e:
  1828. raise gcmd.GException, _("Unable to fetch interface description for command '%s'. "
  1829. "Details: %s") % (cmd, repr(e))
  1830. if cmderr and cmderr[:7] != 'WARNING':
  1831. raise gcmd.GException, _("Unable to fetch interface description for command '%s'. "
  1832. "Details: %s") % (cmd, cmderr)
  1833. return cmdout.replace('grass-interface.dtd', os.path.join(globalvar.ETCDIR, 'grass-interface.dtd'))
  1834. class GrassGUIApp(wx.App):
  1835. """!Stand-alone GRASS command GUI
  1836. """
  1837. def __init__(self, grass_task):
  1838. self.grass_task = grass_task
  1839. wx.App.__init__(self, False)
  1840. def OnInit(self):
  1841. msg = self.grass_task.get_error_msg()
  1842. if msg:
  1843. gcmd.GError(msg + '\n\nTry to set up GRASS_ADDON_PATH variable.')
  1844. return True
  1845. self.mf = mainFrame(parent = None, ID = wx.ID_ANY, task_description = self.grass_task)
  1846. self.mf.CentreOnScreen()
  1847. self.mf.Show(True)
  1848. self.SetTopWindow(self.mf)
  1849. return True
  1850. class GUI:
  1851. """
  1852. Parses GRASS commands when module is imported and used
  1853. from Layer Manager.
  1854. """
  1855. def __init__(self, parent = -1):
  1856. self.parent = parent
  1857. self.grass_task = None
  1858. self.cmd = list()
  1859. def GetCmd(self):
  1860. """Get validated command"""
  1861. return self.cmd
  1862. def ParseInterface(self, cmd, parser = processTask):
  1863. """!Parse interface
  1864. @param cmd command to be parsed (given as list)
  1865. """
  1866. # enc = locale.getdefaultlocale()[1]
  1867. # if enc and enc.lower() not in ("utf8", "utf-8"):
  1868. # tree = etree.fromstring(getInterfaceDescription(cmd[0]).decode(enc).encode("utf-8"))
  1869. # else:
  1870. tree = etree.fromstring(getInterfaceDescription(cmd[0]))
  1871. return processTask(tree).GetTask()
  1872. def ParseCommand(self, cmd, gmpath = None, completed = None, parentframe = None,
  1873. show = True, modal = False, centreOnParent = False, checkError = False):
  1874. """!Parse command
  1875. Note: cmd is given as list
  1876. If command is given with options, return validated cmd list:
  1877. - add key name for first parameter if not given
  1878. - change mapname to mapname@mapset
  1879. """
  1880. start = time.time()
  1881. dcmd_params = {}
  1882. if completed == None:
  1883. get_dcmd = None
  1884. layer = None
  1885. dcmd_params = None
  1886. else:
  1887. get_dcmd = completed[0]
  1888. layer = completed[1]
  1889. if completed[2]:
  1890. dcmd_params.update(completed[2])
  1891. self.parent = parentframe
  1892. # parse the interface decription
  1893. self.grass_task = self.ParseInterface(cmd)
  1894. # if layer parameters previously set, re-insert them into dialog
  1895. if completed is not None:
  1896. if 'params' in dcmd_params:
  1897. self.grass_task.params = dcmd_params['params']
  1898. if 'flags' in dcmd_params:
  1899. self.grass_task.flags = dcmd_params['flags']
  1900. err = list()
  1901. # update parameters if needed && validate command
  1902. if len(cmd) > 1:
  1903. i = 0
  1904. cmd_validated = [cmd[0]]
  1905. for option in cmd[1:]:
  1906. if option[0] == '-': # flag
  1907. if option[1] == '-':
  1908. self.grass_task.set_flag(option[2:], True)
  1909. else:
  1910. self.grass_task.set_flag(option[1], True)
  1911. cmd_validated.append(option)
  1912. else: # parameter
  1913. try:
  1914. key, value = option.split('=', 1)
  1915. except:
  1916. if i == 0: # add key name of first parameter if not given
  1917. key = self.grass_task.firstParam
  1918. value = option
  1919. else:
  1920. raise gcmd.GException, _("Unable to parse command '%s'") % ' '.join(cmd)
  1921. element = self.grass_task.get_param(key, raiseError = False)
  1922. if not element:
  1923. err.append(_("%(cmd)s: parameter '%(key)s' not available") % \
  1924. { 'cmd' : cmd[0],
  1925. 'key' : key })
  1926. continue
  1927. element = element['element']
  1928. if element in ['cell', 'vector']:
  1929. # mapname -> mapname@mapset
  1930. try:
  1931. name, mapset = value.split('@')
  1932. except ValueError:
  1933. mapset = grass.find_file(value, element)['mapset']
  1934. curr_mapset = grass.gisenv()['MAPSET']
  1935. if mapset and mapset != curr_mapset:
  1936. value = value + '@' + mapset
  1937. self.grass_task.set_param(key, value)
  1938. cmd_validated.append(key + '=' + value)
  1939. i += 1
  1940. # update original command list
  1941. cmd = cmd_validated
  1942. if show is not None:
  1943. self.mf = mainFrame(parent = self.parent, ID = wx.ID_ANY,
  1944. task_description = self.grass_task,
  1945. get_dcmd = get_dcmd, layer = layer)
  1946. else:
  1947. self.mf = None
  1948. if get_dcmd is not None:
  1949. # update only propwin reference
  1950. get_dcmd(dcmd = None, layer = layer, params = None,
  1951. propwin = self.mf)
  1952. if show is not None:
  1953. self.mf.notebookpanel.OnUpdateSelection(None)
  1954. if show is True:
  1955. if self.parent and centreOnParent:
  1956. self.mf.CentreOnParent()
  1957. else:
  1958. self.mf.CenterOnScreen()
  1959. self.mf.Show(show)
  1960. self.mf.MakeModal(modal)
  1961. else:
  1962. self.mf.OnApply(None)
  1963. self.cmd = cmd
  1964. if checkError:
  1965. return self.grass_task, err
  1966. else:
  1967. return self.grass_task
  1968. def GetCommandInputMapParamKey(self, cmd):
  1969. """!Get parameter key for input raster/vector map
  1970. @param cmd module name
  1971. @return parameter key
  1972. @return None on failure
  1973. """
  1974. # parse the interface decription
  1975. if not self.grass_task:
  1976. tree = etree.fromstring(getInterfaceDescription(cmd))
  1977. self.grass_task = processTask(tree).GetTask()
  1978. for p in self.grass_task.params:
  1979. if p.get('name', '') in ('input', 'map'):
  1980. age = p.get('age', '')
  1981. prompt = p.get('prompt', '')
  1982. element = p.get('element', '')
  1983. if age == 'old' and \
  1984. element in ('cell', 'grid3', 'vector') and \
  1985. prompt in ('raster', '3d-raster', 'vector'):
  1986. return p.get('name', None)
  1987. return None
  1988. class FloatValidator(wx.PyValidator):
  1989. """!Validator for floating-point input"""
  1990. def __init__(self):
  1991. wx.PyValidator.__init__(self)
  1992. self.Bind(wx.EVT_TEXT, self.OnText)
  1993. def Clone(self):
  1994. """!Clone validator"""
  1995. return FloatValidator()
  1996. def Validate(self):
  1997. """Validate input"""
  1998. textCtrl = self.GetWindow()
  1999. text = textCtrl.GetValue()
  2000. if text:
  2001. try:
  2002. float(text)
  2003. except ValueError:
  2004. textCtrl.SetBackgroundColour("grey")
  2005. textCtrl.SetFocus()
  2006. textCtrl.Refresh()
  2007. return False
  2008. sysColor = wx.SystemSettings_GetColour(wx.SYS_COLOUR_WINDOW)
  2009. textCtrl.SetBackgroundColour(sysColor)
  2010. textCtrl.Refresh()
  2011. return True
  2012. def OnText(self, event):
  2013. """!Do validation"""
  2014. self.Validate()
  2015. event.Skip()
  2016. def TransferToWindow(self):
  2017. return True # Prevent wxDialog from complaining.
  2018. def TransferFromWindow(self):
  2019. return True # Prevent wxDialog from complaining.
  2020. if __name__ == "__main__":
  2021. if len(sys.argv) == 1:
  2022. sys.exit(_("usage: %s <grass command>") % sys.argv[0])
  2023. if sys.argv[1] != 'test':
  2024. q = wx.LogNull()
  2025. cmd = shlex.split(sys.argv[1])
  2026. task = grassTask(cmd[0])
  2027. task.set_options(cmd[1:])
  2028. app = GrassGUIApp(task)
  2029. app.MainLoop()
  2030. else: #Test
  2031. # Test grassTask from within a GRASS session
  2032. if os.getenv("GISBASE") is not None:
  2033. task = grassTask("d.vect")
  2034. task.get_param('map')['value'] = "map_name"
  2035. task.get_flag('v')['value'] = True
  2036. task.get_param('layer')['value'] = 1
  2037. task.get_param('bcolor')['value'] = "red"
  2038. assert ' '.join(task.getCmd()) == "d.vect -v map = map_name layer = 1 bcolor = red"
  2039. # Test interface building with handmade grassTask,
  2040. # possibly outside of a GRASS session.
  2041. task = grassTask()
  2042. task.name = "TestTask"
  2043. task.description = "This is an artificial grassTask() object intended for testing purposes."
  2044. task.keywords = ["grass","test","task"]
  2045. task.params = [
  2046. {
  2047. "name" : "text",
  2048. "description" : "Descriptions go into tooltips if labels are present, like this one",
  2049. "label" : "Enter some text",
  2050. },{
  2051. "name" : "hidden_text",
  2052. "description" : "This text should not appear in the form",
  2053. "hidden" : "yes"
  2054. },{
  2055. "name" : "text_default",
  2056. "description" : "Enter text to override the default",
  2057. "default" : "default text"
  2058. },{
  2059. "name" : "text_prefilled",
  2060. "description" : "You should see a friendly welcome message here",
  2061. "value" : "hello, world"
  2062. },{
  2063. "name" : "plain_color",
  2064. "description" : "This is a plain color, and it is a compulsory parameter",
  2065. "required" : False,
  2066. "gisprompt" : True,
  2067. "prompt" : "color"
  2068. },{
  2069. "name" : "transparent_color",
  2070. "description" : "This color becomes transparent when set to none",
  2071. "guisection" : "tab",
  2072. "gisprompt" : True,
  2073. "prompt" : "color"
  2074. },{
  2075. "name" : "multi",
  2076. "description" : "A multiple selection",
  2077. 'default': u'red,green,blue',
  2078. 'gisprompt': False,
  2079. 'guisection': 'tab',
  2080. 'multiple': u'yes',
  2081. 'type': u'string',
  2082. 'value': '',
  2083. 'values': ['red', 'green', u'yellow', u'blue', u'purple', u'other']
  2084. },{
  2085. "name" : "single",
  2086. "description" : "A single multiple-choice selection",
  2087. 'values': ['red', 'green', u'yellow', u'blue', u'purple', u'other'],
  2088. "guisection" : "tab"
  2089. },{
  2090. "name" : "large_multi",
  2091. "description" : "A large multiple selection",
  2092. "gisprompt" : False,
  2093. "multiple" : "yes",
  2094. # values must be an array of strings
  2095. "values" : str2rgb.keys() + map(str, str2rgb.values())
  2096. },{
  2097. "name" : "a_file",
  2098. "description" : "A file selector",
  2099. "gisprompt" : True,
  2100. "element" : "file"
  2101. }
  2102. ]
  2103. task.flags = [
  2104. {
  2105. "name" : "a",
  2106. "description" : "Some flag, will appear in Main since it is required",
  2107. "required" : True
  2108. },{
  2109. "name" : "b",
  2110. "description" : "pre-filled flag, will appear in options since it is not required",
  2111. "value" : True
  2112. },{
  2113. "name" : "hidden_flag",
  2114. "description" : "hidden flag, should not be changeable",
  2115. "hidden" : "yes",
  2116. "value" : True
  2117. }
  2118. ]
  2119. q = wx.LogNull()
  2120. GrassGUIApp(task).MainLoop()