menuform.py 87 KB

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