menuform.py 68 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727
  1. #! /usr/bin/python
  2. """Construct simple wx.Python GUI from a GRASS command interface description.
  3. Classes:
  4. * testSAXContentHandler
  5. * grassTask
  6. * processTask
  7. * helpPanel
  8. * mainFrame
  9. * cmdPanel
  10. * GrassGUIApp
  11. * GUI
  12. Copyright (C) 2000-2007 by the GRASS Development Team
  13. This program is free software under the GPL (>=v2)
  14. Read the file COPYING coming with GRASS for details.
  15. This program is just a coarse approach to
  16. automatically build a GUI from a xml-based
  17. 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 <this file.py> r.basins.fill
  22. Or you set an alias or wrap the call up in a nice
  23. shell script, GUI environment ... please contribute your idea.
  24. Updated to wxPython 2.8 syntax and contrib widgets.
  25. Methods added to make it callable by gui.
  26. Method added to automatically re-run with 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. - use DOM instead of SAX
  35. """
  36. import sys
  37. import re
  38. import string
  39. import textwrap
  40. import os
  41. from os import system
  42. import time
  43. start = time.time()
  44. ### i18N
  45. import gettext
  46. gettext.install('grasswxpy', os.path.join(os.getenv("GISBASE"), 'locale'), unicode=True)
  47. import globalvar
  48. globalvar.CheckForWx()
  49. import wx
  50. import wx.lib.flatnotebook as FN
  51. import wx.lib.colourselect as csel
  52. import wx.lib.filebrowsebutton as filebrowse
  53. from wx.lib.expando import ExpandoTextCtrl, EVT_ETC_LAYOUT_NEEDED
  54. import wx.html
  55. # Do the python 2.0 standard xml thing and map it on the old names
  56. import xml.sax
  57. import xml.sax.handler
  58. HandlerBase=xml.sax.handler.ContentHandler
  59. from xml.sax import make_parser
  60. import utils
  61. gisbase = os.getenv("GISBASE")
  62. if gisbase is None:
  63. print >>sys.stderr, "We don't seem to be properly installed, or we are being run outside GRASS. Expect glitches."
  64. gisbase = os.path.join(os.path.dirname( sys.argv[0] ), os.path.pardir)
  65. wxbase = gisbase
  66. else:
  67. wxbase = os.path.join(globalvar.ETCWXDIR)
  68. sys.path.append( wxbase)
  69. imagepath = os.path.join(wxbase, "images")
  70. sys.path.append(imagepath)
  71. import grassenv
  72. import gselect
  73. import gcmd
  74. import goutput
  75. import utils
  76. from preferences import globalSettings as UserSettings
  77. try:
  78. import subprocess
  79. except:
  80. from compat import subprocess
  81. utils.reexec_with_pythonw()
  82. # From lib/gis/col_str.c, except purple which is mentioned
  83. # there but not given RGB values
  84. str2rgb = {'aqua': (100, 128, 255),
  85. 'black': (0, 0, 0),
  86. 'blue': (0, 0, 255),
  87. 'brown': (180, 77, 25),
  88. 'cyan': (0, 255, 255),
  89. 'gray': (128, 128, 128),
  90. 'green': (0, 255, 0),
  91. 'grey': (128, 128, 128),
  92. 'indigo': (0, 128, 255),
  93. 'magenta': (255, 0, 255),
  94. 'orange': (255, 128, 0),
  95. 'purple': (128, 0, 128),
  96. 'red': (255, 0, 0),
  97. 'violet': (128, 0, 255),
  98. 'white': (255, 255, 255),
  99. 'yellow': (255, 255, 0)}
  100. rgb2str = {}
  101. for (s,r) in str2rgb.items():
  102. rgb2str[ r ] = s
  103. def color_resolve(color):
  104. if len(color)>0 and color[0] in "0123456789":
  105. rgb = tuple(map(int,color.split( ':' )))
  106. label = color
  107. else:
  108. # Convert color names to RGB
  109. try:
  110. rgb = str2rgb[ color ]
  111. label = color
  112. except KeyError:
  113. rgb = (200,200,200)
  114. label = _('Select Color')
  115. return (rgb, label)
  116. def normalize_whitespace(text):
  117. """Remove redundant whitespace from a string"""
  118. return string.join( string.split(text), ' ')
  119. def text_beautify( someString ):
  120. """
  121. Make really long texts shorter, clean up whitespace and
  122. remove trailing punctuation.
  123. """
  124. # TODO: remove magic number (calculate a correct value from
  125. # pixelSize of text and the magic number for maximum size)
  126. return escape_ampersand( string.strip(
  127. os.linesep.join( textwrap.wrap( normalize_whitespace(someString), 70 ) ),
  128. ".,;:" ) )
  129. def escape_ampersand(text):
  130. """Escapes ampersands with additional ampersand for GUI"""
  131. return string.replace(text, "&", "&&")
  132. class testSAXContentHandler(HandlerBase):
  133. # SAX compliant
  134. def characters(self, ch, start, length):
  135. pass
  136. def test_for_broken_SAX():
  137. ch=testSAXContentHandler()
  138. try:
  139. xml.sax.parseString("""<?xml version="1.0"?>
  140. <child1 name="paul">Text goes here</child1>
  141. """,ch)
  142. except TypeError:
  143. return 1
  144. return 0
  145. class grassTask:
  146. """
  147. This class holds the structures needed for both filling by the parser and
  148. use by the interface constructor.
  149. Use as either grassTask() for empty definition or grassTask( 'grass.command' )
  150. for parsed filling.
  151. """
  152. def __init__(self, grassModule = None):
  153. self.name = _('unknown')
  154. self.params = []
  155. self.description = ''
  156. self.label = ''
  157. self.flags = []
  158. self.keywords = []
  159. if grassModule is not None:
  160. xml.sax.parseString( getInterfaceDescription( grassModule ) , processTask( self ) )
  161. def get_param(self, aParam, raiseError=True):
  162. """Find and return a param by name."""
  163. for p in self.params:
  164. lparam = len(aParam)
  165. if p['name'] == aParam or \
  166. p['name'][:lparam] == aParam:
  167. return p
  168. if raiseError:
  169. raise ValueError, _("Parameter not found: %s") % aParam
  170. else:
  171. return None
  172. def set_param(self, aParam, aValue):
  173. """
  174. Set param value/values.
  175. """
  176. param = self.get_param(aParam)
  177. param['value'] = aValue
  178. def get_flag( self, aFlag ):
  179. """
  180. Find and return a flag by name.
  181. """
  182. for f in self.flags:
  183. if f['name'] == aFlag:
  184. return f
  185. raise ValueError, _("Flag not found: %s") % aFlag
  186. def set_flag(self, aFlag, aValue):
  187. """
  188. Enable / disable flag.
  189. """
  190. param = self.get_flag(aFlag)
  191. param['value'] = aValue
  192. def getCmd(self, ignoreErrors = False):
  193. """
  194. Produce an array of command name and arguments for feeding
  195. into some execve-like command processor.
  196. If ignoreErrors==True then it will return whatever has been
  197. built so far, even though it would not be a correct command
  198. for GRASS.
  199. """
  200. cmd = [self.name]
  201. errors = 0
  202. errStr = ""
  203. for flag in self.flags:
  204. if 'value' in flag and flag['value']:
  205. if len(flag['name']) > 1: # e.g. overwrite
  206. cmd += [ '--' + flag['name'] ]
  207. else:
  208. cmd += [ '-' + flag['name'] ]
  209. for p in self.params:
  210. if p.get('value','') == '' and p.get('required','no') != 'no':
  211. if p.get('default', '') != '':
  212. cmd += [ '%s=%s' % ( p['name'], p['default'] ) ]
  213. else:
  214. cmd += [ '%s=%s' % ( p['name'], _('<required>') ) ]
  215. errStr += _("Parameter %(name)s (%(desc)s) is missing.\n") % \
  216. {'name' : p['name'], 'desc' : p['description']}
  217. errors += 1
  218. elif p.get('value','') != '' and p['value'] != p.get('default','') :
  219. # Output only values that have been set, and different from defaults
  220. cmd += [ '%s=%s' % ( p['name'], p['value'] ) ]
  221. if errors and not ignoreErrors:
  222. raise ValueError, errStr
  223. return cmd
  224. class processTask(HandlerBase):
  225. """
  226. A SAX handler for the --interface-description output, as
  227. defined in grass-interface.dtd. Extend or modify this and the
  228. DTD if the XML output of GRASS' parser is extended or modified.
  229. """
  230. def __init__(self, task_description):
  231. self.inLabelContent = False
  232. self.inDescriptionContent = False
  233. self.inDefaultContent = False
  234. self.inValueContent = False
  235. self.inParameter = False
  236. self.inFlag = False
  237. self.inGispromptContent = False
  238. self.inGuisection = False
  239. self.inKeywordsContent = False
  240. self.inKeyDesc = False
  241. self.addKeyDesc = False
  242. self.inFirstParameter = True
  243. self.task = task_description
  244. def startElement(self, name, attrs):
  245. if name == 'task':
  246. self.task.name = attrs.get('name', None)
  247. if name == 'parameter':
  248. self.inParameter = True
  249. self.label = '' # tmp variable
  250. self.param_label = ''
  251. self.param_description = ''
  252. self.param_default = ''
  253. self.param_values = []
  254. self.param_values_description = []
  255. self.param_gisprompt = False
  256. self.param_age = ''
  257. self.param_element = ''
  258. self.param_prompt = ''
  259. self.param_guisection = ''
  260. self.param_key_desc = []
  261. # Look for the parameter name, type, requiredness
  262. self.param_name = attrs.get('name', None)
  263. self.param_type = attrs.get('type', None)
  264. self.param_required = attrs.get('required', None)
  265. self.param_multiple = attrs.get('multiple', None)
  266. if name == 'flag':
  267. self.inFlag = True
  268. self.label = '' # tmp variable
  269. self.flag_label = ''
  270. self.flag_description = ''
  271. self.flag_default = ''
  272. self.flag_guisection = ''
  273. self.flag_values = []
  274. # Look for the flag name
  275. self.flag_name = attrs.get('name', None)
  276. if name == 'label':
  277. self.inLabelContent = True
  278. self.label = ''
  279. if name == 'description':
  280. self.inDescriptionContent = True
  281. self.description = ''
  282. if name == 'default':
  283. self.inDefaultContent = True
  284. self.param_default = ''
  285. if name == 'value':
  286. self.inValueContent = True
  287. self.value_tmp = ''
  288. if name == 'gisprompt':
  289. self.param_gisprompt = True
  290. self.param_age = attrs.get('age', None)
  291. self.param_element = attrs.get('element', None)
  292. self.param_prompt = attrs.get('prompt', None)
  293. if name == 'guisection':
  294. self.inGuisection = True
  295. self.guisection = ''
  296. if name == 'keywords':
  297. self.inKeywordsContent = True
  298. self.keyword = ''
  299. if name == 'keydesc':
  300. self.inKeyDesc = True
  301. self.key_desc = ''
  302. if name == 'item':
  303. if self.inKeyDesc:
  304. self.addKeyDesc = True
  305. # works with python 2.0, but is not SAX compliant
  306. def characters(self, ch):
  307. self.my_characters(ch)
  308. def my_characters(self, ch):
  309. if self.inLabelContent:
  310. self.label = self.label + ch
  311. if self.inDescriptionContent:
  312. self.description = self.description + ch
  313. if self.inDefaultContent:
  314. self.param_default = self.param_default + ch
  315. if self.inValueContent and not self.inDescriptionContent:
  316. # Beware: value_tmp will get anything outside of a <description>
  317. # so in this snippet:
  318. # <values>
  319. # <value>
  320. # <name> a </name>
  321. # <description> a desc </description>
  322. # </value>
  323. # </values>
  324. # 'a desc' will not be recorded anwhere; this unburdens further
  325. # handling of value sets to distinguish between those that do define
  326. # descriptions and those that do not.
  327. #
  328. # TODO: a set of flags to treat this case of a description sub-element
  329. self.value_tmp = self.value_tmp + ch
  330. if self.inGuisection:
  331. self.guisection = self.guisection + ch
  332. if self.inKeywordsContent:
  333. self.keyword = self.keyword + ch
  334. if self.addKeyDesc:
  335. self.key_desc = self.key_desc + ch
  336. def endElement(self, name):
  337. # If it's not a parameter element, ignore it
  338. if name == 'parameter':
  339. self.inParameter = False;
  340. # description -> label substitution is delegated to the client;
  341. # we deal in the parser only with getting interface-description
  342. # verbatim
  343. self.task.params.append({
  344. "name" : self.param_name,
  345. "type" : self.param_type,
  346. "required" : self.param_required,
  347. "multiple" : self.param_multiple,
  348. "label" : self.param_label,
  349. "description" : self.param_description,
  350. 'gisprompt' : self.param_gisprompt,
  351. 'age' : self.param_age,
  352. 'element' :self.param_element,
  353. 'prompt' : self.param_prompt,
  354. "guisection" : self.param_guisection,
  355. "default" : self.param_default,
  356. "values" : self.param_values,
  357. "values_desc" : self.param_values_description,
  358. "value" : '',
  359. "key_desc": self.param_key_desc})
  360. if self.inFirstParameter:
  361. self.task.firstParam = self.param_name # store name of first parameter
  362. self.inFirstParameter = False;
  363. if name == 'flag':
  364. self.inFlag = False;
  365. self.task.flags.append({
  366. "name" : self.flag_name,
  367. "label" : self.flag_label,
  368. "description" : self.flag_description,
  369. "guisection" : self.flag_guisection } )
  370. if name == 'label':
  371. if self.inParameter:
  372. self.param_label = normalize_whitespace(self.label)
  373. elif self.inFlag:
  374. self.flag_label = normalize_whitespace(self.label)
  375. else:
  376. self.task.label = normalize_whitespace(self.label)
  377. if name == 'description':
  378. if self.inValueContent:
  379. self.param_values_description.append(normalize_whitespace(self.description))
  380. elif self.inParameter:
  381. self.param_description = normalize_whitespace(self.description)
  382. elif self.inFlag:
  383. self.flag_description = normalize_whitespace(self.description)
  384. else:
  385. self.task.description = normalize_whitespace(self.description)
  386. self.inDescriptionContent = False
  387. if name == 'default':
  388. self.param_default = normalize_whitespace(self.param_default)
  389. self.inDefaultContent = False
  390. if name == 'value':
  391. v = normalize_whitespace(self.value_tmp)
  392. self.param_values.append(normalize_whitespace(self.value_tmp))
  393. self.inValueContent = False
  394. if name == 'guisection':
  395. if self.inParameter:
  396. self.param_guisection = normalize_whitespace(self.guisection)
  397. elif self.inFlag:
  398. self.flag_guisection = normalize_whitespace(self.guisection)
  399. self.inGuisection = False
  400. if name == 'keywords':
  401. for keyword in self.keyword.split(','):
  402. self.task.keywords.append (normalize_whitespace(keyword))
  403. self.inKeywordsContent = False
  404. if name == 'keydesc':
  405. self.param_key_desc = self.param_key_desc.split()
  406. self.inKeyDesc = False
  407. if name == 'item':
  408. if self.inKeyDesc:
  409. self.param_key_desc = normalize_whitespace(self.key_desc)
  410. self.addKeyDesc = False
  411. class helpPanel(wx.html.HtmlWindow):
  412. """
  413. This panel holds the text from GRASS docs.
  414. GISBASE must be set in the environment to find the html docs dir.
  415. The SYNOPSIS section is skipped, since this Panel is supposed to
  416. be integrated into the cmdPanel and options are obvious there.
  417. """
  418. def __init__(self, grass_command = "index", text = None,
  419. skip_description=False, *args, **kwargs):
  420. """ If grass_command is given, the corresponding HTML help file will
  421. be presented, with all links pointing to absolute paths of
  422. local files.
  423. If 'skip_description' is True, the HTML corresponding to
  424. SYNOPSIS will be skipped, thus only presenting the help file
  425. from the DESCRIPTION section onwards.
  426. If 'text' is given, it must be the HTML text to be presented in the Panel.
  427. """
  428. wx.html.HtmlWindow.__init__(self, *args, **kwargs)
  429. self.fspath = gisbase + "/docs/html/"
  430. self.SetStandardFonts ( size = 10 )
  431. self.SetBorders(10)
  432. wx.InitAllImageHandlers()
  433. if text is None:
  434. if skip_description:
  435. self.fillContentsFromFile ( self.fspath + grass_command + ".html",
  436. skip_description=skip_description )
  437. self.Ok = True
  438. else:
  439. ### FIXME: calling LoadPage() is strangely time-consuming (only first call)
  440. # self.LoadPage(self.fspath + grass_command + ".html")
  441. self.Ok = False
  442. else:
  443. self.SetPage( text )
  444. self.Ok = True
  445. def fillContentsFromFile( self, htmlFile, skip_description=True ):
  446. aLink = re.compile( r'(<a href="?)(.+\.html?["\s]*>)', re.IGNORECASE )
  447. imgLink = re.compile( r'(<img src="?)(.+\.[png|gif])', re.IGNORECASE )
  448. try:
  449. # contents = [ '<head><base href="%s"></head>' % self.fspath ]
  450. contents = []
  451. skip = False
  452. for l in file( htmlFile, "rb" ).readlines():
  453. if "DESCRIPTION" in l:
  454. skip = False
  455. if not skip:
  456. # do skip the options description if requested
  457. if "SYNOPSIS" in l:
  458. skip = skip_description
  459. else:
  460. # FIXME: find only first item
  461. findALink = aLink.search( l )
  462. if findALink is not None:
  463. contents.append( aLink.sub(findALink.group(1)+
  464. self.fspath+findALink.group(2),l) )
  465. findImgLink = imgLink.search( l )
  466. if findImgLink is not None:
  467. contents.append( imgLink.sub(findImgLink.group(1)+
  468. self.fspath+findImgLink.group(2),l) )
  469. if findALink is None and findImgLink is None:
  470. contents.append( l )
  471. self.SetPage( "".join( contents ) )
  472. self.Ok = True
  473. except: # The Manual file was not found
  474. self.Ok = False
  475. class mainFrame(wx.Frame):
  476. """
  477. This is the Frame containing the dialog for options input.
  478. The dialog is organized in a notebook according to the guisections
  479. defined by each GRASS command.
  480. If run with a parent, it may Apply, Ok or Cancel; the latter two close the dialog.
  481. The former two trigger a callback.
  482. If run standalone, it will allow execution of the command.
  483. The command is checked and sent to the clipboard when clicking 'Copy'.
  484. """
  485. def __init__(self, parent, ID, task_description, get_dcmd=None, layer=None):
  486. self.get_dcmd = get_dcmd
  487. self.layer = layer
  488. self.task = task_description
  489. self.parent = parent # LayerTree | None
  490. # module name + keywords
  491. title = self.task.name
  492. try:
  493. title += " [" + ', '.join( self.task.keywords ) + "]"
  494. except ValueError:
  495. pass
  496. wx.Frame.__init__(self, parent=parent, id=ID, title=title,
  497. pos=wx.DefaultPosition, style=wx.DEFAULT_FRAME_STYLE | wx.TAB_TRAVERSAL)
  498. self.panel = wx.Panel(parent=self, id=wx.ID_ANY)
  499. # statusbar
  500. self.CreateStatusBar()
  501. # icon
  502. self.SetIcon(wx.Icon(os.path.join(globalvar.ETCICONDIR, 'grass_dialog.ico'), wx.BITMAP_TYPE_ICO))
  503. guisizer = wx.BoxSizer(wx.VERTICAL)
  504. # set apropriate output window
  505. if self.parent:
  506. self.standalone = False
  507. else:
  508. self.standalone = True
  509. # try:
  510. # self.goutput = self.parent.GetLogWindow()
  511. # except:
  512. # self.goutput = None
  513. # logo+description
  514. topsizer = wx.BoxSizer(wx.HORIZONTAL)
  515. # GRASS logo
  516. self.logo = wx.StaticBitmap(parent=self.panel,
  517. bitmap=wx.Bitmap(name=os.path.join(imagepath,
  518. 'grass_form.png'),
  519. type=wx.BITMAP_TYPE_PNG))
  520. topsizer.Add (item=self.logo, proportion=0, border=3,
  521. flag=wx.ALL | wx.ALIGN_CENTER_VERTICAL)
  522. guisizer.Add (item=topsizer, proportion=0, flag=wx.EXPAND)
  523. # notebooks
  524. self.notebookpanel = cmdPanel (parent=self.panel, task=self.task, standalone=self.standalone,
  525. mainFrame=self)
  526. ### add 'command output' tab also for dialog open from menu
  527. # if self.standalone:
  528. self.goutput = self.notebookpanel.goutput
  529. self.notebookpanel.OnUpdateValues = self.updateValuesHook
  530. guisizer.Add (item=self.notebookpanel, proportion=1, flag=wx.EXPAND)
  531. # status bar
  532. status_text = _("Enter parameters for ") + self.task.name
  533. if self.notebookpanel.hasMain:
  534. # We have to wait for the notebookpanel to be filled in order
  535. # to know if there actually is a Main tab
  536. status_text += _(" (those in bold typeface are required)")
  537. try:
  538. self.task.getCmd()
  539. self.updateValuesHook()
  540. except ValueError:
  541. self.SetStatusText( status_text )
  542. # buttons
  543. btnsizer = wx.BoxSizer(orient=wx.HORIZONTAL)
  544. # cancel
  545. self.btn_cancel = wx.Button(parent=self.panel, id=wx.ID_CANCEL)
  546. self.btn_cancel.SetToolTipString(_("Cancel the command settings and ignore changes"))
  547. btnsizer.Add(item=self.btn_cancel, proportion=0, flag=wx.ALL | wx.ALIGN_CENTER, border=10)
  548. self.btn_cancel.Bind(wx.EVT_BUTTON, self.OnCancel)
  549. # help
  550. self.btn_help = wx.Button(parent=self.panel, id=wx.ID_HELP)
  551. self.btn_help.SetToolTipString(_("Show manual page of the command"))
  552. self.btn_help.Bind(wx.EVT_BUTTON, self.OnHelp)
  553. if self.get_dcmd is not None: # A callback has been set up
  554. btn_apply = wx.Button(parent=self.panel, id=wx.ID_APPLY)
  555. btn_ok = wx.Button(parent=self.panel, id=wx.ID_OK)
  556. btn_ok.SetDefault()
  557. btnsizer.Add(item=btn_apply, proportion=0,
  558. flag=wx.ALL | wx.ALIGN_CENTER,
  559. border=10)
  560. btnsizer.Add(item=btn_ok, proportion=0,
  561. flag=wx.ALL | wx.ALIGN_CENTER,
  562. border=10)
  563. btn_apply.Bind(wx.EVT_BUTTON, self.OnApply)
  564. btn_ok.Bind(wx.EVT_BUTTON, self.OnOK)
  565. else: # We're standalone
  566. # run
  567. self.btn_run = wx.Button(parent=self.panel, id=wx.ID_OK, label= _("&Run"))
  568. self.btn_run.SetToolTipString(_("Run the command"))
  569. self.btn_run.SetDefault()
  570. # abort
  571. self.btn_abort = wx.Button(parent=self.panel, id=wx.ID_STOP)
  572. self.btn_abort.SetToolTipString(_("Abort the running command"))
  573. self.btn_abort.Enable(False)
  574. # copy
  575. self.btn_clipboard = wx.Button(parent=self.panel, id=wx.ID_COPY)
  576. self.btn_clipboard.SetToolTipString(_("Copy the current command string to the clipboard"))
  577. btnsizer.Add(item=self.btn_abort, proportion=0,
  578. flag=wx.ALL | wx.ALIGN_CENTER,
  579. border=10)
  580. btnsizer.Add(item=self.btn_run, proportion=0,
  581. flag=wx.ALL | wx.ALIGN_CENTER,
  582. border=10)
  583. btnsizer.Add(item=self.btn_clipboard, proportion=0,
  584. flag=wx.ALL | wx.ALIGN_CENTER,
  585. border=10)
  586. self.btn_run.Bind(wx.EVT_BUTTON, self.OnRun)
  587. self.btn_abort.Bind(wx.EVT_BUTTON, self.OnAbort)
  588. self.btn_clipboard.Bind(wx.EVT_BUTTON, self.OnCopy)
  589. # add help button
  590. btnsizer.Add(item=self.btn_help, proportion=0, flag=wx.ALL | wx.ALIGN_CENTER, border=10)
  591. guisizer.Add(item=btnsizer, proportion=0, flag=wx.ALIGN_CENTER)
  592. if self.parent is not None:
  593. self.outputType = None
  594. for p in self.task.params:
  595. if p.get('name', '') == 'output':
  596. self.outputType = p.get('prompt', None)
  597. break
  598. if self.outputType:
  599. # add newly created map into layer tree
  600. self.addbox = wx.CheckBox(parent=self.panel,
  601. label=_('Add created map into layer tree'), style = wx.NO_BORDER)
  602. self.addbox.SetValue(UserSettings.Get(group='cmd', key='addNewLayer', subkey='enabled'))
  603. guisizer.Add(item=self.addbox, proportion=0,
  604. flag=wx.EXPAND | wx.LEFT | wx.RIGHT | wx.BOTTOM,
  605. border=5)
  606. if self.get_dcmd is None:
  607. # close dialog when command is terminated
  608. self.closebox = wx.CheckBox(parent=self.panel,
  609. label=_('Close dialog on finish'), style = wx.NO_BORDER)
  610. self.closebox.SetValue(UserSettings.Get(group='cmd', key='closeDlg', subkey='enabled'))
  611. guisizer.Add(item=self.closebox, proportion=0,
  612. flag=wx.EXPAND | wx.LEFT | wx.RIGHT | wx.BOTTOM,
  613. border=5)
  614. self.Bind(wx.EVT_CLOSE, self.OnCancel)
  615. #constrained_size = self.notebookpanel.GetSize()
  616. # 80 takes the tabbar into account
  617. #self.notebookpanel.SetSize( (constrained_size[0] + 25, constrained_size[1]) )
  618. #self.notebookpanel.Layout()
  619. #
  620. # put module description
  621. #
  622. if self.task.label != '':
  623. module_desc = self.task.label + os.linesep + self.task.description
  624. else:
  625. module_desc = self.task.description
  626. self.description = StaticWrapText (parent=self.panel,
  627. label=module_desc)
  628. topsizer.Add (item=self.description, proportion=1, border=5,
  629. flag=wx.ALL | wx.ALIGN_CENTER_VERTICAL | wx.EXPAND)
  630. #
  631. # do layout
  632. #
  633. guisizer.SetSizeHints(self.panel)
  634. # called automatically by SetSizer()
  635. self.panel.SetAutoLayout(True)
  636. self.panel.SetSizer(guisizer)
  637. guisizer.Fit(self.panel)
  638. sizeFrame = self.GetBestSize()
  639. self.SetMinSize(sizeFrame)
  640. self.SetSize((sizeFrame[0], sizeFrame[1] +
  641. self.notebookpanel.constrained_size[1] -
  642. self.notebookpanel.panelMinHeight))
  643. self.Layout()
  644. def updateValuesHook(self):
  645. """Update status bar data"""
  646. self.SetStatusText(' '.join(self.notebookpanel.createCmd(ignoreErrors = True)) )
  647. def OnOK(self, event):
  648. """OK button pressed"""
  649. cmd = self.OnApply(event)
  650. if cmd is not None and self.get_dcmd is not None:
  651. self.OnCancel(event)
  652. def OnApply(self, event):
  653. """Apply the command"""
  654. cmd = self.createCmd()
  655. if cmd is not None and self.get_dcmd is not None:
  656. # return d.* command to layer tree for rendering
  657. self.get_dcmd(cmd, self.layer, {"params": self.task.params,
  658. "flags" :self.task.flags},
  659. self)
  660. # echo d.* command to output console
  661. # self.parent.writeDCommand(cmd)
  662. return cmd
  663. def OnRun(self, event):
  664. """Run the command"""
  665. cmd = self.createCmd()
  666. if cmd == [] or cmd == None:
  667. return
  668. if cmd[0][0:2] != "d.":
  669. # Send any non-display command to parent window (probably wxgui.py)
  670. # put to parents
  671. try:
  672. self.goutput.RunCmd(cmd)
  673. except AttributeError,e:
  674. print >> sys.stderr, "%s: Propably not running in wxgui.py session?" % (e)
  675. print >> sys.stderr, "parent window is: %s" % (str(self.parent))
  676. # Send any other command to the shell.
  677. else:
  678. gcmd.Command(cmd)
  679. # update buttons status
  680. for btn in (self.btn_run,
  681. self.btn_cancel,
  682. self.btn_clipboard,
  683. self.btn_help):
  684. btn.Enable(False)
  685. self.btn_abort.Enable(True)
  686. def OnAbort(self, event):
  687. """Abort running command"""
  688. event = goutput.wxCmdAbort(aborted=True)
  689. wx.PostEvent(self.goutput, event)
  690. def OnCopy(self, event):
  691. """Copy the command"""
  692. cmddata = wx.TextDataObject()
  693. # list -> string
  694. cmdstring = ' '.join(self.createCmd(ignoreErrors=True))
  695. cmddata.SetText(cmdstring)
  696. if wx.TheClipboard.Open():
  697. wx.TheClipboard.UsePrimarySelection(True)
  698. wx.TheClipboard.SetData(cmddata)
  699. wx.TheClipboard.Close()
  700. self.SetStatusText( _("'%s' copied to clipboard") % \
  701. (cmdstring))
  702. def OnCancel(self, event):
  703. """Cancel button pressed"""
  704. self.MakeModal(False)
  705. if self.get_dcmd:
  706. if len(self.parent.GetPyData(self.layer)[0]['cmd']) < 1:
  707. self.parent.Delete(self.layer)
  708. self.Destroy()
  709. else:
  710. self.Hide()
  711. else:
  712. self.Destroy()
  713. def OnHelp(self, event):
  714. """Show manual page (switch to the 'Manual' notebook page)"""
  715. if hasattr(self.notebookpanel, "manual_tab_id"):
  716. self.notebookpanel.notebook.SetSelection(self.notebookpanel.manual_tab_id)
  717. self.notebookpanel.OnPageChange(None)
  718. event.Skip()
  719. def createCmd(self, ignoreErrors = False):
  720. """Create command string (python list)"""
  721. return self.notebookpanel.createCmd(ignoreErrors=ignoreErrors)
  722. class cmdPanel(wx.Panel):
  723. """
  724. A panel containing a notebook dividing in tabs the different guisections of the GRASS cmd.
  725. """
  726. def __init__( self, parent, task, standalone, mainFrame, *args, **kwargs ):
  727. wx.Panel.__init__( self, parent, *args, **kwargs )
  728. self.parent = mainFrame
  729. self.task = task
  730. fontsize = 10
  731. # Determine tab layout
  732. sections = []
  733. is_section = {}
  734. not_hidden = [ p for p in self.task.params + self.task.flags if not p.get( 'hidden','no' ) == 'yes' ]
  735. for task in not_hidden:
  736. if task.get( 'required','no' ) == 'yes':
  737. # All required go into Main, even if they had defined another guisection
  738. task['guisection'] = _( 'Required' )
  739. if task.get( 'guisection','' ) == '':
  740. # Undefined guisections end up into Options
  741. task['guisection'] = _( 'Optional' )
  742. if not is_section.has_key(task['guisection']):
  743. # We do it like this to keep the original order, except for Main which goes first
  744. is_section[task['guisection']] = 1
  745. sections.append( task['guisection'] )
  746. else:
  747. is_section[ task['guisection'] ] += 1
  748. del is_section
  749. # 'Required' tab goes first, 'Optional' as the last one
  750. for (newidx,content) in [ (0,_( 'Required' )), (len(sections)-1,_('Optional')) ]:
  751. if content in sections:
  752. idx = sections.index( content )
  753. sections[idx:idx+1] = []
  754. sections[newidx:newidx] = [content]
  755. panelsizer = wx.BoxSizer(orient=wx.VERTICAL)
  756. # Build notebook
  757. nbStyle = globalvar.FNPageStyle
  758. self.notebook = FN.FlatNotebook( self, id=wx.ID_ANY, style=nbStyle)
  759. self.notebook.SetTabAreaColour(globalvar.FNPageColor)
  760. self.notebook.Bind(FN.EVT_FLATNOTEBOOK_PAGE_CHANGED, self.OnPageChange)
  761. tab = {}
  762. tabsizer = {}
  763. for section in sections:
  764. tab[section] = wx.ScrolledWindow( parent=self.notebook )
  765. tab[section].SetScrollRate(10,10)
  766. tabsizer[section] = wx.BoxSizer(orient=wx.VERTICAL)
  767. self.notebook.AddPage( tab[section], text=section )
  768. # are we running from command line?
  769. ### add 'command output' tab regardless standalone dialog
  770. if self.parent.get_dcmd is None:
  771. self.goutput = goutput.GMConsole(parent=self, margin=False,
  772. pageid=self.notebook.GetPageCount())
  773. self.outpage = self.notebook.AddPage(self.goutput, text=_("Command output") )
  774. else:
  775. self.goutput = None
  776. self.manual_tab = helpPanel(parent = self.notebook, grass_command = self.task.name)
  777. self.manual_tabsizer = wx.BoxSizer(wx.VERTICAL)
  778. self.notebook.AddPage(self.manual_tab, text=_("Manual"))
  779. self.manual_tab_id = self.notebook.GetPageCount() - 1
  780. self.notebook.SetSelection(0)
  781. panelsizer.Add(item=self.notebook, proportion=1, flag=wx.EXPAND )
  782. #
  783. # flags
  784. #
  785. text_style = wx.FONTWEIGHT_NORMAL
  786. visible_flags = [ f for f in self.task.flags if not f.get( 'hidden', 'no' ) == 'yes' ]
  787. for f in visible_flags:
  788. which_sizer = tabsizer[ f['guisection'] ]
  789. which_panel = tab[ f['guisection'] ]
  790. # if label is given: description -> tooltip
  791. if f.get('label','') != '':
  792. title = text_beautify( f['label'] )
  793. tooltip = text_beautify ( f['description'] )
  794. else:
  795. title = text_beautify( f['description'] )
  796. tooltip = None
  797. chk = wx.CheckBox(parent=which_panel, label = title, style = wx.NO_BORDER)
  798. if tooltip:
  799. chk.SetToolTipString(tooltip)
  800. if 'value' in f:
  801. chk.SetValue( f['value'] )
  802. # chk.SetFont(wx.Font(pointSize=fontsize, family=wx.FONTFAMILY_DEFAULT,
  803. # style=wx.NORMAL, weight=text_style))
  804. which_sizer.Add( item=chk, proportion=0,
  805. flag=wx.EXPAND | wx.TOP | wx.LEFT | wx.RIGHT, border=5)
  806. f['wxId'] = chk.GetId()
  807. chk.Bind(wx.EVT_CHECKBOX, self.OnSetValue)
  808. if f['name'] in ('verbose', 'quiet'):
  809. chk.Bind(wx.EVT_CHECKBOX, self.OnVerbosity)
  810. vq = UserSettings.Get(group='cmd', key='verbosity', subkey='selection')
  811. if f['name'] == vq:
  812. chk.SetValue(True)
  813. f['value'] = True
  814. elif f['name'] == 'overwrite':
  815. chk.SetValue(UserSettings.Get(group='cmd', key='overwrite', subkey='enabled'))
  816. f['value'] = UserSettings.Get(group='cmd', key='overwrite', subkey='enabled')
  817. #
  818. # parameters
  819. #
  820. visible_params = [ p for p in self.task.params if not p.get( 'hidden', 'no' ) == 'yes' ]
  821. for p in visible_params:
  822. which_sizer = tabsizer[ p['guisection'] ]
  823. which_panel = tab[ p['guisection'] ]
  824. # if label is given -> label and description -> tooltip
  825. # otherwise description -> lavel
  826. if p.get('label','') != '':
  827. title = text_beautify( p['label'] )
  828. tooltip = text_beautify ( p['description'] )
  829. else:
  830. title = text_beautify( p['description'] )
  831. tooltip = None
  832. txt = None
  833. # text style (required -> bold)
  834. if p.get('required','no') == 'no':
  835. text_style = wx.FONTWEIGHT_NORMAL
  836. else:
  837. text_style = wx.FONTWEIGHT_BOLD
  838. # title expansion
  839. if p.get('multiple','no') == 'yes' and len( p.get('values','') ) == 0:
  840. title = _("[multiple]") + " " + title
  841. if p.get('value','') == '' :
  842. p['value'] = p.get('default','')
  843. if ( len(p.get('values', []) ) > 0):
  844. valuelist=map( str, p.get('values',[]) )
  845. if p.get('multiple', 'no') == 'yes' and \
  846. p.get('type', '') == 'string':
  847. txt = wx.StaticBox (parent=which_panel, id=0, label=" " + title + ": ")
  848. if len(valuelist) > 6:
  849. hSizer=wx.StaticBoxSizer ( box=txt, orient=wx.VERTICAL )
  850. else:
  851. hSizer=wx.StaticBoxSizer ( box=txt, orient=wx.HORIZONTAL )
  852. isEnabled = {}
  853. # copy default values
  854. if p['value'] == '':
  855. p['value'] = p.get('default', '')
  856. for defval in p.get('value', '').split(','):
  857. isEnabled[ defval ] = 'yes'
  858. # for multi checkboxes, this is an array of all wx IDs
  859. # for each individual checkbox
  860. p[ 'wxId' ] = []
  861. for val in valuelist:
  862. chkbox = wx.CheckBox( parent=which_panel, label = text_beautify(val) )
  863. p[ 'wxId' ].append( chkbox.GetId() )
  864. if isEnabled.has_key(val):
  865. chkbox.SetValue( True )
  866. hSizer.Add( item=chkbox, proportion=0,
  867. flag=wx.ADJUST_MINSIZE | wx.ALL, border=1 )
  868. chkbox.Bind(wx.EVT_CHECKBOX, self.OnCheckBoxMulti)
  869. which_sizer.Add( item=hSizer, proportion=0,
  870. flag=wx.EXPAND | wx.TOP | wx.RIGHT | wx.LEFT, border=5 )
  871. else:
  872. if len(valuelist) == 1: # -> textctrl
  873. txt = wx.StaticText(parent=which_panel,
  874. label = "%s. %s %s" % (title, _('Valid range'),
  875. str(valuelist[0]) + ':'))
  876. which_sizer.Add(item=txt, proportion=0,
  877. flag=wx.ADJUST_MINSIZE | wx.TOP | wx.RIGHT | wx.LEFT, border=5)
  878. if p.get('type','') == 'integer' and \
  879. p.get('multiple','no') == 'no':
  880. # for multiple integers use textctrl instead of spinsctrl
  881. try:
  882. minValue, maxValue = map(int, valuelist[0].split('-'))
  883. except ValueError:
  884. minValue = -1e6
  885. maxValue = 1e6
  886. txt2 = wx.SpinCtrl(parent=which_panel, id=wx.ID_ANY, size=globalvar.DIALOG_SPIN_SIZE,
  887. min=minValue, max=maxValue)
  888. else:
  889. txt2 = wx.TextCtrl(parent=which_panel, value = p.get('default',''),
  890. size=globalvar.DIALOG_TEXTCTRL_SIZE)
  891. if p.get('value','') != '':
  892. txt2.SetValue(p['value']) # parameter previously set
  893. which_sizer.Add(item=txt2, proportion=0,
  894. flag=wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT, border=5)
  895. p['wxId'] = txt2.GetId()
  896. txt2.Bind(wx.EVT_TEXT, self.OnSetValue)
  897. else:
  898. # list of values (combo)
  899. txt = wx.StaticText(parent=which_panel, label = title + ':' )
  900. which_sizer.Add(item=txt, proportion=0,
  901. flag=wx.ADJUST_MINSIZE | wx.TOP | wx.RIGHT | wx.LEFT, border=5)
  902. cb = wx.ComboBox(parent=which_panel, id=wx.ID_ANY, value=p.get('default',''),
  903. size=globalvar.DIALOG_COMBOBOX_SIZE,
  904. choices=valuelist, style=wx.CB_DROPDOWN)
  905. if p.get('value','') != '':
  906. cb.SetValue(p['value']) # parameter previously set
  907. which_sizer.Add( item=cb, proportion=0,
  908. flag=wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT, border=5)
  909. p['wxId'] = cb.GetId()
  910. cb.Bind( wx.EVT_COMBOBOX, self.OnSetValue)
  911. # text entry
  912. if (p.get('type','string') in ('string','integer','float')
  913. and len(p.get('values',[])) == 0
  914. and p.get('gisprompt',False) == False
  915. and p.get('prompt','') != 'color'):
  916. txt = wx.StaticText(parent=which_panel, label = title + ':' )
  917. which_sizer.Add(item=txt, proportion=0,
  918. flag=wx.RIGHT | wx.LEFT | wx.TOP | wx.EXPAND, border=5)
  919. if p.get('multiple','yes') == 'yes' or \
  920. p.get('type', 'string') in ('string', 'float') or \
  921. len(p.get('key_desc', [])) > 1:
  922. txt3 = wx.TextCtrl(parent=which_panel, value = p.get('default',''),
  923. size=globalvar.DIALOG_TEXTCTRL_SIZE)
  924. if p.get('value','') != '':
  925. txt3.SetValue(str(p['value'])) # parameter previously set
  926. txt3.Bind(wx.EVT_TEXT, self.OnSetValue)
  927. else:
  928. minValue = -1e9
  929. maxValue = 1e9
  930. txt3 = wx.SpinCtrl(parent=which_panel, value=p.get('default',''),
  931. size=globalvar.DIALOG_SPIN_SIZE,
  932. min=minValue, max=maxValue)
  933. if p.get('value','') != '':
  934. txt3.SetValue(int(p['value'])) # parameter previously set
  935. txt3.Bind(wx.EVT_SPINCTRL, self.OnSetValue)
  936. txt3.Bind(wx.EVT_TEXT, self.OnSetValue)
  937. which_sizer.Add(item=txt3, proportion=0, flag=wx.BOTTOM | wx.LEFT, border=5)
  938. p['wxId'] = txt3.GetId()
  939. if p.get('type','string') == 'string' and p.get('gisprompt',False) == True:
  940. txt = wx.StaticText(parent=which_panel, label = title + ':')
  941. which_sizer.Add(item=txt, proportion=0,
  942. flag=wx.ADJUST_MINSIZE | wx.RIGHT | wx.LEFT | wx.TOP, border=5)
  943. # element selection tree combobox (maps, icons, regions, etc.)
  944. if p.get('prompt','') not in ('color', 'dbcolumn', 'dbtable') and \
  945. p.get('element', '') != 'file':
  946. if p.get('multiple','no') == 'yes':
  947. multiple = True
  948. else:
  949. multiple = False
  950. if p.get('age','') == 'new':
  951. mapsets = [grassenv.GetGRASSVariable('MAPSET'),]
  952. else:
  953. mapsets = None
  954. selection = gselect.Select(parent=which_panel, id=wx.ID_ANY, size=globalvar.DIALOG_GSELECT_SIZE,
  955. type=p.get('element',''), multiple=multiple, mapsets=mapsets)
  956. if p.get('value','') != '':
  957. selection.SetValue(p['value']) # parameter previously set
  958. which_sizer.Add(item=selection, proportion=0,
  959. flag=wx.ADJUST_MINSIZE| wx.BOTTOM | wx.LEFT | wx.RIGHT, border=5)
  960. # A select.Select is a combobox with two children: a textctl and a popupwindow;
  961. # we target the textctl here
  962. p['wxId'] = selection.GetChildren()[0].GetId()
  963. selection.Bind(wx.EVT_TEXT, self.OnSetValue)
  964. # dbcolumn entry
  965. elif p.get('prompt','') in ('dbcolumn', 'dbtable'):
  966. if p.get('age', 'old') == 'old':
  967. style = wx.CB_SIMPLE | wx.CB_READONLY
  968. else:
  969. style = wx.CB_SIMPLE
  970. columns = wx.ComboBox(parent=which_panel, id=wx.ID_ANY,
  971. size=globalvar.DIALOG_COMBOBOX_SIZE,
  972. style=style,
  973. choices=[])
  974. p['wxId'] = columns.GetId()
  975. p['wxGetValue'] = columns.GetStringSelection
  976. if p.get('prompt', '') == 'dbcolumn':
  977. columns.Bind(wx.EVT_ENTER_WINDOW, self.OnDbColumn)
  978. else:
  979. columns.Bind(wx.EVT_ENTER_WINDOW, self.OnDbTable)
  980. columns.Bind(wx.EVT_COMBOBOX, self.OnSetValue)
  981. which_sizer.Add(item=columns, proportion=0,
  982. flag=wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT, border=5)
  983. # color entry
  984. elif p.get('prompt','') == 'color':
  985. # Heuristic way of finding whether transparent is allowed
  986. handle_transparency = 'none' in title
  987. default_color = (200,200,200)
  988. label_color = _("Select Color")
  989. if p.get('default','') != '':
  990. default_color, label_color = color_resolve( p['default'] )
  991. if p.get('value','') != '': # parameter previously set
  992. default_color, label_color = color_resolve( p['value'] )
  993. if handle_transparency:
  994. this_sizer = wx.BoxSizer(orient=wx.HORIZONTAL )
  995. else:
  996. this_sizer = which_sizer
  997. btn_colour = csel.ColourSelect(parent=which_panel, id=wx.ID_ANY,
  998. label=label_color, colour=default_color,
  999. pos=wx.DefaultPosition, size=(150,-1) )
  1000. this_sizer.Add(item=btn_colour, proportion=0,
  1001. flag=wx.ADJUST_MINSIZE | wx.BOTTOM | wx.LEFT, border=5)
  1002. # For color selectors, this is a two-member array, holding the IDs of
  1003. # the selector proper and either a "transparent" button or None
  1004. p['wxId'] = [btn_colour.GetId(),]
  1005. btn_colour.Bind(csel.EVT_COLOURSELECT, self.OnColorChange )
  1006. if handle_transparency:
  1007. none_check = wx.CheckBox(which_panel, wx.ID_ANY, _("Transparent") )
  1008. if p.get('value','') != '' and p.get('value',[''])[0] == "none":
  1009. none_check.SetValue(True)
  1010. else:
  1011. none_check.SetValue(False)
  1012. # none_check.SetFont( wx.Font( fontsize, wx.FONTFAMILY_DEFAULT, wx.NORMAL, text_style, 0, ''))
  1013. this_sizer.Add(item=none_check, proportion=0,
  1014. flag=wx.ADJUST_MINSIZE | wx.LEFT | wx.RIGHT | wx.TOP, border=5)
  1015. which_sizer.Add( this_sizer )
  1016. none_check.Bind(wx.EVT_CHECKBOX, self.OnColorChange)
  1017. p['wxId'].append( none_check.GetId() )
  1018. else:
  1019. p['wxId'].append(None)
  1020. # file selector
  1021. elif p.get('prompt','') != 'color' and p.get('element', '') == 'file':
  1022. fbb = filebrowse.FileBrowseButton(parent=which_panel, id=wx.ID_ANY,
  1023. size=globalvar.DIALOG_GSELECT_SIZE, labelText='',
  1024. dialogTitle=_('Choose %s') % \
  1025. p.get('description',_('File')),
  1026. buttonText=_('Browse'),
  1027. startDirectory=os.getcwd(), fileMode=0,
  1028. changeCallback=self.OnSetValue)
  1029. if p.get('value','') != '':
  1030. fbb.SetValue(p['value']) # parameter previously set
  1031. which_sizer.Add(item=fbb, proportion=0,
  1032. flag=wx.ADJUST_MINSIZE | wx.LEFT | wx.TOP | wx.RIGHT, border=-3)
  1033. # A file browse button is a combobox with two children:
  1034. # a textctl and a button;
  1035. # we have to target the button here
  1036. p['wxId'] = fbb.GetChildren()[1].GetId()
  1037. if txt is not None:
  1038. # txt.SetFont( wx.Font( fontsize, wx.FONTFAMILY_DEFAULT, wx.NORMAL, text_style, 0, ''))
  1039. # create tooltip if given
  1040. if len(p['values_desc']) > 0:
  1041. if tooltip:
  1042. tooltip += 2 * os.linesep
  1043. else:
  1044. tooltip = ''
  1045. if len(p['values']) == len(p['values_desc']):
  1046. for i in range(len(p['values'])):
  1047. tooltip += p['values'][i] + ': ' + p['values_desc'][i] + os.linesep
  1048. tooltip.strip(os.linesep)
  1049. if tooltip:
  1050. txt.SetToolTipString(tooltip)
  1051. #
  1052. # determine panel size
  1053. #
  1054. maxsizes = (0,0)
  1055. for section in sections:
  1056. # tabsizer[section].SetSizeHints( tab[section] )
  1057. #tab[section].SetAutoLayout(True)
  1058. tab[section].SetSizer( tabsizer[section] )
  1059. tabsizer[section].Fit( tab[section] )
  1060. tab[section].Layout()
  1061. minsecsizes = tabsizer[section].GetSize()
  1062. maxsizes = map( lambda x: max( maxsizes[x], minsecsizes[x] ), (0,1) )
  1063. # TODO: be less arbitrary with these 600
  1064. self.panelMinHeight = 100
  1065. self.constrained_size = (min(600, maxsizes[0]) + 25, min(400, maxsizes[1]) + 25)
  1066. for section in sections:
  1067. tab[section].SetMinSize( (self.constrained_size[0], self.panelMinHeight) )
  1068. # tab[section].SetMinSize( constrained_size )
  1069. if self.manual_tab.Ok:
  1070. self.manual_tab.SetMinSize( (self.constrained_size[0], self.panelMinHeight) )
  1071. # manual_tab.SetMinSize( constrained_size )
  1072. self.SetSizer( panelsizer )
  1073. panelsizer.Fit(self.notebook)
  1074. self.hasMain = tab.has_key( _('Required') ) # publish, to enclosing Frame for instance
  1075. def OnVerbosity(self, event):
  1076. """Verbosity level changed"""
  1077. verbose = self.FindWindowById(self.task.get_flag('verbose')['wxId'])
  1078. quiet = self.FindWindowById(self.task.get_flag('quiet')['wxId'])
  1079. if event.IsChecked():
  1080. if event.GetId() == verbose.GetId():
  1081. if quiet.IsChecked():
  1082. quiet.SetValue(False)
  1083. self.task.get_flag('quiet')['value'] = False
  1084. else:
  1085. if verbose.IsChecked():
  1086. verbose.SetValue(False)
  1087. self.task.get_flag('verbose')['value'] = False
  1088. event.Skip()
  1089. def OnPageChange(self, event):
  1090. if not event:
  1091. sel = self.notebook.GetSelection()
  1092. else:
  1093. sel = event.GetSelection()
  1094. if hasattr(self, "manual_tab_id") and \
  1095. sel == self.manual_tab_id:
  1096. # calling LoadPage() is strangely time-consuming (only first call)
  1097. # FIXME: move to helpPage.__init__()
  1098. if not self.manual_tab.Ok:
  1099. wx.Yield()
  1100. self.manual_tab.LoadPage(self.manual_tab.fspath + self.task.name + ".html")
  1101. self.manual_tab.Ok = True
  1102. self.Layout()
  1103. def OnColorChange( self, event ):
  1104. myId = event.GetId()
  1105. for p in self.task.params:
  1106. if 'wxId' in p and type( p['wxId'] ) == type( [] ) and myId in p['wxId']:
  1107. has_button = p['wxId'][1] is not None
  1108. if has_button and wx.FindWindowById( p['wxId'][1] ).GetValue() == True:
  1109. p[ 'value' ] = 'none'
  1110. else:
  1111. colorchooser = wx.FindWindowById( p['wxId'][0] )
  1112. new_color = colorchooser.GetValue()[:]
  1113. # This is weird: new_color is a 4-tuple and new_color[:] is a 3-tuple
  1114. # under wx2.8.1
  1115. new_label = rgb2str.get( new_color, ':'.join(map(str,new_color)) )
  1116. colorchooser.SetLabel( new_label )
  1117. colorchooser.SetColour( new_color )
  1118. colorchooser.Refresh()
  1119. p[ 'value' ] = colorchooser.GetLabel()
  1120. self.OnUpdateValues()
  1121. def OnUpdateValues(self):
  1122. """
  1123. If we were part of a richer interface, report back the current command being built.
  1124. This method should be set by the parent of this panel if needed. It's a hook, actually.
  1125. Beware of what is 'self' in the method def, though. It will be called with no arguments.
  1126. """
  1127. pass
  1128. def OnCheckBoxMulti(self, event):
  1129. """
  1130. Fill the values as a ','-separated string according to current status of the checkboxes.
  1131. """
  1132. me = event.GetId()
  1133. theParam = None
  1134. for p in self.task.params:
  1135. if 'wxId' in p and type( p['wxId'] ) == type( [] ) and me in p['wxId']:
  1136. theParam = p
  1137. myIndex = p['wxId'].index( me )
  1138. # Unpack current value list
  1139. currentValues = {}
  1140. for isThere in theParam.get('value', '').split(','):
  1141. currentValues[isThere] = 1
  1142. theValue = theParam['values'][myIndex]
  1143. if event.Checked():
  1144. currentValues[ theValue ] = 1
  1145. else:
  1146. del currentValues[ theValue ]
  1147. # Keep the original order, so that some defaults may be recovered
  1148. currentValueList = []
  1149. for v in theParam['values']:
  1150. if currentValues.has_key(v):
  1151. currentValueList.append( v )
  1152. # Pack it back
  1153. theParam['value'] = ','.join( currentValueList )
  1154. self.OnUpdateValues()
  1155. def OnSetValue(self, event):
  1156. """
  1157. Retrieve the widget value and set the task value field accordingly.
  1158. Use for widgets that have a proper GetValue() method, i.e. not for selectors.
  1159. """
  1160. myId = event.GetId()
  1161. me = wx.FindWindowById( myId )
  1162. for porf in self.task.params + self.task.flags:
  1163. if 'wxId' in porf and type( porf[ 'wxId' ] ) == type( 1 ) and porf['wxId'] == myId:
  1164. if porf.has_key('wxGetValue') and porf['wxGetValue']:
  1165. porf['value'] = porf['wxGetValue']()
  1166. else:
  1167. porf['value'] = me.GetValue()
  1168. self.OnUpdateValues()
  1169. event.Skip()
  1170. def OnDbColumn(self, event):
  1171. """Get list of table columns"""
  1172. choices = []
  1173. p = self.task.get_param('table', raiseError=False)
  1174. if p and p.get('prompt', '') == 'dbtable':
  1175. cmd = ['db.columns',
  1176. 'table=%s' % p.get('value')]
  1177. try:
  1178. choices = gcmd.Command(cmd).ReadStdOutput()
  1179. except gcmd.CmdError:
  1180. choices = []
  1181. if not p:
  1182. p = self.task.get_param('map', raiseError=False)
  1183. if not p:
  1184. p = self.task.get_param('input', raiseError=False)
  1185. if p:
  1186. mapName = utils.GetLayerNameFromCmd(self.task.getCmd(ignoreErrors=True))
  1187. if mapName != _('<required>'):
  1188. layer = 1
  1189. p = self.task.get_param('layer')
  1190. if p:
  1191. value = p.get('value', '1')
  1192. if value:
  1193. layer = int(value)
  1194. cmd = ['v.info',
  1195. 'map=%s' % mapName,
  1196. 'layer=%d' % layer,
  1197. '-c', '--q']
  1198. try:
  1199. for line in gcmd.Command(cmd).ReadStdOutput():
  1200. type, name = line.split('|')
  1201. choices.append(name.strip())
  1202. except gcmd.CmdError:
  1203. choices = []
  1204. win = self.FindWindowById(event.GetId())
  1205. win.SetItems(choices)
  1206. if len(choices) < 1:
  1207. win.SetValue('')
  1208. event.Skip()
  1209. def OnDbTable(self, event):
  1210. """Get list of tables"""
  1211. # TODO: add driver/database
  1212. cmd = ['db.tables',
  1213. '-p', '--q']
  1214. for p in self.task.params:
  1215. if p.get('name', '') == 'driver' and \
  1216. len(p.get('value', '')) > 0:
  1217. cmd.append('driver=%s' % p.get('value'))
  1218. elif p.get('name', '') == 'database' and \
  1219. len(p.get('value', '')) > 0:
  1220. cmd.append('database=%s' % p.get('value'))
  1221. try:
  1222. choices = gcmd.Command(cmd).ReadStdOutput()
  1223. except gcmd.CmdError:
  1224. choices = []
  1225. win = self.FindWindowById(event.GetId())
  1226. win.SetItems(choices)
  1227. if len(choices) < 1:
  1228. win.SetValue('')
  1229. event.Skip()
  1230. def createCmd( self, ignoreErrors = False ):
  1231. """
  1232. Produce a command line string (list) or feeding into GRASS.
  1233. If ignoreErrors==True then it will return whatever has been
  1234. built so far, even though it would not be a correct command
  1235. for GRASS.
  1236. """
  1237. try:
  1238. cmd = self.task.getCmd( ignoreErrors=ignoreErrors )
  1239. except ValueError, err:
  1240. dlg = wx.MessageDialog(parent=self,
  1241. message=str(err),
  1242. caption=_("Error in %s") % self.task.name,
  1243. style=wx.OK | wx.ICON_ERROR | wx.CENTRE)
  1244. dlg.ShowModal()
  1245. dlg.Destroy()
  1246. cmd = None
  1247. return cmd
  1248. def getInterfaceDescription( cmd ):
  1249. """
  1250. Returns the XML description for the GRASS cmd.
  1251. The DTD must be located in $GISBASE/etc/grass-interface.dtd,
  1252. otherwise the parser will not succeed.
  1253. Note: 'cmd' is given as string
  1254. """
  1255. cmdout = os.popen(cmd + r' --interface-description', "r").read()
  1256. if not len(cmdout) > 0 :
  1257. raise IOError, _("Unable to fetch interface description for command '%s'.") % cmd
  1258. p = re.compile( '(grass-interface.dtd)')
  1259. p.search( cmdout )
  1260. cmdout = p.sub(globalvar.ETCDIR + r'/grass-interface.dtd', cmdout)
  1261. return cmdout
  1262. class GrassGUIApp(wx.App):
  1263. """
  1264. Stand-alone GRASS command GUI
  1265. """
  1266. def __init__(self, grass_task):
  1267. self.grass_task = grass_task
  1268. wx.App.__init__(self, False)
  1269. def OnInit(self):
  1270. self.mf = mainFrame(parent=None, ID=wx.ID_ANY, task_description=self.grass_task)
  1271. self.mf.CentreOnScreen()
  1272. self.mf.Show(True)
  1273. self.SetTopWindow(self.mf)
  1274. # print >> sys.stderr, time.time() - start
  1275. return True
  1276. class GUI:
  1277. """
  1278. Parses GRASS commands when module is imported and used
  1279. from Layer Manager.
  1280. """
  1281. def __init__(self, parent=-1):
  1282. self.parent = parent
  1283. self.grass_task = None
  1284. def ParseCommand(self, cmd, gmpath=None, completed=None, parentframe=None, show=True, modal=False):
  1285. """
  1286. Parse command
  1287. Note: cmd is given as list
  1288. If command is given with options, return validated cmd list:
  1289. * add key name for first parameter if not given
  1290. * change mapname to mapname@mapset
  1291. """
  1292. start = time.time()
  1293. dcmd_params = {}
  1294. if completed == None:
  1295. get_dcmd = None
  1296. layer = None
  1297. dcmd_params = None
  1298. else:
  1299. get_dcmd = completed[0]
  1300. layer = completed[1]
  1301. if completed[2]:
  1302. dcmd_params.update(completed[2])
  1303. self.parent = parentframe
  1304. # parse the interface decription
  1305. self.grass_task = grassTask()
  1306. handler = processTask(self.grass_task)
  1307. xml.sax.parseString( getInterfaceDescription(cmd[0]), handler )
  1308. # if layer parameters previously set, re-insert them into dialog
  1309. if completed is not None:
  1310. if 'params' in dcmd_params:
  1311. self.grass_task.params = dcmd_params['params']
  1312. if 'flags' in dcmd_params:
  1313. self.grass_task.flags = dcmd_params['flags']
  1314. # update parameters if needed && validate command
  1315. if len(cmd) > 1:
  1316. i = 0
  1317. cmd_validated = [cmd[0]]
  1318. for option in cmd[1:]:
  1319. if option[0] == '-': # flag
  1320. self.grass_task.set_flag(option[1], True)
  1321. cmd_validated.append(option)
  1322. else: # parameter
  1323. try:
  1324. key, value = option.split('=', 1)
  1325. except:
  1326. if i == 0: # add key name of first parameter if not given
  1327. key = self.grass_task.firstParam
  1328. value = option
  1329. else:
  1330. raise ValueError, _("Unable to parse command %s") % ' '.join(cmd)
  1331. if self.grass_task.get_param(key)['element'] in ['cell', 'vector']:
  1332. # mapname -> mapname@mapset
  1333. if '@' not in value:
  1334. value = value + '@' + grassenv.GetGRASSVariable('MAPSET')
  1335. self.grass_task.set_param(key, value)
  1336. cmd_validated.append(key + '=' + value)
  1337. i = i + 1
  1338. # update original command list
  1339. cmd = cmd_validated
  1340. self.mf = mainFrame(parent=self.parent, ID=wx.ID_ANY,
  1341. task_description=self.grass_task,
  1342. get_dcmd=get_dcmd, layer=layer)
  1343. if get_dcmd is not None:
  1344. # update only propwin reference
  1345. get_dcmd(dcmd=None, layer=layer, params=None,
  1346. propwin=self.mf)
  1347. if show:
  1348. if self.parent:
  1349. self.mf.CentreOnParent()
  1350. self.mf.Show(show)
  1351. self.mf.MakeModal(modal)
  1352. else:
  1353. self.mf.OnApply(None)
  1354. # print >> sys.stderr, time.time() - start
  1355. return cmd
  1356. def GetCommandInputMapParamKey(self, cmd):
  1357. """Get parameter key for input raster/vector map
  1358. @param cmd module name
  1359. @return parameter key
  1360. @return None on failure
  1361. """
  1362. # parse the interface decription
  1363. if not self.grass_task:
  1364. self.grass_task = grassTask()
  1365. handler = processTask(self.grass_task)
  1366. xml.sax.parseString(getInterfaceDescription(cmd), handler)
  1367. for p in self.grass_task.params:
  1368. if p.get('name', '') in ('input', 'map'):
  1369. age = p.get('age', '')
  1370. prompt = p.get('prompt', '')
  1371. element = p.get('element', '')
  1372. if age == 'old' and \
  1373. element in ('cell', 'grid3', 'vector') and \
  1374. prompt in ('raster', '3d-raster', 'vector'):
  1375. return p.get('name', None)
  1376. return None
  1377. class StaticWrapText(wx.StaticText):
  1378. """
  1379. A Static Text field that wraps its text to fit its width, enlarging its height if necessary.
  1380. """
  1381. def __init__(self, parent, id=wx.ID_ANY, label=u'', *args, **kwds):
  1382. self.originalLabel = label
  1383. wx.StaticText.__init__(self, parent, id, u'', *args, **kwds)
  1384. self.SetLabel(label)
  1385. self.Bind(wx.EVT_SIZE, self.onResize)
  1386. def SetLabel(self, label):
  1387. self.originalLabel = label
  1388. self.wrappedSize = None
  1389. #self.onResize(None)
  1390. def onResize(self, event):
  1391. if not getattr(self, "resizing", False):
  1392. self.resizing = True
  1393. newSize = self.GetSize()
  1394. if self.wrappedSize != newSize:
  1395. wx.StaticText.SetLabel(self, self.originalLabel)
  1396. self.Wrap(newSize.width)
  1397. self.wrappedSize = self.GetMinSize()
  1398. self.SetSize(self.wrappedSize)
  1399. del self.resizing
  1400. if __name__ == "__main__":
  1401. if len(sys.argv) == 1:
  1402. print _("usage: %s <grass command>") % sys.argv[0]
  1403. sys.exit()
  1404. if sys.argv[1] != 'test':
  1405. q=wx.LogNull()
  1406. GrassGUIApp( grassTask( sys.argv[1] ) ).MainLoop()
  1407. else: #Test
  1408. # Test grassTask from within a GRASS session
  1409. if os.getenv("GISBASE") is not None:
  1410. task = grassTask( "d.vect" )
  1411. task.get_param('map')['value'] = "map_name"
  1412. task.get_flag('v')['value'] = True
  1413. task.get_param('layer')['value'] = 1
  1414. task.get_param('bcolor')['value'] = "red"
  1415. assert ' '.join( task.getCmd() ) == "d.vect -v map=map_name layer=1 bcolor=red"
  1416. # Test interface building with handmade grassTask,
  1417. # possibly outside of a GRASS session.
  1418. task = grassTask()
  1419. task.name = "TestTask"
  1420. task.description = "This is an artificial grassTask() object intended for testing purposes."
  1421. task.keywords = ["grass","test","task"]
  1422. task.params = [
  1423. {
  1424. "name" : "text",
  1425. "description" : "Descriptions go into tooltips if labels are present, like this one",
  1426. "label" : "Enter some text",
  1427. },{
  1428. "name" : "hidden_text",
  1429. "description" : "This text should not appear in the form",
  1430. "hidden" : "yes"
  1431. },{
  1432. "name" : "text_default",
  1433. "description" : "Enter text to override the default",
  1434. "default" : "default text"
  1435. },{
  1436. "name" : "text_prefilled",
  1437. "description" : "You should see a friendly welcome message here",
  1438. "value" : "hello, world"
  1439. },{
  1440. "name" : "plain_color",
  1441. "description" : "This is a plain color, and it is a compulsory parameter",
  1442. "required" : "yes",
  1443. "gisprompt" : True,
  1444. "prompt" : "color"
  1445. },{
  1446. "name" : "transparent_color",
  1447. "description" : "This color becomes transparent when set to none",
  1448. "guisection" : "tab",
  1449. "gisprompt" : True,
  1450. "prompt" : "color"
  1451. },{
  1452. "name" : "multi",
  1453. "description" : "A multiple selection",
  1454. 'default': u'red,green,blue',
  1455. 'gisprompt': False,
  1456. 'guisection': 'tab',
  1457. 'multiple': u'yes',
  1458. 'type': u'string',
  1459. 'value': '',
  1460. 'values': ['red', 'green', u'yellow', u'blue', u'purple', u'other']
  1461. },{
  1462. "name" : "single",
  1463. "description" : "A single multiple-choice selection",
  1464. 'values': ['red', 'green', u'yellow', u'blue', u'purple', u'other'],
  1465. "guisection" : "tab"
  1466. },{
  1467. "name" : "large_multi",
  1468. "description" : "A large multiple selection",
  1469. "gisprompt" : False,
  1470. "multiple" : "yes",
  1471. # values must be an array of strings
  1472. "values" : str2rgb.keys() + map( str, str2rgb.values() )
  1473. },{
  1474. "name" : "a_file",
  1475. "description" : "A file selector",
  1476. "gisprompt" : True,
  1477. "element" : "file"
  1478. }
  1479. ]
  1480. task.flags = [
  1481. {
  1482. "name" : "a",
  1483. "description" : "Some flag, will appear in Main since it is required",
  1484. "required" : "yes"
  1485. },{
  1486. "name" : "b",
  1487. "description" : "pre-filled flag, will appear in options since it is not required",
  1488. "value" : True
  1489. },{
  1490. "name" : "hidden_flag",
  1491. "description" : "hidden flag, should not be changeable",
  1492. "hidden" : "yes",
  1493. "value" : True
  1494. }
  1495. ]
  1496. q=wx.LogNull()
  1497. GrassGUIApp( task ).MainLoop()