menuform.py 100 KB

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