menuform.py 88 KB

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