menuform.py 100 KB

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