gselect.py 88 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338
  1. """
  2. @package gui_core.gselect
  3. @brief Custom control that selects elements
  4. Classes:
  5. - :class:`Select`
  6. - :class:`VectorSelect`
  7. - :class:`ListCtrlComboPopup`
  8. - :class:`TreeCrtlComboPopup`
  9. - :class:`VectorDBInfo`
  10. - :class:`LayerSelect`
  11. - :class:`DriverSelect`
  12. - :class:`DatabaseSelect`
  13. - :class:`TableSelect`
  14. - :class:`ColumnSelect`
  15. - :class:`DbaseSelect`
  16. - :class:`LocationSelect`
  17. - :class:`MapsetSelect`
  18. - :class:`SubGroupSelect`
  19. - :class:`FormatSelect`
  20. - :class:`GdalSelect`
  21. - :class:`ProjSelect`
  22. - :class:`ElementSelect`
  23. - :class:`OgrTypeSelect`
  24. - :class:`CoordinatesSelect`
  25. - :class:`SignatureSelect`
  26. - :class:`SeparatorSelect`
  27. (C) 2007-2014 by the GRASS Development Team
  28. This program is free software under the GNU General Public License
  29. (>=v2). Read the file COPYING that comes with GRASS for details.
  30. @author Michael Barton
  31. @author Martin Landa <landa.martin gmail.com>
  32. @author Vaclav Petras <wenzeslaus gmail.com> (menu customization)
  33. @author Stepan Turek <stepan.turek seznam.cz> (CoordinatesSelect, ListCtrlComboPopup)
  34. """
  35. import os
  36. import sys
  37. import glob
  38. import copy
  39. import wx
  40. import wx.combo
  41. import wx.lib.buttons as buttons
  42. import wx.lib.filebrowsebutton as filebrowse
  43. from core import globalvar
  44. import grass.script as grass
  45. from grass.script import task as gtask
  46. from grass.exceptions import CalledModuleError
  47. try:
  48. from grass.pygrass import messages
  49. except ImportError as e:
  50. print >> sys.stderr, _("Unable to import pyGRASS: %s\n"
  51. "Some functionality will be not accessible") % e
  52. from gui_core.widgets import ManageSettingsWidget, CoordinatesValidator
  53. from core.gcmd import RunCommand, GError, GMessage
  54. from core.utils import GetListOfLocations, GetListOfMapsets, \
  55. GetFormats, rasterFormatExtension, vectorFormatExtension
  56. from core.utils import GetSettingsPath, GetValidLayerName, ListSortLower
  57. from core.utils import GetVectorNumberOfLayers, _
  58. from core.settings import UserSettings
  59. from core.debug import Debug
  60. from grass.pydispatch.signal import Signal
  61. class Select(wx.combo.ComboCtrl):
  62. def __init__(self, parent, id = wx.ID_ANY, size = globalvar.DIALOG_GSELECT_SIZE,
  63. type = None, multiple = False, nmaps = 1,
  64. mapsets = None, updateOnPopup = True, onPopup = None,
  65. fullyQualified = True, extraItems = {}, layerTree = None,
  66. validator = wx.DefaultValidator):
  67. """Custom control to create a ComboBox with a tree control to
  68. display and select GIS elements within acessible mapsets.
  69. Elements can be selected with mouse. Can allow multiple
  70. selections, when argument <em>multiple</em> is True. Multiple
  71. selections are separated by commas.
  72. :param type: type of GIS elements ('raster, 'vector', ...)
  73. :param multiple: True for multiple input
  74. :param nmaps: number of maps to be entered
  75. :param mapsets: force list of mapsets (otherwise search path)
  76. :param updateOnPopup: True for updating list of elements on popup
  77. :param onPopup: function to be called on Popup
  78. :param fullyQualified: True to provide fully qualified names (map@mapset)
  79. :param extraItems: extra items to add (given as dictionary) - see gmodeler for usage
  80. :param layerTree: show only elements from given layer tree if not None
  81. :param validator: validator for TextCtrl
  82. """
  83. wx.combo.ComboCtrl.__init__(self, parent=parent, id=id, size=size, validator=validator)
  84. self.GetChildren()[0].SetName("Select")
  85. self.GetChildren()[0].type = type
  86. self.tcp = TreeCtrlComboPopup()
  87. self.SetPopupControl(self.tcp)
  88. self.SetPopupExtents(0, 100)
  89. if type:
  90. self.tcp.SetData(type = type, mapsets = mapsets,
  91. multiple = multiple, nmaps = nmaps,
  92. updateOnPopup = updateOnPopup, onPopup = onPopup,
  93. fullyQualified = fullyQualified, extraItems = extraItems, layerTree = layerTree)
  94. self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDown)
  95. def OnKeyDown(self, event):
  96. """Open popup and send key events to the tree."""
  97. if event.GetKeyCode() == wx.WXK_DOWN:
  98. self.ShowPopup()
  99. event.Skip()
  100. def SetElementList(self, type, mapsets = None):
  101. """Set element list
  102. :param type: GIS element type
  103. :param mapsets: list of acceptable mapsets (None for all in search path)
  104. """
  105. self.tcp.SetData(type = type, mapsets = mapsets)
  106. def GetElementList(self):
  107. """Load elements"""
  108. self.tcp.GetElementList()
  109. def SetType(self, etype, multiple = False, nmaps = 1,
  110. mapsets = None, updateOnPopup = True, onPopup = None):
  111. """Param set element type for widget
  112. :param etype: element type, see gselect.ElementSelect
  113. """
  114. self.tcp.SetData(type = etype, mapsets = mapsets,
  115. multiple = multiple, nmaps = nmaps,
  116. updateOnPopup = updateOnPopup, onPopup = onPopup)
  117. class VectorSelect(Select):
  118. def __init__(self, parent, ftype, **kwargs):
  119. """Custom to create a ComboBox with a tree control to display and
  120. select vector maps. You can filter the vector maps. If you
  121. don't need this feature use Select class instead
  122. :param ftype: filter vector maps based on feature type
  123. """
  124. Select.__init__(self, parent = parent, id = wx.ID_ANY,
  125. type = 'vector', **kwargs)
  126. self.ftype = ftype
  127. # remove vector maps which do not contain given feature type
  128. self.tcp.SetFilter(self._isElement)
  129. def _isElement(self, vectorName):
  130. """Check if element should be filtered out"""
  131. try:
  132. if int(grass.vector_info_topo(vectorName)[self.ftype]) < 1:
  133. return False
  134. except KeyError:
  135. return False
  136. return True
  137. class ListCtrlComboPopup(wx.combo.ComboPopup):
  138. """Create a list ComboBox using TreeCtrl with hidden root.
  139. .. todo::
  140. use event.EventObject instead of hardcoding (see forms.py)
  141. https://groups.google.com/forum/#!topic/wxpython-users/pRz6bi0k0XY
  142. """
  143. # overridden ComboPopup methods
  144. def Init(self):
  145. self.value = [] # for multiple is False ->
  146. # len(self.value) in [0,1]
  147. self.curitem = None
  148. self.multiple = False
  149. self.updateOnPopup = True
  150. self.filterItems = [] # limit items based on this list,
  151. # see layerTree parameter
  152. def Create(self, parent):
  153. self.seltree = wx.TreeCtrl(parent, style=wx.TR_HIDE_ROOT
  154. |wx.TR_HAS_BUTTONS
  155. |wx.TR_SINGLE
  156. |wx.TR_LINES_AT_ROOT
  157. |wx.SIMPLE_BORDER
  158. |wx.TR_FULL_ROW_HIGHLIGHT)
  159. self.seltree.Bind(wx.EVT_MOTION, self.OnMotion)
  160. self.seltree.Bind(wx.EVT_LEFT_DOWN, self.OnLeftDown)
  161. # the following dummy handler are needed to keep tree events
  162. # from propagating up to the parent GIS Manager layer tree
  163. self.seltree.Bind(wx.EVT_TREE_ITEM_EXPANDING, lambda x: None)
  164. self.seltree.Bind(wx.EVT_TREE_ITEM_COLLAPSED, lambda x: None)
  165. self.seltree.Bind(wx.EVT_TREE_SEL_CHANGED, lambda x: None)
  166. self.seltree.Bind(wx.EVT_TREE_DELETE_ITEM, lambda x: None)
  167. self.seltree.Bind(wx.EVT_TREE_BEGIN_DRAG, lambda x: None)
  168. self.seltree.Bind(wx.EVT_TREE_ITEM_RIGHT_CLICK, lambda x: None)
  169. # navigation in list/tree is handled automatically since wxPython 3
  170. # for older versions, we have to workaround it and write our own navigation
  171. if globalvar.CheckWxVersion(version=[3]):
  172. self.seltree.Bind(wx.EVT_TREE_ITEM_ACTIVATED, self._onItemConfirmed)
  173. self.seltree.Bind(wx.EVT_TREE_KEY_DOWN, self._onDismissPopup)
  174. else:
  175. self.seltree.Bind(wx.EVT_TREE_ITEM_ACTIVATED, lambda x: None)
  176. self.seltree.Bind(wx.EVT_KEY_UP, self.OnKeyUp)
  177. def GetControl(self):
  178. return self.seltree
  179. def GetStringValue(self):
  180. """Get value as a string separated by commas
  181. """
  182. return ','.join(self.value)
  183. def SetStringValue(self, value):
  184. # this assumes that item strings are unique...
  185. root = self.seltree.GetRootItem()
  186. if not root:
  187. return
  188. winValue = self.GetCombo().GetValue().strip(',')
  189. self.value = []
  190. if winValue:
  191. self.value = winValue.split(',')
  192. def OnPopup(self, force = False):
  193. """Limited only for first selected
  194. """
  195. if not force and not self.updateOnPopup:
  196. return
  197. # selects map starting according to written text
  198. inputText = self.GetCombo().GetValue().strip()
  199. if inputText:
  200. root = self.seltree.GetRootItem()
  201. match = self.FindItem(root, inputText, startLetters = True)
  202. self.seltree.EnsureVisible(match)
  203. self.seltree.SelectItem(match)
  204. def GetAdjustedSize(self, minWidth, prefHeight, maxHeight):
  205. """Reads UserSettings to get height (which was 200 in old implementation).
  206. """
  207. height = UserSettings.Get(group = 'appearance', key = 'gSelectPopupHeight', subkey = 'value')
  208. return wx.Size(minWidth, min(height, maxHeight))
  209. def FindItem(self, parentItem, text, startLetters = False):
  210. """Finds item with given name or starting with given text
  211. """
  212. startletters = startLetters
  213. item, cookie = self.seltree.GetFirstChild(parentItem)
  214. while wx.TreeItemId.IsOk(item):
  215. if self.seltree.GetItemText(item) == text:
  216. return item
  217. if self.seltree.ItemHasChildren(item):
  218. item = self.FindItem(item, text, startLetters = startletters)
  219. if wx.TreeItemId.IsOk(item):
  220. return item
  221. elif startletters and self.seltree.GetItemText(item).startswith(text.split('@', 1)[0]):
  222. return item
  223. item, cookie = self.seltree.GetNextChild(parentItem, cookie)
  224. return wx.TreeItemId()
  225. def AddItem(self, value):
  226. root = self.seltree.GetRootItem()
  227. if not root:
  228. root = self.seltree.AddRoot("<hidden root>")
  229. self.seltree.AppendItem(root, text = value)
  230. def SetItems(self, items):
  231. root = self.seltree.GetRootItem()
  232. if not root:
  233. root = self.seltree.AddRoot("<hidden root>")
  234. for item in items:
  235. self.seltree.AppendItem(root, text = item)
  236. def OnKeyUp(self, event):
  237. """Enable to select items using keyboard.
  238. Unused with wxPython 3, can be removed in the future.
  239. """
  240. item = self.seltree.GetSelection()
  241. if event.GetKeyCode() == wx.WXK_DOWN:
  242. self.seltree.SelectItem(self.seltree.GetNextVisible(item))
  243. elif event.GetKeyCode() == wx.WXK_UP:
  244. itemPrev = self.seltree.GetPrevSibling(item)
  245. self.seltree.SelectItem(itemPrev)
  246. elif event.GetKeyCode() == wx.WXK_ESCAPE:
  247. self.Dismiss()
  248. elif event.GetKeyCode() == wx.WXK_RETURN:
  249. self.seltree.SelectItem(item)
  250. self.curitem = item
  251. self._selectTreeItem(item)
  252. self.Dismiss()
  253. def _onDismissPopup(self, event):
  254. """Hide popup without selecting item on Esc"""
  255. if event.GetKeyCode() == wx.WXK_ESCAPE:
  256. self.Dismiss()
  257. else:
  258. event.Skip()
  259. def _selectTreeItem(self, item):
  260. item_str = self.seltree.GetItemText(item)
  261. if self.multiple:
  262. if item_str not in self.value:
  263. self.value.append(item_str)
  264. else:
  265. self.value = [item_str]
  266. def _onItemConfirmed(self, event):
  267. item = event.GetItem()
  268. self._selectTreeItem(item)
  269. self.Dismiss()
  270. def OnMotion(self, evt):
  271. """Have the selection follow the mouse, like in a real combobox
  272. """
  273. item, flags = self.seltree.HitTest(evt.GetPosition())
  274. if item and flags & wx.TREE_HITTEST_ONITEMLABEL:
  275. self.seltree.SelectItem(item)
  276. self.curitem = item
  277. evt.Skip()
  278. def OnLeftDown(self, evt):
  279. """Do the combobox selection
  280. """
  281. if self.curitem is None:
  282. return
  283. self._selectTreeItem(self.curitem)
  284. self.Dismiss()
  285. evt.Skip()
  286. def SetData(self, **kargs):
  287. """Set object properties"""
  288. if 'multiple' in kargs:
  289. self.multiple = kargs['multiple']
  290. if 'onPopup' in kargs:
  291. self.onPopup = kargs['onPopup']
  292. if kargs.get('layerTree', None):
  293. self.filterItems = [] # reset
  294. ltype = kargs['type']
  295. for layer in kargs['layerTree'].GetVisibleLayers(skipDigitized = True):
  296. if layer.GetType() != ltype:
  297. continue
  298. self.filterItems.append(layer.GetName())
  299. def DeleteAllItems(self):
  300. """Delete all items in popup"""
  301. self.seltree.DeleteAllItems()
  302. class TreeCtrlComboPopup(ListCtrlComboPopup):
  303. """Create a tree ComboBox for selecting maps and other GIS elements
  304. in accessible mapsets within the current location
  305. """
  306. # overridden ComboPopup methods
  307. def Init(self):
  308. ListCtrlComboPopup.Init(self)
  309. self.nmaps = 1
  310. self.type = None
  311. self.mapsets = None
  312. self.onPopup = None
  313. self.fullyQualified = True
  314. self.extraItems = dict()
  315. self.SetFilter(None)
  316. self.tgis_error = False
  317. def SetFilter(self, filter):
  318. """Set filter for GIS elements, see e.g. VectorSelect"""
  319. self.filterElements = filter
  320. def OnPopup(self, force = False):
  321. """Limited only for first selected"""
  322. if not force and not self.updateOnPopup:
  323. return
  324. if self.onPopup:
  325. selected, exclude = self.onPopup(self.type)
  326. else:
  327. selected = None
  328. exclude = False
  329. self.GetElementList(selected, exclude)
  330. ListCtrlComboPopup.OnPopup(self, force)
  331. def GetElementList(self, elements = None, exclude = False):
  332. """Get filtered list of GIS elements in accessible mapsets
  333. and display as tree with all relevant elements displayed
  334. beneath each mapset branch
  335. """
  336. # update list
  337. self.seltree.DeleteAllItems()
  338. self._getElementList(self.type, self.mapsets, elements, exclude)
  339. if len(self.value) > 0:
  340. root = self.seltree.GetRootItem()
  341. if not root:
  342. return
  343. item = self.FindItem(root, self.value[0])
  344. try:
  345. self.seltree.EnsureVisible(item)
  346. self.seltree.SelectItem(item)
  347. except:
  348. pass
  349. def _getElementList(self, element, mapsets = None, elements = None, exclude = False):
  350. """Get list of GIS elements in accessible mapsets and display as tree
  351. with all relevant elements displayed beneath each mapset branch
  352. :param element: GIS element
  353. :param mapsets: list of acceptable mapsets (None for all mapsets in search path)
  354. :param elements: list of forced GIS elements
  355. :param exclude: True to exclude, False for forcing the list (elements)
  356. """
  357. # get current mapset
  358. curr_mapset = grass.gisenv()['MAPSET']
  359. # map element types to g.list types
  360. elementdict = {'cell':'raster',
  361. 'raster': 'raster',
  362. 'raster files':'raster',
  363. 'grid3':'3draster',
  364. '3draster':'3draster',
  365. '3d-raster':'3draster',
  366. 'raster3D':'3draster',
  367. 'raster3D files':'3draster',
  368. 'vector' : 'vector',
  369. 'binary vector files':'vector',
  370. 'dig':'oldvect',
  371. 'oldvect':'oldvector',
  372. 'old vector':'oldvector',
  373. 'dig_ascii':'asciivector',
  374. 'asciivect':'asciivector',
  375. 'asciivector':'asciivector',
  376. 'ascii vector files':'asciivector',
  377. 'icons':'icon',
  378. 'icon':'icon',
  379. 'paint icon files':'icon',
  380. 'paint/labels':'labels',
  381. 'labels':'labels',
  382. 'label':'labels',
  383. 'paint label files':'labels',
  384. 'windows':'region',
  385. 'region':'region',
  386. 'region definition':'region',
  387. 'region definition files':'region',
  388. 'windows3d':'region3d',
  389. 'region3d':'region3d',
  390. 'region3D definition':'region3d',
  391. 'region3D definition files':'region3d',
  392. 'group':'group',
  393. 'imagery group':'group',
  394. 'imagery group files':'group',
  395. 'stds':'stds',
  396. 'strds':'strds',
  397. 'str3ds':'str3ds',
  398. 'stvds':'stvds'}
  399. # to support multiple elements
  400. element_list = element.split(',')
  401. renamed_elements = []
  402. for elem in element_list:
  403. if elem not in elementdict:
  404. self.AddItem(_('Not selectable element'), node = False)
  405. return
  406. else:
  407. renamed_elements.append(elementdict[elem])
  408. if element in ('stds', 'strds', 'str3ds', 'stvds'):
  409. if self.tgis_error is False:
  410. import grass.temporal as tgis
  411. filesdict = tgis.tlist_grouped(elementdict[element], element == 'stds')
  412. else:
  413. filesdict = None
  414. else:
  415. filesdict = grass.list_grouped(renamed_elements,
  416. check_search_path=False)
  417. # add extra items first
  418. if self.extraItems:
  419. for group, items in self.extraItems.iteritems():
  420. node = self.AddItem(group, node = True)
  421. self.seltree.SetItemTextColour(node, wx.Colour(50, 50, 200))
  422. for item in items:
  423. self.AddItem(item, node = False, parent = node)
  424. self.seltree.ExpandAllChildren(node)
  425. # list of mapsets in current location
  426. if mapsets is None:
  427. mapsets = grass.mapsets(search_path = True)
  428. # current mapset first
  429. if curr_mapset in mapsets and mapsets[0] != curr_mapset:
  430. mapsets.remove(curr_mapset)
  431. mapsets.insert(0, curr_mapset)
  432. first_mapset = None
  433. for mapset in mapsets:
  434. mapset_node = self.AddItem(_('Mapset') + ': ' + mapset, node = True, mapset = mapset)
  435. node = mapset_node
  436. if not first_mapset:
  437. first_mapset = mapset_node
  438. self.seltree.SetItemTextColour(mapset_node, wx.Colour(50, 50, 200))
  439. if mapset not in filesdict:
  440. continue
  441. try:
  442. if type(filesdict[mapset]) == dict:
  443. for elementType in filesdict[mapset].keys():
  444. node = self.AddItem(_('Type: ') + elementType, mapset = mapset,
  445. node = True, parent = mapset_node)
  446. self.seltree.SetItemTextColour(node, wx.Colour(50, 50, 200))
  447. elem_list = filesdict[mapset][elementType]
  448. self._addItems(elist = elem_list, elements = elements,
  449. mapset = mapset, exclude = exclude, node = node)
  450. else:
  451. elem_list = filesdict[mapset]
  452. self._addItems(elist = elem_list, elements = elements,
  453. mapset = mapset, exclude = exclude, node = node)
  454. except StandardError as e:
  455. sys.stderr.write(_("GSelect: invalid item: %s") % e)
  456. continue
  457. if self.seltree.ItemHasChildren(mapset_node):
  458. sel = UserSettings.Get(group='appearance', key='elementListExpand',
  459. subkey='selection')
  460. collapse = True
  461. if sel == 0: # collapse all except PERMANENT and current
  462. if mapset in ('PERMANENT', curr_mapset):
  463. collapse = False
  464. elif sel == 1: # collapse all except PERMANENT
  465. if mapset == 'PERMANENT':
  466. collapse = False
  467. elif sel == 2: # collapse all except current
  468. if mapset == curr_mapset:
  469. collapse = False
  470. elif sel == 3: # collapse all
  471. pass
  472. elif sel == 4: # expand all
  473. collapse = False
  474. if collapse:
  475. self.seltree.CollapseAllChildren(mapset_node)
  476. else:
  477. self.seltree.ExpandAllChildren(mapset_node)
  478. if first_mapset:
  479. # select first mapset (MSW hack)
  480. self.seltree.SelectItem(first_mapset)
  481. # helpers
  482. def _addItems(self, elist, elements, mapset, exclude, node):
  483. """Helper function for adding multiple items (maps, stds).
  484. :param list elist: list of map/stds names
  485. :param list elements: list of forced elements
  486. :param str mapset: mapset name
  487. :param exclude: True to exclude, False for forcing the list
  488. :param node: parent node
  489. """
  490. elist.sort()
  491. for elem in elist:
  492. if elem != '':
  493. fullqElem = elem + '@' + mapset
  494. if self.filterItems and fullqElem not in self.filterItems:
  495. continue # skip items missed in self.filterItems
  496. if elements is not None:
  497. if (exclude and fullqElem in elements) or \
  498. (not exclude and fullqElem not in elements):
  499. continue
  500. if self.filterElements:
  501. if self.filterElements(fullqElem):
  502. self.AddItem(elem, mapset = mapset, node = False, parent = node)
  503. else:
  504. self.AddItem(elem, mapset = mapset, node = False, parent = node)
  505. def AddItem(self, value, mapset = None, node = True, parent = None):
  506. if not parent:
  507. root = self.seltree.GetRootItem()
  508. if not root:
  509. root = self.seltree.AddRoot("<hidden root>")
  510. parent = root
  511. data = {'node': node, 'mapset': mapset}
  512. item = self.seltree.AppendItem(parent, text = value, data = wx.TreeItemData(data))
  513. return item
  514. def OnKeyUp(self, event):
  515. """Enables to select items using keyboard
  516. Unused with wxPython 3, can be removed in the future.
  517. """
  518. item = self.seltree.GetSelection()
  519. if event.GetKeyCode() == wx.WXK_DOWN:
  520. self.seltree.SelectItem(self.seltree.GetNextVisible(item))
  521. # problem with GetPrevVisible
  522. elif event.GetKeyCode() == wx.WXK_UP:
  523. if self.seltree.ItemHasChildren(item) and self.seltree.IsExpanded(self.seltree.GetPrevSibling(item)):
  524. itemPrev = self.seltree.GetLastChild(self.seltree.GetPrevSibling(item))
  525. else:
  526. itemPrev = self.seltree.GetPrevSibling(item)
  527. if not wx.TreeItemId.IsOk(itemPrev):
  528. itemPrev = self.seltree.GetItemParent(item)
  529. if item == self.seltree.GetFirstChild(self.seltree.GetRootItem())[0]:
  530. itemPrev = item
  531. self.seltree.SelectItem(itemPrev)
  532. # selects first item starting with the written text in next mapset
  533. elif event.GetKeyCode() == wx.WXK_TAB:
  534. selected = self.seltree.GetSelection()
  535. if self.seltree.ItemHasChildren(selected):
  536. parent = selected
  537. else:
  538. parent = self.seltree.GetItemParent(selected)
  539. nextSibling = self.seltree.GetNextSibling(parent)
  540. if wx.TreeItemId.IsOk(nextSibling):
  541. match = self.FindItem(nextSibling, self.GetCombo().GetValue().strip(), True)
  542. else:
  543. match = self.FindItem(self.seltree.GetFirstChild(self.seltree.GetItemParent(parent))[0],
  544. self.GetCombo().GetValue().strip(), True)
  545. self.seltree.SelectItem(match)
  546. elif event.GetKeyCode() == wx.WXK_RIGHT:
  547. if self.seltree.ItemHasChildren(item):
  548. self.seltree.Expand(item)
  549. elif event.GetKeyCode() == wx.WXK_LEFT:
  550. if self.seltree.ItemHasChildren(item):
  551. self.seltree.Collapse(item)
  552. elif event.GetKeyCode() == wx.WXK_ESCAPE:
  553. self.Dismiss()
  554. elif event.GetKeyCode() == wx.WXK_RETURN:
  555. if self.seltree.GetPyData(item)['node']:
  556. self.value = []
  557. else:
  558. self._selectTreeItem(item)
  559. self.Dismiss()
  560. def OnLeftDown(self, evt):
  561. """Do the combobox selection
  562. """
  563. item, flags = self.seltree.HitTest(evt.GetPosition())
  564. if item and flags & wx.TREE_HITTEST_ONITEMLABEL:
  565. self.curitem = item
  566. if self.seltree.GetPyData(item)['node']:
  567. evt.Skip()
  568. return
  569. self._selectTreeItem(item)
  570. self.Dismiss()
  571. evt.Skip()
  572. def _selectTreeItem(self, item):
  573. fullName = self.seltree.GetItemText(item)
  574. if self.fullyQualified and self.seltree.GetPyData(item)['mapset']:
  575. fullName += '@' + self.seltree.GetPyData(item)['mapset']
  576. if self.multiple:
  577. self.value.append(fullName)
  578. else:
  579. if self.nmaps > 1: # see key_desc
  580. if len(self.value) >= self.nmaps:
  581. self.value = [fullName]
  582. else:
  583. self.value.append(fullName)
  584. else:
  585. self.value = [fullName]
  586. def _onItemConfirmed(self, event):
  587. item = event.GetItem()
  588. if self.seltree.GetPyData(item)['node']:
  589. self.value = []
  590. else:
  591. self._selectTreeItem(item)
  592. self.Dismiss()
  593. def SetData(self, **kargs):
  594. """Set object properties"""
  595. ListCtrlComboPopup.SetData(self, **kargs)
  596. if 'type' in kargs:
  597. self.type = kargs['type']
  598. if self.type in ('stds', 'strds', 'str3ds', 'stvds'):
  599. # Initiate the temporal framework. Catch database error
  600. # and set the error flag for the stds listing.
  601. import grass.temporal as tgis
  602. try:
  603. tgis.init(True)
  604. except messages.FatalError as e:
  605. sys.stderr.write("Temporal GIS error:\n%s" % e)
  606. self.tgis_error = True
  607. if 'mapsets' in kargs:
  608. self.mapsets = kargs['mapsets']
  609. if 'nmaps' in kargs:
  610. self.nmaps = kargs['nmaps']
  611. if 'updateOnPopup' in kargs:
  612. self.updateOnPopup = kargs['updateOnPopup']
  613. if 'fullyQualified' in kargs:
  614. self.fullyQualified = kargs['fullyQualified']
  615. if 'extraItems' in kargs:
  616. self.extraItems = kargs['extraItems']
  617. def GetType(self):
  618. """Get element type
  619. """
  620. return self.type
  621. class VectorDBInfo:
  622. """Class providing information about attribute tables
  623. linked to a vector map"""
  624. def __init__(self, map):
  625. self.map = map
  626. # dictionary of layer number and associated (driver, database, table)
  627. self.layers = {}
  628. # dictionary of table and associated columns (type, length, values, ids)
  629. self.tables = {}
  630. if not self._CheckDBConnection(): # -> self.layers
  631. return
  632. self._DescribeTables() # -> self.tables
  633. def _CheckDBConnection(self):
  634. """Check DB connection"""
  635. nuldev = file(os.devnull, 'w+')
  636. # if map is not defined (happens with vnet initialization) or it doesn't exist
  637. try:
  638. self.layers = grass.vector_db(map=self.map, stderr=nuldev)
  639. except CalledModuleError:
  640. return False
  641. finally: # always close nuldev
  642. nuldev.close()
  643. return bool(len(self.layers.keys()) > 0)
  644. def _DescribeTables(self):
  645. """Describe linked tables"""
  646. for layer in self.layers.keys():
  647. # determine column names and types
  648. table = self.layers[layer]["table"]
  649. columns = {} # {name: {type, length, [values], [ids]}}
  650. i = 0
  651. Debug.msg(1, "gselect.VectorDBInfo._DescribeTables(): table=%s driver=%s database=%s" % \
  652. (self.layers[layer]["table"], self.layers[layer]["driver"],
  653. self.layers[layer]["database"]))
  654. for item in grass.db_describe(table = self.layers[layer]["table"],
  655. driver = self.layers[layer]["driver"],
  656. database = self.layers[layer]["database"])['cols']:
  657. name, type, length = item
  658. # FIXME: support more datatypes
  659. if type.lower() == "integer":
  660. ctype = int
  661. elif type.lower() == "double precision":
  662. ctype = float
  663. else:
  664. ctype = str
  665. columns[name.strip()] = { 'index' : i,
  666. 'type' : type.lower(),
  667. 'ctype' : ctype,
  668. 'length' : int(length),
  669. 'values' : [],
  670. 'ids' : []}
  671. i += 1
  672. # check for key column
  673. # v.db.connect -g/p returns always key column name lowercase
  674. if self.layers[layer]["key"] not in columns.keys():
  675. for col in columns.keys():
  676. if col.lower() == self.layers[layer]["key"]:
  677. self.layers[layer]["key"] = col.upper()
  678. break
  679. self.tables[table] = columns
  680. return True
  681. def Reset(self):
  682. """Reset"""
  683. for layer in self.layers:
  684. table = self.layers[layer]["table"] # get table desc
  685. for name in self.tables[table].keys():
  686. self.tables[table][name]['values'] = []
  687. self.tables[table][name]['ids'] = []
  688. def GetName(self):
  689. """Get vector name"""
  690. return self.map
  691. def GetKeyColumn(self, layer):
  692. """Get key column of given layer
  693. :param layer: vector layer number
  694. """
  695. return str(self.layers[layer]['key'])
  696. def GetTable(self, layer):
  697. """Get table name of given layer
  698. :param layer: vector layer number
  699. """
  700. return self.layers[layer]['table']
  701. def GetDbSettings(self, layer):
  702. """Get database settins
  703. :param layer: layer number
  704. :return: (driver, database)
  705. """
  706. return self.layers[layer]['driver'], self.layers[layer]['database']
  707. def GetTableDesc(self, table):
  708. """Get table columns
  709. :param table: table name
  710. """
  711. return self.tables[table]
  712. class LayerSelect(wx.ComboBox):
  713. def __init__(self, parent, id = wx.ID_ANY,
  714. size = globalvar.DIALOG_COMBOBOX_SIZE,
  715. vector = None, dsn = None, choices = [], all = False, default = None):
  716. """Creates combo box for selecting vector map layer names
  717. :param str vector: vector map name (native or connected via v.external)
  718. :param str dsn: OGR data source name
  719. """
  720. super(LayerSelect, self).__init__(parent, id, size = size, choices = choices)
  721. self.all = all
  722. self.SetName("LayerSelect")
  723. # default value
  724. self.default = default
  725. self.InsertLayers(vector = vector, dsn = dsn)
  726. def InsertLayers(self, vector = None, dsn = None):
  727. """Insert layers for a vector into the layer combobox
  728. :param str vector: vector map name (native or connected via v.external)
  729. :param str dsn: OGR data source name
  730. """
  731. layers = list()
  732. if vector:
  733. layers = GetVectorNumberOfLayers(vector)
  734. elif dsn:
  735. ret = RunCommand('v.in.ogr',
  736. read = True,
  737. quiet = True,
  738. flags = 'l',
  739. dsn = dsn)
  740. if ret:
  741. layers = ret.splitlines()
  742. if self.default:
  743. if len(layers) == 0:
  744. layers.insert(0, str(self.default))
  745. elif self.default not in layers:
  746. layers.append(self.default)
  747. if self.all:
  748. layers.insert(0, '-1')
  749. if len(layers) > 0:
  750. self.SetItems(layers)
  751. else:
  752. self.Clear()
  753. self.SetValue("")
  754. if self.default and self.default in layers:
  755. self.SetValue(self.default)
  756. class DriverSelect(wx.ComboBox):
  757. """Creates combo box for selecting database driver.
  758. """
  759. def __init__(self, parent, choices, value,
  760. id=wx.ID_ANY, pos=wx.DefaultPosition,
  761. size=globalvar.DIALOG_LAYER_SIZE, **kargs):
  762. super(DriverSelect, self).__init__(parent, id, value, pos, size,
  763. choices, style=wx.CB_READONLY)
  764. self.SetName("DriverSelect")
  765. self.SetStringSelection(value)
  766. class DatabaseSelect(wx.TextCtrl):
  767. """Creates combo box for selecting database driver.
  768. """
  769. def __init__(self, parent, value = '', id = wx.ID_ANY,
  770. size = globalvar.DIALOG_TEXTCTRL_SIZE, **kargs):
  771. super(DatabaseSelect, self).__init__(parent, id, value, size = size, **kargs)
  772. self.SetName("DatabaseSelect")
  773. class TableSelect(wx.ComboBox):
  774. """Creates combo box for selecting attribute tables from the database
  775. """
  776. def __init__(self, parent,
  777. id = wx.ID_ANY, value = '',
  778. size = globalvar.DIALOG_COMBOBOX_SIZE, choices = [], **kargs):
  779. super(TableSelect, self).__init__(parent, id, value, size = size, choices = choices,
  780. style = wx.CB_READONLY, **kargs)
  781. self.SetName("TableSelect")
  782. if not choices:
  783. self.InsertTables()
  784. def InsertTables(self, driver = None, database = None):
  785. """Insert attribute tables into combobox"""
  786. items = []
  787. if not driver or not database:
  788. connect = grass.db_connection()
  789. driver = connect['driver']
  790. database = connect['database']
  791. ret = RunCommand('db.tables',
  792. flags = 'p',
  793. read = True,
  794. driver = driver,
  795. database = database)
  796. if ret:
  797. for table in ret.splitlines():
  798. items.append(table)
  799. self.SetItems(items)
  800. self.SetValue('')
  801. class ColumnSelect(wx.combo.ComboCtrl):
  802. """Creates combo box for selecting columns in the attribute table
  803. for a vector map.
  804. :param parent: window parent
  805. :param id: window id
  806. :param value: default value
  807. :param size: window size
  808. :param str vector: vector map name
  809. :param layer: layer number
  810. :param multiple: True if it is possible to add multiple columns
  811. :param param: parameters list (see menuform.py)
  812. :param kwags: wx.ComboBox parameters
  813. """
  814. def __init__(self, parent, id = wx.ID_ANY, value = '',
  815. size = globalvar.DIALOG_COMBOBOX_SIZE,
  816. vector = None, layer = 1, multiple = False,
  817. param = None, **kwargs):
  818. self.defaultValue = value
  819. self.param = param
  820. self.columns = []
  821. wx.combo.ComboCtrl.__init__(self, parent, id, size=size, **kwargs)
  822. self.GetChildren()[0].SetName("ColumnSelect")
  823. self.GetChildren()[0].type = type
  824. self.tcp = ListCtrlComboPopup()
  825. self.SetPopupControl(self.tcp)
  826. self.tcp.SetData(multiple = multiple)
  827. if vector:
  828. self.InsertColumns(vector, layer)
  829. self.GetChildren()[0].Bind(wx.EVT_KEY_UP, self.OnKeyUp)
  830. def GetColumns(self):
  831. return self.columns
  832. def OnKeyUp(self, event):
  833. """Shows popupwindow if down arrow key is released"""
  834. if event.GetKeyCode() == wx.WXK_DOWN and not self.IsPopupShown():
  835. self.ShowPopup()
  836. else:
  837. event.Skip()
  838. def Clear(self):
  839. self.tcp.DeleteAllItems()
  840. self.SetValue('')
  841. def InsertColumns(self, vector, layer, excludeKey = False, excludeCols = None, type = None, dbInfo = None):
  842. """Insert columns for a vector attribute table into the columns combobox
  843. :param str vector: vector name
  844. :param int layer: vector layer number
  845. :param excludeKey: exclude key column from the list?
  846. :param excludeCols: list of columns to be removed from the list
  847. :param type: only columns of given type (given as list)
  848. """
  849. if not dbInfo:
  850. dbInfo = VectorDBInfo(vector)
  851. try:
  852. try:
  853. layer = int(layer)
  854. except TypeError:
  855. # assuming layer 1
  856. layer = 1
  857. table = dbInfo.GetTable(layer)
  858. columnchoices = dbInfo.GetTableDesc(table)
  859. keyColumn = dbInfo.GetKeyColumn(layer)
  860. self.columns = len(columnchoices.keys()) * ['']
  861. for key, val in columnchoices.iteritems():
  862. self.columns[val['index']] = key
  863. if excludeKey: # exclude key column
  864. self.columns.remove(keyColumn)
  865. if excludeCols: # exclude key column
  866. for key in columnchoices.iterkeys():
  867. if key in excludeCols:
  868. self.columns.remove(key)
  869. if type: # only selected column types
  870. for key, value in columnchoices.iteritems():
  871. if value['type'] not in type:
  872. try:
  873. self.columns.remove(key)
  874. except ValueError:
  875. pass
  876. except (KeyError, ValueError):
  877. self.columns[:] = []
  878. # update list
  879. self.tcp.DeleteAllItems()
  880. for col in self.columns:
  881. self.tcp.AddItem(col)
  882. self.SetValue(self.defaultValue)
  883. if self.param:
  884. value = self.param.get('value', '')
  885. if value != '' and value in self.columns:
  886. self.SetValue(value)
  887. def InsertTableColumns(self, table, driver=None, database=None):
  888. """Insert table columns
  889. :param str table: table name
  890. :param str driver: driver name
  891. :param str database: database name
  892. """
  893. self.columns[:] = []
  894. ret = RunCommand('db.columns',
  895. read = True,
  896. driver = driver,
  897. database = database,
  898. table = table)
  899. if ret:
  900. self.columns = ret.splitlines()
  901. # update list
  902. self.tcp.DeleteAllItems()
  903. self.SetValue(self.defaultValue)
  904. for col in self.columns:
  905. self.tcp.AddItem(col)
  906. if self.param:
  907. value = self.param.get('value', '')
  908. if value != '' and value in self.columns:
  909. self.SetValue(value)
  910. class DbaseSelect(wx.lib.filebrowsebutton.DirBrowseButton):
  911. """Widget for selecting GRASS Database"""
  912. def __init__(self, parent, **kwargs):
  913. super(DbaseSelect, self).__init__(parent, id = wx.ID_ANY,
  914. size = globalvar.DIALOG_GSELECT_SIZE, labelText = '',
  915. dialogTitle = _('Choose GIS Data Directory'),
  916. buttonText = _('Browse'),
  917. startDirectory = grass.gisenv()['GISDBASE'],
  918. **kwargs)
  919. class LocationSelect(wx.ComboBox):
  920. """Widget for selecting GRASS location"""
  921. def __init__(self, parent, id = wx.ID_ANY, size = globalvar.DIALOG_COMBOBOX_SIZE,
  922. gisdbase = None, **kwargs):
  923. super(LocationSelect, self).__init__(parent, id, size = size,
  924. style = wx.CB_READONLY, **kwargs)
  925. self.SetName("LocationSelect")
  926. if not gisdbase:
  927. self.gisdbase = grass.gisenv()['GISDBASE']
  928. else:
  929. self.gisdbase = gisdbase
  930. self.SetItems(GetListOfLocations(self.gisdbase))
  931. def UpdateItems(self, dbase):
  932. """Update list of locations
  933. :param str dbase: path to GIS database
  934. """
  935. self.gisdbase = dbase
  936. if dbase:
  937. self.SetItems(GetListOfLocations(self.gisdbase))
  938. else:
  939. self.SetItems([])
  940. class MapsetSelect(wx.combo.ComboCtrl):
  941. """Widget for selecting GRASS mapset"""
  942. def __init__(self, parent, id = wx.ID_ANY, size = globalvar.DIALOG_COMBOBOX_SIZE,
  943. gisdbase = None, location = None, setItems = True,
  944. searchPath = False, new = False, skipCurrent = False, multiple = False, **kwargs):
  945. style = 0
  946. ### disabled, read-only widget has no TextCtrl children (TODO: rewrite)
  947. ### if not new and not multiple:
  948. ### style = wx.CB_READONLY
  949. wx.combo.ComboCtrl.__init__(self, parent, id, size = size,
  950. style = style, **kwargs)
  951. self.searchPath = searchPath
  952. self.skipCurrent = skipCurrent
  953. self.SetName("MapsetSelect")
  954. if not gisdbase:
  955. self.gisdbase = grass.gisenv()['GISDBASE']
  956. else:
  957. self.gisdbase = gisdbase
  958. if not location:
  959. self.location = grass.gisenv()['LOCATION_NAME']
  960. else:
  961. self.location = location
  962. self.tcp = ListCtrlComboPopup()
  963. self.SetPopupControl(self.tcp)
  964. self.tcp.SetData(multiple = multiple)
  965. if setItems:
  966. self.tcp.SetItems(self._getMapsets())
  967. def UpdateItems(self, location, dbase = None):
  968. """Update list of mapsets for given location
  969. :param str dbase: path to GIS database (None to use currently
  970. selected)
  971. :param str location: name of location
  972. """
  973. if dbase:
  974. self.gisdbase = dbase
  975. self.location = location
  976. self.tcp.DeleteAllItems()
  977. if location:
  978. self.tcp.SetItems(self._getMapsets())
  979. else:
  980. self.tcp.SetItems([])
  981. def _getMapsets(self):
  982. if self.searchPath:
  983. mlist = RunCommand('g.mapsets',
  984. read = True, flags = 'p',
  985. sep = 'newline').splitlines()
  986. else:
  987. mlist = GetListOfMapsets(self.gisdbase, self.location,
  988. selectable = False)
  989. gisenv = grass.gisenv()
  990. if self.skipCurrent and \
  991. gisenv['LOCATION_NAME'] == self.location and \
  992. gisenv['MAPSET'] in mlist:
  993. mlist.remove(gisenv['MAPSET'])
  994. return mlist
  995. def GetStringSelection(self):
  996. """For backward compatibility. MapsetSelect changed to allow
  997. multiple selection, this required to change super-class from
  998. wx.ComboBox to wx.combo.ComboCtrl"""
  999. return self.GetValue()
  1000. def SetStringSelection(self, text):
  1001. """For backward compatibility. MapsetSelect changed to allow
  1002. multiple selection, this required to change super-class from
  1003. wx.ComboBox to wx.combo.ComboCtrl"""
  1004. return self.SetValue(text)
  1005. def SetSelection(self, sel=0):
  1006. """For backward compatibility. MapsetSelect changed to allow
  1007. multiple selection, this required to change super-class from
  1008. wx.ComboBox to wx.combo.ComboCtrl"""
  1009. self.SetValue('') # TODO: implement SetSelection()
  1010. def SetItems(self, items):
  1011. """For backward compatibility. MapsetSelect changed to allow
  1012. multiple selection, this required to change super-class from
  1013. wx.ComboBox to wx.combo.ComboCtrl"""
  1014. self.tcp.DeleteAllItems()
  1015. self.tcp.SetItems(items)
  1016. class SubGroupSelect(wx.ComboBox):
  1017. """Widget for selecting subgroups"""
  1018. def __init__(self, parent, id = wx.ID_ANY, size = globalvar.DIALOG_GSELECT_SIZE,
  1019. **kwargs):
  1020. super(SubGroupSelect, self).__init__(parent, id, size = size,
  1021. **kwargs)
  1022. self.SetName("SubGroupSelect")
  1023. def Insert(self, group):
  1024. """Insert subgroups for defined group"""
  1025. if not group:
  1026. return
  1027. gisenv = grass.gisenv()
  1028. try:
  1029. name, mapset = group.split('@', 1)
  1030. except ValueError:
  1031. name = group
  1032. mapset = gisenv['MAPSET']
  1033. mlist = RunCommand('i.group', group=group,
  1034. read=True, flags='sg').splitlines()
  1035. try:
  1036. self.SetItems(mlist)
  1037. except OSError:
  1038. self.SetItems([])
  1039. class FormatSelect(wx.Choice):
  1040. def __init__(self, parent, srcType, ogr=False,
  1041. size=globalvar.DIALOG_SPIN_SIZE,
  1042. **kwargs):
  1043. """Widget for selecting external (GDAL/OGR) format
  1044. :param parent: parent window
  1045. :param srcType: source type ('file', 'database', 'protocol')
  1046. :param ogr: True for OGR otherwise GDAL
  1047. """
  1048. super(FormatSelect, self).__init__(parent, id=wx.ID_ANY, size=size,
  1049. **kwargs)
  1050. self.SetName("FormatSelect")
  1051. if ogr:
  1052. ftype = 'ogr'
  1053. else:
  1054. ftype = 'gdal'
  1055. formats = list()
  1056. for f in GetFormats()[ftype][srcType].values():
  1057. formats += f
  1058. self.SetItems(formats)
  1059. def GetExtension(self, name):
  1060. """Get file extension by format name"""
  1061. formatToExt = dict()
  1062. formatToExt.update(rasterFormatExtension)
  1063. formatToExt.update(vectorFormatExtension)
  1064. return formatToExt.get(name, '')
  1065. # unused code since r47938
  1066. # wxGdalSelect, EVT_GDALSELECT = NewEvent()
  1067. class GdalSelect(wx.Panel):
  1068. def __init__(self, parent, panel, ogr=False, link=False, dest=False,
  1069. exclude=None):
  1070. """Widget for selecting GDAL/OGR datasource, format
  1071. .. todo::
  1072. Split into GdalSelect and OgrSelect and optionally to
  1073. GdalSelectOutput, OgrSelectOutput
  1074. :param parent: parent window
  1075. :param bool ogr: use OGR selector instead of GDAL
  1076. :param bool dest: True for output (destination)
  1077. :param default: default type (ignored when dest == True)
  1078. :param exclude: list of types to be excluded
  1079. """
  1080. self.parent = parent
  1081. self.ogr = ogr
  1082. self.link = link
  1083. self.dest = dest
  1084. self._sourceType = None
  1085. wx.Panel.__init__(self, parent=panel)
  1086. self.reloadDataRequired = Signal('GdalSelect.reloadDataRequired')
  1087. if self.ogr:
  1088. settingsFile = os.path.join(GetSettingsPath(), 'wxOGR')
  1089. else:
  1090. settingsFile = os.path.join(GetSettingsPath(), 'wxGDAL')
  1091. self.settsManager = ManageSettingsWidget(parent=self,
  1092. settingsFile=settingsFile)
  1093. self.settsManager.settingsChanged.connect(self.OnSettingsChanged)
  1094. self.settsManager.settingsSaving.connect(self.OnSettingsSaving)
  1095. self.inputBox = wx.StaticBox(parent=self)
  1096. if dest:
  1097. self.inputBox.SetLabel(" %s " % _("Output settings"))
  1098. else:
  1099. self.inputBox.SetLabel(" %s " % _("Source settings"))
  1100. # source type
  1101. sources = list()
  1102. self.sourceMap = { 'file' : -1,
  1103. 'dir' : -1,
  1104. 'db' : -1,
  1105. 'pro' : -1,
  1106. 'native' : -1 }
  1107. idx = 0
  1108. if dest:
  1109. sources.append(_("Native"))
  1110. self.sourceMap['native'] = idx
  1111. idx += 1
  1112. if exclude is None:
  1113. exclude = []
  1114. if 'file' not in exclude:
  1115. sources.append(_("File"))
  1116. self.sourceMap['file'] = idx
  1117. idx += 1
  1118. if 'directory' not in exclude:
  1119. sources.append(_("Directory"))
  1120. self.sourceMap['dir'] = idx
  1121. idx += 1
  1122. if 'database' not in exclude:
  1123. sources.append(_("Database"))
  1124. self.sourceMap['db'] = idx
  1125. idx += 1
  1126. if 'protocol' not in exclude:
  1127. sources.append(_("Protocol"))
  1128. self.sourceMap['pro'] = idx
  1129. idx += 1
  1130. self.sourceMapByIdx = {}
  1131. for name, idx in self.sourceMap.items():
  1132. self.sourceMapByIdx[ idx ] = name
  1133. self.source = wx.RadioBox(parent=self, id=wx.ID_ANY,
  1134. style=wx.RA_SPECIFY_COLS,
  1135. choices=sources)
  1136. if dest:
  1137. self.source.SetLabel(" %s " % _('Output type'))
  1138. else:
  1139. self.source.SetLabel(" %s " % _('Source type'))
  1140. self.source.SetSelection(0)
  1141. self.source.Bind(wx.EVT_RADIOBOX,
  1142. lambda evt: self.SetSourceType(self.sourceMapByIdx[evt.GetInt()]))
  1143. self.nativeWidgets = {}
  1144. self.fileWidgets = {}
  1145. self.dirWidgets = {}
  1146. self.dbWidgets = {}
  1147. self.protocolWidgets = {}
  1148. self.pgWidgets = {}
  1149. if ogr:
  1150. fType = 'ogr'
  1151. else:
  1152. fType = 'gdal'
  1153. # file
  1154. if not ogr:
  1155. extList = rasterFormatExtension
  1156. fileMask = ('%(name)s (*.%(low1)s;*.%(low2)s;*.%(up1)s;*.%(up2)s)|'
  1157. '*.%(low1)s;*.%(low2)s;*.%(up1)s;*.%(up2)s|' %
  1158. {'name': 'GeoTIFF', 'low1': 'tif', 'low2': 'tiff', 'up1': 'TIF', 'up2': 'TIFF'})
  1159. else:
  1160. extList = vectorFormatExtension
  1161. fileMask = '%(name)s (*.%(low)s;*.%(up)s)|*.%(low)s;*.%(up)s|' % {'name': 'ESRI Shapefile', 'low': 'shp', 'up': 'SHP'}
  1162. for name, ext in sorted(extList.items()):
  1163. if name in ('ESRI Shapefile', 'GeoTIFF'):
  1164. continue
  1165. fileMask += '%(name)s (*.%(low)s;*.%(up)s)|*.%(low)s;*.%(up)s|' % {'name': name,
  1166. 'low': ext.lower(),
  1167. 'up': ext.upper()}
  1168. fileMask += '%s (*.zip;*.ZIP)|*.zip;*.ZIP|' % _('ZIP files')
  1169. fileMask += '%s (*.gz;*.GZ)|*.gz;*.GZ|' % _('GZIP files')
  1170. fileMask += '%s (*.tar;*.TAR)|*.tar;*.TAR|' % _('TAR files')
  1171. fileMask += '%s (*.tar.gz;*.TAR.GZ;*.tgz;*.TGZ)|*.tar.gz;*.TAR.GZ;*.tgz;*.TGZ|' % _('TARGZ files')
  1172. # don't include last '|' - windows and mac throw error
  1173. fileMask += '%(all)s (*)|*' % {'all': _('All files')}
  1174. # only contains formats with extensions hardcoded
  1175. self.filePanel = wx.Panel(parent=self)
  1176. browse = filebrowse.FileBrowseButton(parent=self.filePanel, id=wx.ID_ANY,
  1177. size=globalvar.DIALOG_GSELECT_SIZE,
  1178. labelText = _('File:'),
  1179. dialogTitle=_('Choose file to import'),
  1180. buttonText=_('Browse'),
  1181. startDirectory=os.getcwd(),
  1182. changeCallback=self.OnUpdate,
  1183. fileMask=fileMask)
  1184. self.fileWidgets['browse'] = browse
  1185. self.fileWidgets['options'] = wx.TextCtrl(parent=self.filePanel)
  1186. # directory
  1187. self.dirPanel = wx.Panel(parent=self)
  1188. browse = filebrowse.DirBrowseButton(parent=self.dirPanel, id=wx.ID_ANY,
  1189. size=globalvar.DIALOG_GSELECT_SIZE,
  1190. labelText=_('Directory:'),
  1191. dialogTitle=_('Choose input directory'),
  1192. buttonText=_('Browse'),
  1193. startDirectory=os.getcwd(),
  1194. changeCallback=self.OnUpdate)
  1195. self.dirWidgets['browse'] = browse
  1196. formatSelect = wx.Choice(parent=self.dirPanel, size=(300, -1))
  1197. self.dirWidgets['format'] = formatSelect
  1198. fileFormats = GetFormats(writableOnly=dest)[fType]['file']
  1199. formatSelect.SetItems(sorted(list(fileFormats)))
  1200. formatSelect.Bind(wx.EVT_CHOICE, lambda evt: self.SetExtension(self.dirWidgets['format'].GetStringSelection()))
  1201. formatSelect.Bind(wx.EVT_CHOICE, self.OnUpdate)
  1202. self.dirWidgets['extensionLabel'] = wx.StaticText(parent=self.dirPanel,
  1203. label = _("Extension:"))
  1204. self.dirWidgets['extension'] = wx.TextCtrl(parent=self.dirPanel)
  1205. self.dirWidgets['extension'].Bind(wx.EVT_TEXT, self.ExtensionChanged)
  1206. self.dirWidgets['options'] = wx.TextCtrl(parent=self.dirPanel)
  1207. if self.ogr:
  1208. shapefile = 'ESRI Shapefile'
  1209. if shapefile in fileFormats:
  1210. formatSelect.SetStringSelection(shapefile)
  1211. self.SetExtension(shapefile)
  1212. else:
  1213. tiff = 'GeoTIFF'
  1214. if tiff in fileFormats:
  1215. formatSelect.SetStringSelection(tiff)
  1216. self.SetExtension(tiff)
  1217. # database
  1218. self.dbPanel = wx.Panel(parent=self)
  1219. self.dbFormats = GetFormats(writableOnly=dest)[fType]['database']
  1220. dbChoice = wx.Choice(parent=self.dbPanel, choices=self.dbFormats)
  1221. dbChoice.Bind(wx.EVT_CHOICE, lambda evt: self.SetDatabase(db=dbChoice.GetStringSelection()))
  1222. self.dbWidgets['format'] = dbChoice
  1223. browse = filebrowse.FileBrowseButton(parent=self.dbPanel, id=wx.ID_ANY,
  1224. size=globalvar.DIALOG_GSELECT_SIZE,
  1225. labelText=_("Name:"),
  1226. dialogTitle=_('Choose file'),
  1227. buttonText=_('Browse'),
  1228. startDirectory=os.getcwd(),
  1229. changeCallback=self.OnUpdate)
  1230. self.dbWidgets['browse'] = browse
  1231. self.dbWidgets['choice'] = wx.Choice(parent=self.dbPanel)
  1232. self.dbWidgets['choice'].Bind(wx.EVT_CHOICE, self.OnUpdate)
  1233. self.dbWidgets['text'] = wx.TextCtrl(parent=self.dbPanel)
  1234. self.dbWidgets['text'].Bind(wx.EVT_TEXT, self.OnUpdate)
  1235. self.dbWidgets['textLabel1'] = wx.StaticText(parent=self.dbPanel, label=_("Name:"))
  1236. self.dbWidgets['textLabel2'] = wx.StaticText(parent=self.dbPanel, label=_("Name:"))
  1237. self.dbWidgets['featType'] = wx.RadioBox(parent=self.dbPanel, id=wx.ID_ANY,
  1238. label = " %s " % _("Feature type:"),
  1239. choices = [_("simple features"), _("topological")],
  1240. majorDimension=2,
  1241. style = wx.RA_SPECIFY_COLS)
  1242. if dest:
  1243. self.dbWidgets['featType'].Disable()
  1244. else:
  1245. self.dbWidgets['featType'].Hide()
  1246. browse = filebrowse.DirBrowseButton(parent=self.dbPanel, id=wx.ID_ANY,
  1247. size=globalvar.DIALOG_GSELECT_SIZE,
  1248. labelText=_('Directory:'),
  1249. dialogTitle=_('Choose input directory'),
  1250. buttonText=_('Browse'),
  1251. startDirectory=os.getcwd(),
  1252. changeCallback=self.OnUpdate)
  1253. self.dbWidgets['dirbrowse'] = browse
  1254. self.dbWidgets['options'] = wx.TextCtrl(parent=self.dbPanel)
  1255. # protocol
  1256. self.protocolPanel = wx.Panel(parent=self)
  1257. protocolFormats = GetFormats(writableOnly=self.dest)[fType]['protocol']
  1258. protocolChoice = wx.Choice(parent=self.protocolPanel, choices=protocolFormats)
  1259. self.protocolWidgets['format'] = protocolChoice
  1260. self.protocolWidgets['text'] = wx.TextCtrl(parent=self.protocolPanel)
  1261. self.protocolWidgets['text'].Bind(wx.EVT_TEXT, self.OnUpdate)
  1262. self.protocolWidgets['options'] = wx.TextCtrl(parent=self.protocolPanel)
  1263. # native
  1264. self.nativePanel = wx.Panel(parent=self)
  1265. self._layout()
  1266. sourceType = 'file'
  1267. self.SetSourceType(sourceType) # needed always to fit dialog size
  1268. if self.dest:
  1269. current = RunCommand('v.external.out',
  1270. parent=self,
  1271. read=True, parse=grass.parse_key_val,
  1272. flags='g')
  1273. if current['format'] == 'native':
  1274. sourceType = 'native'
  1275. elif current['format'] in GetFormats()['ogr']['database']:
  1276. sourceType = 'db'
  1277. else:
  1278. sourceType = 'dir'
  1279. if self.dest:
  1280. wx.CallAfter(self._postInit, sourceType, current)
  1281. def _postInit(self, sourceType, data):
  1282. """Fill in default values."""
  1283. format = data.get('format', '')
  1284. pg = 'conninfo' in data.keys()
  1285. if pg:
  1286. dsn=''
  1287. for item in data.get('conninfo').split(' '):
  1288. k, v = item.split('=')
  1289. if k == 'dbname':
  1290. dsn=v
  1291. break
  1292. optList = list()
  1293. for k, v in data.iteritems():
  1294. if k in ('format', 'conninfo', 'topology'):
  1295. continue
  1296. optList.append('%s=%s' % (k, v))
  1297. options = ','.join(optList)
  1298. else:
  1299. dsn = data.get('dsn')
  1300. options = data.get('options', '')
  1301. self.SetSourceType(sourceType)
  1302. self.source.SetSelection(self.sourceMap[sourceType])
  1303. dsn = os.path.expandvars(dsn) # v.external.out uses $HOME
  1304. # fill in default values
  1305. if sourceType == 'dir':
  1306. self.dirWidgets['format'].SetStringSelection(format)
  1307. self.dirWidgets['browse'].SetValue(dsn)
  1308. self.dirWidgets['options'].SetValue(options)
  1309. elif sourceType == 'db':
  1310. self.dbWidgets['format'].SetStringSelection(format)
  1311. self.dbWidgets['options'].SetValue(options)
  1312. name = self._getCurrentDbWidgetName()
  1313. if name == 'choice':
  1314. if dsn in self.dbWidgets[name].GetItems():
  1315. self.dbWidgets[name].SetStringSelection(dsn)
  1316. if 'topology' in data.keys():
  1317. self.dbWidgets['featType'].SetSelection(1)
  1318. else:
  1319. self.dbWidgets[name].SetValue(dsn)
  1320. def _layout(self):
  1321. """Layout"""
  1322. mainSizer = wx.BoxSizer(wx.VERTICAL)
  1323. self.changingSizer = wx.StaticBoxSizer(self.inputBox, wx.VERTICAL)
  1324. # file
  1325. paddingSizer = wx.BoxSizer(wx.VERTICAL)
  1326. sizer = wx.GridBagSizer(vgap=5, hgap=10)
  1327. paddingSizer.Add(item=self.fileWidgets['browse'],
  1328. flag=wx.BOTTOM | wx.ALIGN_CENTER_VERTICAL | wx.EXPAND,
  1329. border=30)
  1330. sizer.Add(item=paddingSizer, flag=wx.EXPAND, pos=(0, 0), span=(1, 2))
  1331. sizer.AddGrowableCol(0)
  1332. if self.dest:
  1333. sizer.Add(item=wx.StaticText(parent=self.filePanel,
  1334. label = _("Creation options:")),
  1335. flag = wx.ALIGN_CENTER_VERTICAL,
  1336. pos = (1, 0))
  1337. sizer.Add(item=self.fileWidgets['options'],
  1338. flag=wx.ALIGN_CENTER_VERTICAL|wx.EXPAND,
  1339. pos=(1, 1))
  1340. else:
  1341. self.fileWidgets['options'].Hide()
  1342. self.filePanel.SetSizer(sizer)
  1343. # directory
  1344. sizer = wx.GridBagSizer(vgap=3, hgap=10)
  1345. sizer.Add(item=wx.StaticText(parent=self.dirPanel,
  1346. label = _("Format:")),
  1347. flag=wx.ALIGN_CENTER_VERTICAL,
  1348. pos=(0, 0))
  1349. sizer.Add(item=self.dirWidgets['format'],
  1350. flag=wx.ALIGN_CENTER_VERTICAL|wx.EXPAND,
  1351. pos=(0, 1))
  1352. sizer.Add(item=self.dirWidgets['extensionLabel'],
  1353. flag=wx.ALIGN_CENTER_VERTICAL,
  1354. pos=(0, 2))
  1355. sizer.Add(item=self.dirWidgets['extension'],
  1356. flag=wx.ALIGN_CENTER_VERTICAL,
  1357. pos=(0, 3))
  1358. sizer.Add(item=self.dirWidgets['browse'],
  1359. flag=wx.ALIGN_CENTER_VERTICAL|wx.EXPAND,
  1360. pos=(1, 0), span=(1, 4))
  1361. if self.dest:
  1362. sizer.Add(item=wx.StaticText(parent=self.dirPanel,
  1363. label = _("Creation options:")),
  1364. flag = wx.ALIGN_CENTER_VERTICAL,
  1365. pos = (2, 0))
  1366. sizer.Add(item=self.dirWidgets['options'],
  1367. flag=wx.ALIGN_CENTER_VERTICAL|wx.EXPAND,
  1368. pos=(2, 1))
  1369. helpBtn = wx.Button(parent=self.dirPanel, id=wx.ID_HELP)
  1370. helpBtn.Bind(wx.EVT_BUTTON, self.OnHelp)
  1371. sizer.Add(item=helpBtn,
  1372. flag=wx.ALIGN_CENTER_VERTICAL|wx.EXPAND,
  1373. pos=(2, 2))
  1374. self.dirWidgets['extensionLabel'].Hide()
  1375. self.dirWidgets['extension'].Hide()
  1376. else:
  1377. self.dirWidgets['options'].Hide()
  1378. sizer.AddGrowableCol(1)
  1379. self.dirPanel.SetSizer(sizer)
  1380. # database
  1381. sizer = wx.GridBagSizer(vgap=1, hgap=5)
  1382. sizer.Add(item=wx.StaticText(parent=self.dbPanel,
  1383. label = _("Format:")),
  1384. flag=wx.ALIGN_CENTER_VERTICAL,
  1385. pos=(0, 0))
  1386. sizer.Add(item=self.dbWidgets['format'],
  1387. flag=wx.ALIGN_CENTER_VERTICAL,
  1388. pos=(0, 1))
  1389. sizer.Add(item=self.dbWidgets['textLabel1'],
  1390. flag=wx.ALIGN_CENTER_VERTICAL,
  1391. pos=(1, 0))
  1392. sizer.Add(item=self.dbWidgets['text'],
  1393. flag=wx.ALIGN_CENTER_VERTICAL|wx.EXPAND,
  1394. pos=(1, 1), span=(1, 2))
  1395. sizer.Add(item=self.dbWidgets['browse'],
  1396. flag=wx.ALIGN_CENTER_VERTICAL|wx.EXPAND,
  1397. pos=(2, 0), span=(1, 3))
  1398. sizer.Add(item=self.dbWidgets['dirbrowse'],
  1399. flag=wx.ALIGN_CENTER_VERTICAL|wx.EXPAND,
  1400. pos=(3, 0), span=(1, 2))
  1401. sizer.Add(item=self.dbWidgets['textLabel2'],
  1402. flag=wx.ALIGN_CENTER_VERTICAL,
  1403. pos=(4, 0))
  1404. sizer.Add(item=self.dbWidgets['choice'],
  1405. flag=wx.ALIGN_CENTER_VERTICAL|wx.EXPAND,
  1406. pos=(4, 1), span=(1, 2))
  1407. if self.dest:
  1408. sizer.Add(item=self.dbWidgets['featType'],
  1409. pos=(0, 2), flag=wx.EXPAND)
  1410. sizer.Add(item=wx.StaticText(parent=self.dbPanel,
  1411. label = _("Creation options:")),
  1412. flag = wx.ALIGN_CENTER_VERTICAL,
  1413. pos = (5, 0))
  1414. sizer.Add(item=self.dbWidgets['options'],
  1415. flag=wx.ALIGN_CENTER_VERTICAL|wx.EXPAND,
  1416. pos=(5, 1), span=(1, 2))
  1417. # help button
  1418. helpBtn = wx.Button(parent=self.dbPanel, id=wx.ID_HELP)
  1419. helpBtn.Bind(wx.EVT_BUTTON, self.OnHelp)
  1420. sizer.Add(item=helpBtn,
  1421. pos=(5, 3))
  1422. else:
  1423. self.dbWidgets['options'].Hide()
  1424. self.dbPanel.SetSizer(sizer)
  1425. sizer.SetEmptyCellSize((0, 0))
  1426. sizer.AddGrowableCol(1)
  1427. # protocol
  1428. sizer = wx.GridBagSizer(vgap=3, hgap=3)
  1429. sizer.Add(item=wx.StaticText(parent=self.protocolPanel,
  1430. label = _("Format:")),
  1431. flag=wx.ALIGN_CENTER_VERTICAL,
  1432. pos=(0, 0))
  1433. sizer.Add(item=self.protocolWidgets['format'],
  1434. flag=wx.ALIGN_CENTER_VERTICAL,
  1435. pos=(0, 1))
  1436. sizer.Add(item=wx.StaticText(parent=self.protocolPanel,
  1437. label = _("Protocol:")),
  1438. flag=wx.ALIGN_CENTER_VERTICAL,
  1439. pos=(1, 0))
  1440. sizer.Add(item=self.protocolWidgets['text'],
  1441. flag=wx.ALIGN_CENTER_VERTICAL|wx.EXPAND,
  1442. pos=(1, 1))
  1443. if self.dest:
  1444. sizer.Add(item=wx.StaticText(parent=self.protocolPanel,
  1445. label = _("Creation options:")),
  1446. flag = wx.ALIGN_CENTER_VERTICAL,
  1447. pos = (2, 0))
  1448. sizer.Add(item=self.protocolWidgets['options'],
  1449. flag=wx.ALIGN_CENTER_VERTICAL|wx.EXPAND,
  1450. pos=(2, 1))
  1451. else:
  1452. self.protocolWidgets['options'].Hide()
  1453. sizer.AddGrowableCol(1)
  1454. self.protocolPanel.SetSizer(sizer)
  1455. # native
  1456. sizer = wx.BoxSizer(wx.VERTICAL)
  1457. sizer.Add(item=wx.StaticText(parent=self.nativePanel,
  1458. label = _("No settings available")),
  1459. flag=wx.ALIGN_CENTER_VERTICAL|wx.ALL|wx.EXPAND, border=5)
  1460. self.nativePanel.SetSizer(sizer)
  1461. for panel in (self.nativePanel, self.filePanel,
  1462. self.dirPanel, self.dbPanel,
  1463. self.protocolPanel):
  1464. self.changingSizer.Add(item=panel, proportion=1,
  1465. flag=wx.EXPAND)
  1466. mainSizer.Add(item=self.settsManager, proportion=0,
  1467. flag=wx.ALL | wx.EXPAND, border=5)
  1468. mainSizer.Add(item=self.source, proportion=0,
  1469. flag=wx.LEFT | wx.RIGHT | wx.EXPAND, border=5)
  1470. mainSizer.Add(item=self.changingSizer, proportion=1,
  1471. flag=wx.ALL | wx.EXPAND, border=5)
  1472. self.mainSizer = mainSizer
  1473. self.SetSizer(mainSizer)
  1474. mainSizer.Fit(self)
  1475. def _getExtension(self, name):
  1476. """Get file extension by format name"""
  1477. formatToExt = dict()
  1478. formatToExt.update(rasterFormatExtension)
  1479. formatToExt.update(vectorFormatExtension)
  1480. return formatToExt.get(name, '')
  1481. def SetSourceType(self, sourceType):
  1482. """Set source type (db, file, dir, ...).
  1483. Does not switch radioboxes."""
  1484. self._sourceType = sourceType
  1485. self.changingSizer.Show(item=self.filePanel, show=(sourceType == 'file'))
  1486. self.changingSizer.Show(item=self.nativePanel, show=(sourceType == 'native'))
  1487. self.changingSizer.Show(item=self.dirPanel, show=(sourceType == 'dir'))
  1488. self.changingSizer.Show(item=self.protocolPanel, show=(sourceType == 'pro'))
  1489. self.changingSizer.Show(item=self.dbPanel, show=(sourceType is 'db'))
  1490. self.changingSizer.Layout()
  1491. if sourceType == 'db':
  1492. self.dbWidgets['format'].SetItems(self.dbFormats)
  1493. if self.dbFormats:
  1494. if 'PostgreSQL' in self.dbFormats:
  1495. self.dbWidgets['format'].SetStringSelection('PostgreSQL')
  1496. else:
  1497. self.dbWidgets['format'].SetSelection(0)
  1498. self.dbWidgets['format'].Enable()
  1499. if sourceType == 'db':
  1500. db = self.dbWidgets['format'].GetStringSelection()
  1501. self.SetDatabase(db)
  1502. if not self.dest:
  1503. self.reloadDataRequired.emit(data=None)
  1504. self._reloadLayers()
  1505. def OnSettingsChanged(self, data):
  1506. """User changed setting"""
  1507. # data list: [type, dsn, format, options]
  1508. if len(data) == 3:
  1509. data.append('')
  1510. elif len < 3:
  1511. return
  1512. self.source.SetSelection(self.sourceMap[data[0]])
  1513. self.SetSourceType(data[0])
  1514. if data[0] == 'file':
  1515. self.fileWidgets['browse'].SetValue(data[1])
  1516. self.fileWidgets['options'].SetValue(data[3])
  1517. elif data[0] == 'dir':
  1518. self.dirWidgets['browse'].SetValue(data[1])
  1519. self.dirWidgets['format'].SetStringSelection(data[2])
  1520. self.dirWidgets['options'].SetValue(data[3])
  1521. self.SetExtension(data[2])
  1522. elif data[0] == 'pro':
  1523. self.protocolWidgets['text'].SetValue(data[2])
  1524. self.protocolWidgets['options'].SetValue(data[3])
  1525. elif data[0] == 'db':
  1526. name = self._getCurrentDbWidgetName()
  1527. if name =='choice':
  1528. if len(data[1].split(':', 1)) > 1:
  1529. for item in data[1].split(':', 1)[1].split(','):
  1530. key, value = item.split('=', 1)
  1531. if key == 'dbname':
  1532. self.dbWidgets[name].SetStringSelection(value)
  1533. break
  1534. else:
  1535. self.dbWidgets[name].SetStringSelection(data[1])
  1536. else:
  1537. self.dbWidgets[name].SetValue(data[1])
  1538. self.dbWidgets['options'].SetValue(data[3])
  1539. if not self.dest:
  1540. self.reloadDataRequired.emit(data=None)
  1541. self._reloadLayers()
  1542. def OnSettingsSaving(self, name):
  1543. """Saving data"""
  1544. if not self.GetDsn():
  1545. GMessage(parent = self,
  1546. message = _("No data source defined, settings are not saved."))
  1547. return
  1548. self.settsManager.SetDataToSave((self._sourceType, self.GetDsn(),
  1549. self.GetFormat(), self.GetOptions()))
  1550. self.settsManager.SaveSettings(name)
  1551. def _getExtPatternGlob(self, ext):
  1552. """Get pattern for case-insensitive globing"""
  1553. pattern = '*.'
  1554. for c in ext:
  1555. pattern += '[%s%s]' % (c.lower(), c.upper())
  1556. return pattern
  1557. def _getCurrentDbWidgetName(self):
  1558. """Returns active dns database widget name."""
  1559. for widget in ('browse', 'dirbrowse', 'text', 'choice'):
  1560. if self.dbWidgets[widget].IsShown():
  1561. return widget
  1562. def GetDsn(self):
  1563. """Get datasource name
  1564. """
  1565. if self._sourceType == 'db':
  1566. if self.dbWidgets['format'].GetStringSelection() in ('PostgreSQL',
  1567. 'PostGIS Raster driver'):
  1568. dsn = 'PG:dbname=%s' % self.dbWidgets['choice'].GetStringSelection()
  1569. else:
  1570. name = self._getCurrentDbWidgetName()
  1571. if name == 'choice':
  1572. dsn = self.dbWidgets[name].GetStringSelection()
  1573. else:
  1574. dsn = self.dbWidgets[name].GetValue()
  1575. else:
  1576. if self._sourceType == 'file':
  1577. dsn = self.fileWidgets['browse'].GetValue()
  1578. elif self._sourceType == 'dir':
  1579. dsn = self.dirWidgets['browse'].GetValue()
  1580. elif self._sourceType == 'pro':
  1581. dsn = self.protocolWidgets['text'].GetValue()
  1582. else:
  1583. dsn = ''
  1584. # check compressed files
  1585. try:
  1586. ext = os.path.splitext(dsn)[1].lower()
  1587. except KeyError:
  1588. ext = None
  1589. if ext == '.zip':
  1590. dsn = '/vsizip/' + dsn
  1591. elif ext == '.gzip':
  1592. dsn = '/vsigzip/' + dsn
  1593. elif ext in ('.tar', '.tar.gz', '.tgz'):
  1594. dsn = '/vsitar/' + dsn
  1595. return dsn
  1596. def SetDatabase(self, db):
  1597. """Update database panel."""
  1598. sizer = self.dbPanel.GetSizer()
  1599. showBrowse = db in ('SQLite', 'Rasterlite')
  1600. showDirbrowse = db in ('FileGDB')
  1601. showChoice = db in ('PostgreSQL','PostGIS WKT Raster driver',
  1602. 'PostGIS Raster driver')
  1603. enableFeatType = self.dest and self.ogr and db in ('PostgreSQL')
  1604. showText = not(showBrowse or showChoice or showDirbrowse)
  1605. sizer.Show(self.dbWidgets['browse'], show=showBrowse)
  1606. sizer.Show(self.dbWidgets['dirbrowse'], show=showDirbrowse)
  1607. sizer.Show(self.dbWidgets['choice'], show=showChoice)
  1608. sizer.Show(self.dbWidgets['textLabel2'], show=showChoice)
  1609. sizer.Show(self.dbWidgets['text'], show=showText)
  1610. sizer.Show(self.dbWidgets['textLabel1'], show=showText)
  1611. self.dbWidgets['featType'].Enable(enableFeatType)
  1612. if showChoice:
  1613. # try to get list of PG databases
  1614. dbNames = RunCommand('db.databases', parent=self, quiet=True, read=True,
  1615. driver='pg').splitlines()
  1616. if dbNames is not None:
  1617. self.dbWidgets['choice'].SetItems(sorted(dbNames))
  1618. self.dbWidgets['choice'].SetSelection(0)
  1619. elif grass.find_program('psql', '--help'):
  1620. if not self.dbWidgets['choice'].GetItems():
  1621. p = grass.Popen(['psql', '-ltA'], stdout = grass.PIPE)
  1622. ret = p.communicate()[0]
  1623. if ret:
  1624. dbNames = list()
  1625. for line in ret.splitlines():
  1626. sline = line.split('|')
  1627. if len(sline) < 2:
  1628. continue
  1629. dbname = sline[0]
  1630. if dbname:
  1631. dbNames.append(dbname)
  1632. self.dbWidgets['choice'].SetItems(db)
  1633. self.dbWidgets['choice'].SetSelection(0)
  1634. else:
  1635. sizer.Show(self.dbWidgets['text'])
  1636. sizer.Show(self.dbWidgets['choice'], False)
  1637. sizer.Layout()
  1638. def OnUpdate(self, event):
  1639. """Update required - load layers."""
  1640. if not self.dest:
  1641. self._reloadLayers()
  1642. event.Skip()
  1643. def _reloadLayers(self):
  1644. """Reload list of layers"""
  1645. dsn = self.GetDsn()
  1646. if not dsn:
  1647. return
  1648. data = list()
  1649. layerId = 1
  1650. if self.ogr:
  1651. ret = RunCommand('v.external',
  1652. quiet = True,
  1653. read = True,
  1654. flags = 't',
  1655. dsn = dsn)
  1656. if not ret:
  1657. self.reloadDataRequired.emit(data=None)
  1658. return
  1659. layerId = 1
  1660. for line in ret.splitlines():
  1661. layerName, featureType, projection = map(lambda x: x.strip(), line.split(','))
  1662. if projection == '0':
  1663. projectionMatch = _("No")
  1664. else:
  1665. projectionMatch = _("Yes")
  1666. grassName = GetValidLayerName(layerName)
  1667. data.append((layerId, layerName, featureType, projectionMatch, grassName))
  1668. layerId += 1
  1669. else:
  1670. if self._sourceType == 'file':
  1671. baseName = os.path.basename(dsn)
  1672. grassName = GetValidLayerName(baseName.split('.', -1)[0])
  1673. data.append((layerId, baseName, grassName))
  1674. elif self._sourceType == 'dir':
  1675. ext = self.dirWidgets['extension'].GetValue()
  1676. for filename in glob.glob(os.path.join(dsn, "%s") % self._getExtPatternGlob(ext)):
  1677. baseName = os.path.basename(filename)
  1678. grassName = GetValidLayerName(baseName.split('.', -1)[0])
  1679. data.append((layerId, baseName, grassName))
  1680. layerId += 1
  1681. # unused code since r47938
  1682. # if self.ogr:
  1683. # dsn += '@OGR'
  1684. #
  1685. # evt = wxGdalSelect(dsn = dsn)
  1686. # evt.SetId(self.input[self.dsnType][1].GetId())
  1687. # wx.PostEvent(self.parent, evt)
  1688. if self.parent.GetName() == 'MultiImportDialog':
  1689. self.reloadDataRequired.emit(data=data)
  1690. def ExtensionChanged(self, event):
  1691. if not self.dest:
  1692. # reload layers
  1693. self._reloadLayers()
  1694. def SetExtension(self, name):
  1695. """Extension changed"""
  1696. ext = self._getExtension(name)
  1697. self.dirWidgets['extension'].SetValue(ext)
  1698. def GetType(self):
  1699. """Get source type"""
  1700. return self._sourceType
  1701. def GetFormat(self):
  1702. """Get format as string"""
  1703. if self._sourceType == 'dir':
  1704. format = self.dirWidgets['format'].GetStringSelection()
  1705. elif self._sourceType == 'pro':
  1706. format = self.protocolWidgets['format'].GetStringSelection()
  1707. elif self._sourceType == 'db':
  1708. format = self.dbWidgets['format'].GetStringSelection()
  1709. else:
  1710. format = ''
  1711. return format.replace(' ', '_')
  1712. def GetFormatExt(self):
  1713. """Get format extension"""
  1714. return self._getExtension(self.GetFormat())
  1715. def GetOptions(self):
  1716. """Get creation options"""
  1717. if self._sourceType == 'file':
  1718. options = self.fileWidgets['options'].GetValue()
  1719. elif self._sourceType == 'dir':
  1720. options = self.dirWidgets['options'].GetValue()
  1721. elif self._sourceType == 'pro':
  1722. options = self.protocolWidgets['options'].GetValue()
  1723. elif self._sourceType == 'db':
  1724. if self.dbWidgets['featType'].GetSelection() == 1:
  1725. options = 'topology=yes '
  1726. else:
  1727. options = ''
  1728. options += self.dbWidgets['options'].GetValue()
  1729. return options.strip()
  1730. def OnHelp(self, event):
  1731. """Show related manual page"""
  1732. cmd = ''
  1733. if self.dest:
  1734. if self.ogr:
  1735. cmd = 'v.external.out'
  1736. else:
  1737. cmd = 'r.external.out'
  1738. else:
  1739. if self.link:
  1740. if self.ogr:
  1741. cmd = 'v.external'
  1742. else:
  1743. cmd = 'r.external'
  1744. else:
  1745. if self.ogr:
  1746. cmd = 'v.in.ogr'
  1747. else:
  1748. cmd = 'r.in.gdal'
  1749. RunCommand('g.manual', entry = cmd)
  1750. class ProjSelect(wx.ComboBox):
  1751. """Widget for selecting input raster/vector map used by
  1752. r.proj/v.proj modules."""
  1753. def __init__(self, parent, isRaster, id = wx.ID_ANY, size = globalvar.DIALOG_COMBOBOX_SIZE,
  1754. **kwargs):
  1755. super(ProjSelect, self).__init__(parent, id, size = size,
  1756. style = wx.CB_READONLY, **kwargs)
  1757. self.SetName("ProjSelect")
  1758. self.isRaster = isRaster
  1759. def UpdateItems(self, dbase, location, mapset):
  1760. """Update list of maps
  1761. """
  1762. if not dbase:
  1763. dbase = grass.gisenv()['GISDBASE']
  1764. if not mapset:
  1765. mapset = grass.gisenv()['MAPSET']
  1766. if self.isRaster:
  1767. ret = RunCommand('r.proj',
  1768. quiet = True,
  1769. read = True,
  1770. flags = 'l',
  1771. dbase = dbase,
  1772. location = location,
  1773. mapset = mapset)
  1774. else:
  1775. ret = RunCommand('v.proj',
  1776. quiet = True,
  1777. read = True,
  1778. flags = 'l',
  1779. dbase = dbase,
  1780. location = location,
  1781. mapset = mapset)
  1782. listMaps = list()
  1783. if ret:
  1784. for line in ret.splitlines():
  1785. listMaps.append(line.strip())
  1786. ListSortLower(listMaps)
  1787. self.SetItems(listMaps)
  1788. self.SetValue('')
  1789. class ElementSelect(wx.Choice):
  1790. def __init__(self, parent, id = wx.ID_ANY, size = globalvar.DIALOG_COMBOBOX_SIZE,
  1791. **kwargs):
  1792. """Widget for selecting GIS element
  1793. :param parent: parent window
  1794. """
  1795. super(ElementSelect, self).__init__(parent, id, size = size,
  1796. **kwargs)
  1797. self.SetName("ElementSelect")
  1798. task = gtask.parse_interface('g.list')
  1799. p = task.get_param(value = 'type')
  1800. self.values = p.get('values', [])
  1801. self.valuesDesc = p.get('values_desc', [])
  1802. self.SetItems(self.valuesDesc)
  1803. def GetValue(self, name):
  1804. """Translate value
  1805. :param name: element name
  1806. """
  1807. idx = self.valuesDesc.index(name)
  1808. if idx > -1:
  1809. return self.values[idx]
  1810. return ''
  1811. class OgrTypeSelect(wx.Panel):
  1812. def __init__(self, parent, panel, **kwargs):
  1813. """Widget to choose OGR feature type
  1814. :param parent: parent window
  1815. :param panel: wx.Panel instance used as parent window
  1816. """
  1817. wx.Panel.__init__(self, parent = panel, id = wx.ID_ANY)
  1818. self.ftype = wx.Choice(parent = self, id = wx.ID_ANY,
  1819. size = (200, -1),
  1820. choices = (_("Point"), _("LineString"), _("Polygon")))
  1821. self._layout()
  1822. def _layout(self):
  1823. """Do layout"""
  1824. sizer = wx.BoxSizer(wx.HORIZONTAL)
  1825. sizer.Add(item = wx.StaticText(parent = self,
  1826. id = wx.ID_ANY,
  1827. label = _("Feature type:")),
  1828. proportion = 1,
  1829. flag = wx.ALIGN_CENTER_VERTICAL,
  1830. border = 5)
  1831. sizer.Add(item = self.ftype,
  1832. proportion = 0,
  1833. flag = wx.EXPAND | wx.ALIGN_RIGHT)
  1834. self.SetSizer(sizer)
  1835. sizer.Fit(self)
  1836. def GetType(self):
  1837. """Get selected type as string
  1838. :return: feature type as string
  1839. """
  1840. sel = self.ftype.GetSelection()
  1841. if sel == 0:
  1842. return 'point'
  1843. elif sel == 1:
  1844. return 'line'
  1845. elif sel == 2:
  1846. return 'boundary'
  1847. class CoordinatesSelect(wx.Panel):
  1848. def __init__(self, parent, giface, multiple = False, **kwargs):
  1849. """Widget to get coordinates from map window by mouse click
  1850. :param parent: parent window
  1851. :param giface: GRASS interface
  1852. :param multiple: - True if it is possible to insert more coordinates
  1853. """
  1854. self._giface = giface
  1855. self.multiple = multiple
  1856. self.mapWin = None
  1857. self.drawMapWin = None
  1858. super(CoordinatesSelect, self).__init__(parent=parent, id=wx.ID_ANY)
  1859. self.coordsField = wx.TextCtrl(parent=self, id=wx.ID_ANY,
  1860. size=globalvar.DIALOG_TEXTCTRL_SIZE,
  1861. validator=CoordinatesValidator())
  1862. icon = wx.Bitmap(os.path.join(globalvar.ICONDIR, "grass", "pointer.png"))
  1863. self.buttonInsCoords = buttons.ThemedGenBitmapToggleButton(parent=self, id=wx.ID_ANY,
  1864. bitmap=icon,
  1865. size=globalvar.DIALOG_COLOR_SIZE)
  1866. self.registered = False
  1867. self.buttonInsCoords.Bind(wx.EVT_BUTTON, self._onClick)
  1868. mapdisp = self._giface.GetMapDisplay()
  1869. if mapdisp:
  1870. switcher = mapdisp.GetToolSwitcher()
  1871. switcher.AddCustomToolToGroup(group='mouseUse',
  1872. btnId=self.buttonInsCoords.GetId(),
  1873. toggleHandler=self.buttonInsCoords.SetValue)
  1874. self._doLayout()
  1875. self.coordsField.Bind(wx.EVT_TEXT, lambda event : self._draw(delay=1))
  1876. def _doLayout(self):
  1877. self.dialogSizer = wx.BoxSizer(wx.HORIZONTAL)
  1878. self.dialogSizer.Add(item = self.coordsField,
  1879. proportion = 1,
  1880. flag = wx.EXPAND)
  1881. self.dialogSizer.Add(item = self.buttonInsCoords)
  1882. self.SetSizer(self.dialogSizer)
  1883. def _onClick(self, event):
  1884. """Button for interacitve inserting of coordinates clicked"""
  1885. self.mapWin = self._giface.GetMapWindow()
  1886. if self.buttonInsCoords.GetToggle() and self.mapWin:
  1887. switcher = self._giface.GetMapDisplay().GetToolSwitcher()
  1888. switcher.ToolChanged(self.buttonInsCoords.GetId())
  1889. if self.mapWin.RegisterMouseEventHandler(wx.EVT_LEFT_DOWN,
  1890. self._onMapClickHandler,
  1891. 'cross') == False:
  1892. return
  1893. self.registered = True
  1894. self._giface.GetMapDisplay().Raise()
  1895. else:
  1896. if self.mapWin and \
  1897. self.mapWin.UnregisterMouseEventHandler(wx.EVT_LEFT_DOWN,
  1898. self._onMapClickHandler):
  1899. self.registered = False
  1900. return
  1901. def drawCleanUp(self):
  1902. if self.drawMapWin:
  1903. self.drawMapWin.UnregisterGraphicsToDraw(self.pointsToDraw)
  1904. def _draw(self, delay):
  1905. """Draws points representing inserted coordinates in mapwindow."""
  1906. if self.drawMapWin != self.mapWin:
  1907. self.drawCleanUp()
  1908. if self.mapWin:
  1909. self.drawMapWin = self.mapWin
  1910. self.pointsToDraw = self.drawMapWin.RegisterGraphicsToDraw(graphicsType="point")
  1911. if self.drawMapWin:
  1912. items = self.pointsToDraw.GetAllItems()
  1913. for i in items:
  1914. self.pointsToDraw.DeleteItem(i)
  1915. coords = self._getCoords()
  1916. if coords is not None:
  1917. for i in range(len(coords)/2):
  1918. i = i * 2
  1919. self.pointsToDraw.AddItem(coords=(coords[i], coords[i + 1]))
  1920. self._giface.updateMap.emit(render=False, renderVector=False, delay=delay)
  1921. def _getCoords(self):
  1922. """Get list of coordinates.
  1923. :return: None if values are not valid
  1924. """
  1925. if self.coordsField.GetValidator().Validate():
  1926. return self.coordsField.GetValue().split(',')
  1927. return None
  1928. def _onMapClickHandler(self, event):
  1929. """Gets coordinates from mapwindow"""
  1930. if event == "unregistered":
  1931. return
  1932. e, n = self.mapWin.GetLastEN()
  1933. prevCoords = ""
  1934. if self.multiple:
  1935. prevCoords = self.coordsField.GetValue().strip()
  1936. if prevCoords != "":
  1937. prevCoords += ","
  1938. value = prevCoords + str(e) + "," + str(n)
  1939. self.coordsField.SetValue(value)
  1940. self._draw(delay=0)
  1941. def OnClose(self):
  1942. """Unregistrates _onMapClickHandler from mapWin"""
  1943. self.drawCleanUp()
  1944. self._giface.updateMap.emit(render=False, renderVector=False)
  1945. mapdisp = self._giface.GetMapDisplay()
  1946. if mapdisp:
  1947. switcher = mapdisp.GetToolSwitcher()
  1948. switcher.RemoveCustomToolFromGroup(self.buttonInsCoords.GetId())
  1949. if self.mapWin and self.registered:
  1950. self.mapWin.UnregisterMouseEventHandler(wx.EVT_LEFT_DOWN,
  1951. self._onMapClickHandler)
  1952. def GetTextWin(self):
  1953. """Get TextCtrl widget"""
  1954. return self.coordsField
  1955. class SignatureSelect(wx.ComboBox):
  1956. """Widget for selecting signatures"""
  1957. def __init__(self, parent, element, id = wx.ID_ANY, size = globalvar.DIALOG_GSELECT_SIZE,
  1958. **kwargs):
  1959. super(SignatureSelect, self).__init__(parent, id, size = size,
  1960. **kwargs)
  1961. self.element = element
  1962. self.SetName("SignatureSelect")
  1963. def Insert(self, group, subgroup = None):
  1964. """Insert signatures for defined group/subgroup
  1965. :param group: group name (can be fully-qualified)
  1966. :param subgroup: non fully-qualified name of subgroup
  1967. """
  1968. if not group:
  1969. return
  1970. gisenv = grass.gisenv()
  1971. try:
  1972. name, mapset = group.split('@', 1)
  1973. except ValueError:
  1974. name = group
  1975. mapset = gisenv['MAPSET']
  1976. path = os.path.join(gisenv['GISDBASE'], gisenv['LOCATION_NAME'], mapset,
  1977. 'group', name)
  1978. if subgroup:
  1979. path = os.path.join(path, 'subgroup', subgroup)
  1980. try:
  1981. items = list()
  1982. for element in os.listdir(os.path.join(path, self.element)):
  1983. items.append(element)
  1984. self.SetItems(items)
  1985. except OSError:
  1986. self.SetItems([])
  1987. self.SetValue('')
  1988. class SeparatorSelect(wx.ComboBox):
  1989. """Widget for selecting seperator"""
  1990. def __init__(self, parent, id = wx.ID_ANY, size = globalvar.DIALOG_GSELECT_SIZE,
  1991. **kwargs):
  1992. super(SeparatorSelect, self).__init__(parent, id, size = size,
  1993. **kwargs)
  1994. self.SetName("SeparatorSelect")
  1995. self.SetItems(['pipe', 'comma', 'space', 'tab', 'newline'])