frame.py 81 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378
  1. """
  2. @package main_window::frame
  3. @brief Single Window layout - main menu, main toolbars, dockable
  4. panes for display management and access to command console.
  5. Classes:
  6. - frame::GMFrame
  7. (C) 2006-2021 by the GRASS Development Team
  8. This program is free software under the GNU General Public License
  9. (>=v2). Read the file COPYING that comes with GRASS for details.
  10. @author Michael Barton (Arizona State University)
  11. @author Jachym Cepicky (Mendel University of Agriculture)
  12. @author Martin Landa <landa.martin gmail.com>
  13. @author Vaclav Petras <wenzeslaus gmail.com> (menu customization)
  14. """
  15. import sys
  16. import os
  17. import stat
  18. import platform
  19. import re
  20. from core import globalvar
  21. try:
  22. from agw import aui
  23. except ImportError:
  24. import wx.lib.agw.aui as aui
  25. import wx
  26. try:
  27. import wx.lib.agw.flatnotebook as FN
  28. except ImportError:
  29. import wx.lib.flatnotebook as FN
  30. if os.path.join(globalvar.ETCDIR, "python") not in sys.path:
  31. sys.path.append(os.path.join(globalvar.ETCDIR, "python"))
  32. from grass.script import core as grass
  33. from grass.script.utils import decode
  34. from core.gcmd import RunCommand, GError, GMessage
  35. from core.settings import UserSettings, GetDisplayVectSettings
  36. from core.utils import SetAddOnPath, GetLayerNameFromCmd, command2ltype, get_shell_pid
  37. from gui_core.preferences import MapsetAccess, PreferencesDialog
  38. from lmgr.layertree import LayerTree, LMIcons
  39. from lmgr.menudata import LayerManagerMenuData, LayerManagerModuleTree
  40. from gui_core.widgets import GNotebook
  41. from core.gconsole import GConsole, EVT_IGNORED_CMD_RUN
  42. from core.giface import Notification
  43. from gui_core.goutput import GConsoleWindow, GC_PROMPT
  44. from gui_core.dialogs import (
  45. LocationDialog,
  46. MapsetDialog,
  47. CreateNewVector,
  48. GroupDialog,
  49. MapLayersDialog,
  50. QuitDialog,
  51. )
  52. from gui_core.menu import SearchModuleWindow
  53. from gui_core.menu import Menu as GMenu
  54. from core.debug import Debug
  55. from lmgr.toolbars import LMWorkspaceToolbar, LMToolsToolbar
  56. from lmgr.toolbars import LMMiscToolbar, LMNvizToolbar, DisplayPanelToolbar
  57. from lmgr.statusbar import SbMain
  58. from lmgr.workspace import WorkspaceManager
  59. from lmgr.pyshell import PyShellWindow
  60. from lmgr.giface import (
  61. LayerManagerGrassInterface,
  62. LayerManagerGrassInterfaceForMapDisplay,
  63. )
  64. from mapdisp.frame import MapPanel
  65. from datacatalog.catalog import DataCatalog
  66. from gui_core.forms import GUI
  67. from gui_core.wrap import Menu, TextEntryDialog, SimpleTabArt
  68. from startup.guiutils import (
  69. can_switch_mapset_interactive,
  70. switch_mapset_interactively,
  71. create_mapset_interactively,
  72. create_location_interactively,
  73. )
  74. from grass.grassdb.checks import is_first_time_user
  75. class GMFrame(wx.Frame):
  76. """Single Window Layout which will be parallelly developed next to the
  77. current Multi Window layout solution."""
  78. def __init__(
  79. self,
  80. parent,
  81. id=wx.ID_ANY,
  82. title=None,
  83. workspace=None,
  84. size=wx.Display().GetGeometry().GetSize(),
  85. style=wx.DEFAULT_FRAME_STYLE,
  86. **kwargs,
  87. ):
  88. self.parent = parent
  89. if title:
  90. self.baseTitle = title
  91. else:
  92. self.baseTitle = _("GRASS GIS")
  93. self.iconsize = (16, 16)
  94. self.size = size
  95. self.displayIndex = 0 # index value for map displays and layer trees
  96. self.currentPage = None # currently selected page for layer tree notebook
  97. self.currentPageNum = (
  98. None # currently selected page number for layer tree notebook
  99. )
  100. self.cwdPath = None # current working directory
  101. wx.Frame.__init__(self, parent=parent, id=id, size=size, style=style, **kwargs)
  102. self._giface = LayerManagerGrassInterface(self)
  103. # workspace manager
  104. self.workspace_manager = WorkspaceManager(lmgr=self, giface=self._giface)
  105. self._setTitle()
  106. self.SetName("LayerManager")
  107. self.SetIcon(
  108. wx.Icon(os.path.join(globalvar.ICONDIR, "grass.ico"), wx.BITMAP_TYPE_ICO)
  109. )
  110. menu_errors = []
  111. def add_menu_error(message):
  112. menu_errors.append(message)
  113. def show_menu_errors(messages):
  114. if messages:
  115. self._gconsole.WriteError(
  116. _("There were some issues when loading menu" " or Tools:")
  117. )
  118. for message in messages:
  119. self._gconsole.WriteError(message)
  120. # the main menu bar
  121. self._menuTreeBuilder = LayerManagerMenuData(message_handler=add_menu_error)
  122. # the search tree and command console
  123. self._moduleTreeBuilder = LayerManagerModuleTree(message_handler=add_menu_error)
  124. self._auimgr = aui.AuiManager(self)
  125. # list of open dialogs
  126. self.dialogs = dict()
  127. self.dialogs["preferences"] = None
  128. self.dialogs["nvizPreferences"] = None
  129. self.dialogs["atm"] = list()
  130. # set pane sizes according to the full screen size of the primary monitor
  131. self.PANE_BEST_SIZE = tuple(t // 5 for t in self.size)
  132. self.PANE_MIN_SIZE = tuple(t // 8 for t in self.size)
  133. # create widgets and build panes
  134. self.CreateMenuBar()
  135. self.BuildPanes()
  136. self.BindEvents()
  137. self._giface.mapCreated.connect(self.OnMapCreated)
  138. self._giface.updateMap.connect(self._updateCurrentMap)
  139. self._giface.currentMapsetChanged.connect(self.OnMapsetChanged)
  140. # use default window layout ?
  141. if UserSettings.Get(group="general", key="defWindowPos", subkey="enabled"):
  142. dim = UserSettings.Get(group="general", key="defWindowPos", subkey="dim")
  143. try:
  144. x, y = map(int, dim.split(",")[0:2])
  145. w, h = map(int, dim.split(",")[2:4])
  146. self.SetPosition((x, y))
  147. self.SetSize((w, h))
  148. except Exception:
  149. pass
  150. else:
  151. # does center (of screen) make sense for lmgr?
  152. self.Centre()
  153. self.Layout()
  154. self.Fit()
  155. self.Show()
  156. # load workspace file if requested
  157. if workspace:
  158. if self.workspace_manager.Load(workspace):
  159. self._setTitle()
  160. else:
  161. # start default initial display
  162. self.NewDisplay(show=False)
  163. # show map display window
  164. # -> OnSize() -> UpdateMap()
  165. for mapdisp in self.GetMapDisplay(onlyCurrent=False):
  166. mapdisp.Show()
  167. # redirect stderr to log area
  168. self._gconsole.Redirect()
  169. # fix goutput's pane size (required for Mac OSX)`
  170. self.goutput.SetSashPosition(int(self.GetSize()[1] * 0.8))
  171. show_menu_errors(menu_errors)
  172. # start with layer manager on top
  173. if self.currentPage:
  174. self.GetMapDisplay().Raise()
  175. wx.CallAfter(self.Raise)
  176. self._show_demo_map()
  177. def _setTitle(self):
  178. """Set frame title"""
  179. gisenv = grass.gisenv()
  180. location = gisenv["LOCATION_NAME"]
  181. mapset = gisenv["MAPSET"]
  182. if self.workspace_manager.workspaceFile:
  183. filename = os.path.splitext(
  184. os.path.basename(self.workspace_manager.workspaceFile)
  185. )[0]
  186. self.SetTitle(
  187. "{workspace} - {location}/{mapset} - {program}".format(
  188. location=location,
  189. mapset=mapset,
  190. workspace=filename,
  191. program=self.baseTitle,
  192. )
  193. )
  194. else:
  195. self.SetTitle(
  196. "{location}/{mapset} - {program}".format(
  197. location=location, mapset=mapset, program=self.baseTitle
  198. )
  199. )
  200. def CreateMenuBar(self):
  201. """Creates menu bar"""
  202. self.menubar = GMenu(
  203. parent=self, model=self._menuTreeBuilder.GetModel(separators=True)
  204. )
  205. self.SetMenuBar(self.menubar)
  206. self.menucmd = self.menubar.GetCmd()
  207. def _createTabMenu(self):
  208. """Creates context menu for display tabs.
  209. Used to rename display.
  210. """
  211. menu = Menu()
  212. item = wx.MenuItem(menu, id=wx.ID_ANY, text=_("Rename current Map Display"))
  213. menu.AppendItem(item)
  214. self.Bind(wx.EVT_MENU, self.OnRenameDisplay, item)
  215. return menu
  216. def _setCopyingOfSelectedText(self):
  217. copy = UserSettings.Get(
  218. group="manager", key="copySelectedTextToClipboard", subkey="enabled"
  219. )
  220. self.goutput.SetCopyingOfSelectedText(copy)
  221. def IsPaneShown(self, name):
  222. """Check if pane (toolbar, ...) of given name is currently shown"""
  223. if self._auimgr.GetPane(name).IsOk():
  224. return self._auimgr.GetPane(name).IsShown()
  225. return False
  226. def SetStatusText(self, *args):
  227. """Overide SbMain statusbar method"""
  228. self.statusbar.SetStatusText(*args)
  229. def _createMapNotebook(self):
  230. """Create Map Display notebook"""
  231. # create the notebook off-window to avoid flicker
  232. client_size = self.GetClientSize()
  233. notebook_style = (
  234. aui.AUI_NB_DEFAULT_STYLE | aui.AUI_NB_TAB_EXTERNAL_MOVE | wx.NO_BORDER
  235. )
  236. self.mapnotebook = aui.AuiNotebook(
  237. self,
  238. -1,
  239. wx.Point(client_size.x, client_size.y),
  240. wx.Size(430, 200),
  241. agwStyle=notebook_style,
  242. )
  243. self.mapnotebook.SetArtProvider(SimpleTabArt())
  244. # bindings
  245. self.mapnotebook.Bind(
  246. aui.EVT_AUINOTEBOOK_PAGE_CHANGED,
  247. lambda evt: self.mapnotebook.GetCurrentPage().onFocus.emit(),
  248. )
  249. self.mapnotebook.Bind(
  250. aui.EVT_AUINOTEBOOK_PAGE_CLOSE,
  251. self.OnMapNotebookClose,
  252. )
  253. def _createDataCatalog(self, parent):
  254. """Initialize Data Catalog widget"""
  255. self.datacatalog = DataCatalog(parent=parent, giface=self._giface)
  256. self.datacatalog.showNotification.connect(
  257. lambda message: self.SetStatusText(message)
  258. )
  259. def _createDisplay(self, parent):
  260. """Initialize Display widget"""
  261. # create display notebook
  262. self.notebookLayers = GNotebook(parent=parent, style=globalvar.FNPageStyle)
  263. menu = self._createTabMenu()
  264. self.notebookLayers.SetRightClickMenu(menu)
  265. # bindings
  266. self.notebookLayers.Bind(FN.EVT_FLATNOTEBOOK_PAGE_CHANGED, self.OnCBPageChanged)
  267. self.notebookLayers.Bind(FN.EVT_FLATNOTEBOOK_PAGE_CLOSING, self.OnCBPageClosing)
  268. def _createSearchModule(self, parent):
  269. """Initialize Search module widget"""
  270. if not UserSettings.Get(group="manager", key="hideTabs", subkey="search"):
  271. self.search = SearchModuleWindow(
  272. parent=parent,
  273. handlerObj=self,
  274. giface=self._giface,
  275. model=self._moduleTreeBuilder.GetModel(),
  276. )
  277. self.search.showNotification.connect(
  278. lambda message: self.SetStatusText(message)
  279. )
  280. else:
  281. self.search = None
  282. def _createConsole(self, parent):
  283. """Initialize Console widget"""
  284. # create 'command output' text area
  285. self._gconsole = GConsole(
  286. guiparent=self,
  287. giface=self._giface,
  288. ignoredCmdPattern=r"^d\..*|^r[3]?\.mapcalc$|^i.group$|^r.import$|"
  289. "^r.external$|^r.external.out$|"
  290. "^v.import$|^v.external$|^v.external.out$|"
  291. "^cd$|^cd .*",
  292. )
  293. # create 'console' widget
  294. self.goutput = GConsoleWindow(
  295. parent=parent,
  296. giface=self._giface,
  297. gconsole=self._gconsole,
  298. menuModel=self._moduleTreeBuilder.GetModel(),
  299. gcstyle=GC_PROMPT,
  300. )
  301. self.goutput.showNotification.connect(
  302. lambda message: self.SetStatusText(message)
  303. )
  304. self.goutput.contentChanged.connect(
  305. lambda notification: self._focusPage(notification)
  306. )
  307. self._gconsole.mapCreated.connect(self.OnMapCreated)
  308. self._gconsole.Bind(
  309. EVT_IGNORED_CMD_RUN, lambda event: self.RunSpecialCmd(event.cmd)
  310. )
  311. self._setCopyingOfSelectedText()
  312. def _createPythonShell(self, parent):
  313. """Initialize Python shell widget"""
  314. if not UserSettings.Get(group="manager", key="hideTabs", subkey="pyshell"):
  315. self.pyshell = PyShellWindow(
  316. parent=parent,
  317. giface=self._giface,
  318. simpleEditorHandler=self.OnSimpleEditor,
  319. )
  320. else:
  321. self.pyshell = None
  322. def OnNewDisplay(self, event=None):
  323. """Create new layer tree and map display window instance"""
  324. self.NewDisplay()
  325. def NewDisplay(self, name=None, show=True):
  326. """Create new layer tree structure and associated map display and
  327. add it to display notebook tab
  328. :param name: name of new map display window
  329. :param show: show map display window if True
  330. """
  331. Debug.msg(1, "GMFrame.NewDisplay(): idx=%d" % self.displayIndex)
  332. if not name:
  333. name = _("Map Display {number}").format(number=self.displayIndex + 1)
  334. # make a new page in the bookcontrol for the layer tree (on page 0 of
  335. # the notebook)
  336. self.pg_panel = wx.Panel(
  337. self.notebookLayers, id=wx.ID_ANY, style=wx.BORDER_NONE
  338. )
  339. # create display toolbar
  340. dmgrToolbar = DisplayPanelToolbar(guiparent=self.pg_panel, parent=self)
  341. self.notebookLayers.AddPage(page=self.pg_panel, text=name, select=True)
  342. self.currentPage = self.notebookLayers.GetCurrentPage()
  343. self.currentPageNum = self.notebookLayers.GetSelection()
  344. self.notebookLayers.EnsureVisible(self.currentPageNum)
  345. def CreateNewMapDisplay(layertree):
  346. """Callback function which creates a new Map Display window
  347. :param layertree: layer tree object
  348. :return: reference to mapdisplay instance
  349. """
  350. # create instance of Map Display interface
  351. self._gifaceForDisplay = LayerManagerGrassInterfaceForMapDisplay(
  352. self._giface, layertree
  353. )
  354. # create Map Display
  355. mapdisplay = MapPanel(
  356. parent=self.mapnotebook,
  357. giface=self._gifaceForDisplay,
  358. id=wx.ID_ANY,
  359. tree=layertree,
  360. lmgr=self,
  361. Map=layertree.Map,
  362. title=name,
  363. size=globalvar.MAP_WINDOW_SIZE,
  364. )
  365. # add map display panel to notebook and make it current
  366. self.mapnotebook.AddPage(mapdisplay, name)
  367. self.mapnotebook.SetSelection(self.currentPageNum)
  368. # set map display properties
  369. self._setUpMapDisplay(mapdisplay)
  370. return mapdisplay
  371. # create layer tree (tree control for managing GIS layers) and put on
  372. # new notebook page and new map display frame
  373. self.currentPage.maptree = LayerTree(
  374. parent=self.currentPage,
  375. giface=self._giface,
  376. createNewMapDisplay=CreateNewMapDisplay,
  377. id=wx.ID_ANY,
  378. pos=wx.DefaultPosition,
  379. size=wx.DefaultSize,
  380. style=wx.TR_HAS_BUTTONS
  381. | wx.TR_LINES_AT_ROOT
  382. | wx.TR_HIDE_ROOT
  383. | wx.TR_DEFAULT_STYLE
  384. | wx.NO_BORDER
  385. | wx.FULL_REPAINT_ON_RESIZE,
  386. lmgr=self,
  387. notebook=self.notebookLayers,
  388. title=name,
  389. )
  390. # layout for controls
  391. cb_boxsizer = wx.BoxSizer(wx.VERTICAL)
  392. cb_boxsizer.Add(dmgrToolbar, proportion=0, flag=wx.EXPAND)
  393. cb_boxsizer.Add(self.GetLayerTree(), proportion=1, flag=wx.EXPAND, border=1)
  394. self.currentPage.SetSizer(cb_boxsizer)
  395. cb_boxsizer.Fit(self.GetLayerTree())
  396. self.currentPage.Layout()
  397. self.GetLayerTree().Layout()
  398. self.displayIndex += 1
  399. return self.GetMapDisplay()
  400. def _setUpMapDisplay(self, mapdisplay):
  401. """Set up Map Display properties"""
  402. page = self.currentPage
  403. def CanCloseDisplay(askIfSaveWorkspace):
  404. """Callback to check if user wants to close display. Map
  405. Display index can be different from index in Display tab.
  406. :return dict/None pgnum_dict/None: dict "layers" key represent
  407. map display notebook layers
  408. tree page index and
  409. "mapnotebook" key represent
  410. map display notebook page
  411. index (single window mode)
  412. """
  413. pgnum_dict = {}
  414. pgnum_dict["layers"] = self.notebookLayers.GetPageIndex(page)
  415. pgnum_dict["mapnotebook"] = self.mapnotebook.GetPageIndex(mapdisplay)
  416. name = self.notebookLayers.GetPageText(pgnum_dict["layers"])
  417. caption = _("Close Map Display {}").format(name)
  418. if not askIfSaveWorkspace or (
  419. askIfSaveWorkspace and self.workspace_manager.CanClosePage(caption)
  420. ):
  421. return pgnum_dict
  422. return None
  423. mapdisplay.canCloseDisplayCallback = CanCloseDisplay
  424. # bind various events
  425. mapdisplay.onFocus.connect(
  426. lambda page=self.currentPage: self._onMapDisplayFocus(page),
  427. )
  428. mapdisplay.starting3dMode.connect(
  429. lambda firstTime, mapDisplayPage=self.currentPage: self._onStarting3dMode(
  430. mapDisplayPage
  431. )
  432. )
  433. mapdisplay.starting3dMode.connect(self.AddNvizTools)
  434. mapdisplay.ending3dMode.connect(self.RemoveNvizTools)
  435. mapdisplay.closingDisplay.connect(self._closePageNoEvent)
  436. # set default properties
  437. mapdisplay.SetProperties(
  438. render=UserSettings.Get(
  439. group="display", key="autoRendering", subkey="enabled"
  440. ),
  441. mode=UserSettings.Get(
  442. group="display", key="statusbarMode", subkey="selection"
  443. ),
  444. alignExtent=UserSettings.Get(
  445. group="display", key="alignExtent", subkey="enabled"
  446. ),
  447. constrainRes=UserSettings.Get(
  448. group="display", key="compResolution", subkey="enabled"
  449. ),
  450. showCompExtent=UserSettings.Get(
  451. group="display", key="showCompExtent", subkey="enabled"
  452. ),
  453. )
  454. def BuildPanes(self):
  455. """Build panes - toolbars as well as panels"""
  456. self._auimgr.SetAutoNotebookTabArt(SimpleTabArt())
  457. # initialize all main widgets
  458. self.statusbar = SbMain(parent=self, giface=self._giface)
  459. self._createMapNotebook()
  460. self._createDataCatalog(parent=self)
  461. self._createDisplay(parent=self)
  462. self._createSearchModule(parent=self)
  463. self._createConsole(parent=self)
  464. self._createPythonShell(parent=self)
  465. self.toolbars = {
  466. "workspace": LMWorkspaceToolbar(parent=self),
  467. "tools": LMToolsToolbar(parent=self),
  468. "misc": LMMiscToolbar(parent=self),
  469. "nviz": LMNvizToolbar(parent=self),
  470. }
  471. self._toolbarsData = {
  472. "workspace": (
  473. "toolbarWorkspace", # name
  474. _("Workspace Toolbar"), # caption
  475. 1,
  476. 0,
  477. ), # row, position
  478. "tools": ("toolbarTools", _("Tools Toolbar"), 1, 1),
  479. "misc": ("toolbarMisc", _("Misc Toolbar"), 1, 2),
  480. "nviz": ("toolbarNviz", _("3D view Toolbar"), 1, 3),
  481. }
  482. # add a bunch of panes
  483. toolbarsList = ("workspace", "tools", "misc", "nviz")
  484. for toolbar in toolbarsList:
  485. name, caption, row, position = self._toolbarsData[toolbar]
  486. self._auimgr.AddPane(
  487. self.toolbars[toolbar],
  488. aui.AuiPaneInfo()
  489. .Name(name)
  490. .Caption(caption)
  491. .ToolbarPane()
  492. .Top()
  493. .Row(row)
  494. .Position(position)
  495. .LeftDockable(False)
  496. .RightDockable(False)
  497. .BottomDockable(False)
  498. .TopDockable(True)
  499. .CloseButton(False)
  500. .Layer(2)
  501. .BestSize((self.toolbars[toolbar].GetBestSize())),
  502. )
  503. self._auimgr.AddPane(
  504. self.mapnotebook,
  505. aui.AuiPaneInfo().Name("map display content").CenterPane().PaneBorder(True),
  506. )
  507. self._auimgr.AddPane(
  508. self.statusbar.GetWidget(),
  509. aui.AuiPaneInfo()
  510. .Bottom()
  511. .MinSize(30, 30)
  512. .Fixed()
  513. .Name("statusbar")
  514. .CloseButton(False)
  515. .DestroyOnClose(True)
  516. .ToolbarPane()
  517. .Dockable(False)
  518. .PaneBorder(False)
  519. .Gripper(False),
  520. )
  521. self._auimgr.AddPane(
  522. self.datacatalog,
  523. aui.AuiPaneInfo()
  524. .Name("datacatalog")
  525. .Caption("Data Catalog")
  526. .Left()
  527. .Layer(1)
  528. .Position(1)
  529. .BestSize(self.PANE_BEST_SIZE)
  530. .MinSize(self.PANE_MIN_SIZE)
  531. .CloseButton(False)
  532. .MinimizeButton(True)
  533. .MaximizeButton(True),
  534. )
  535. self._auimgr.AddPane(
  536. self.notebookLayers,
  537. aui.AuiPaneInfo()
  538. .Name("layers")
  539. .Caption("Layers")
  540. .Left()
  541. .Layer(1)
  542. .Position(2)
  543. .BestSize(self.PANE_BEST_SIZE)
  544. .MinSize(self.PANE_MIN_SIZE)
  545. .CloseButton(False)
  546. .MinimizeButton(True)
  547. .MaximizeButton(True),
  548. )
  549. self._auimgr.AddPane(
  550. self.search,
  551. aui.AuiPaneInfo()
  552. .Name("tools")
  553. .Caption("Tools")
  554. .Right()
  555. .Layer(1)
  556. .Position(1)
  557. .BestSize(self.PANE_BEST_SIZE)
  558. .MinSize(self.PANE_MIN_SIZE)
  559. .CloseButton(False)
  560. .MinimizeButton(True)
  561. .MaximizeButton(True),
  562. )
  563. self._auimgr.AddPane(
  564. self.goutput,
  565. aui.AuiPaneInfo()
  566. .Name("console")
  567. .Caption("Console")
  568. .Right()
  569. .BestSize(self.PANE_BEST_SIZE)
  570. .MinSize(self.PANE_MIN_SIZE)
  571. .CloseButton(False)
  572. .MinimizeButton(True)
  573. .MaximizeButton(True),
  574. target=self._auimgr.GetPane("tools"),
  575. )
  576. self._auimgr.AddPane(
  577. self.pyshell,
  578. aui.AuiPaneInfo()
  579. .Name("python")
  580. .Caption("Python")
  581. .Right()
  582. .BestSize(self.PANE_BEST_SIZE)
  583. .MinSize(self.PANE_MIN_SIZE)
  584. .CloseButton(False)
  585. .MinimizeButton(True)
  586. .MaximizeButton(True),
  587. target=self._auimgr.GetPane("tools"),
  588. )
  589. self._auimgr.GetPane("toolbarNviz").Hide()
  590. # Set Tools as active tab
  591. tools = self._auimgr.GetPane("tools")
  592. notebook = self._auimgr.GetNotebooks()[0]
  593. notebook.SetSelectionToPage(tools)
  594. # Set the size for automatic notebook
  595. pane = self._auimgr.GetPane(notebook)
  596. pane.BestSize(self.PANE_BEST_SIZE)
  597. pane.MinSize(self.PANE_MIN_SIZE)
  598. wx.CallAfter(self.datacatalog.LoadItems)
  599. self._auimgr.Update()
  600. def BindEvents(self):
  601. # bindings
  602. self.Bind(wx.EVT_CLOSE, self.OnCloseWindowOrExit)
  603. self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDown)
  604. def _show_demo_map(self):
  605. """If in demolocation, add demo map to map display
  606. This provides content for first-time user experience.
  607. """
  608. def show_demo():
  609. layer_name = "country_boundaries@PERMANENT"
  610. exists = grass.find_file(name=layer_name, element="vector")["name"]
  611. if not exists:
  612. # Do not fail nor report errors to the first-time user when not found.
  613. Debug.msg(
  614. 5, "GMFrame._show_demo_map(): {} does not exist".format(layer_name)
  615. )
  616. return
  617. self.GetLayerTree().AddLayer(
  618. ltype="vector",
  619. lname=layer_name,
  620. lchecked=True,
  621. lcmd=["d.vect", "map={}".format(layer_name)],
  622. )
  623. if is_first_time_user():
  624. # Show only after everything is initialized for proper map alignment.
  625. wx.CallLater(1000, show_demo)
  626. def AddNvizTools(self, firstTime):
  627. """Add nviz notebook page
  628. :param firstTime: if a mapdisplay is starting 3D mode for the
  629. first time
  630. """
  631. Debug.msg(5, "GMFrame.AddNvizTools()")
  632. from nviz.main import haveNviz
  633. if not haveNviz:
  634. return
  635. from nviz.main import NvizToolWindow
  636. # show toolbar
  637. self._auimgr.GetPane("toolbarNviz").Show()
  638. # reorder other toolbars
  639. for pos, toolbar in enumerate(
  640. ("toolbarWorkspace", "toolbarTools", "toolbarMisc", "toolbarNviz")
  641. ):
  642. self._auimgr.GetPane(toolbar).Row(1).Position(pos)
  643. # create nviz tools tab
  644. self.nviz = NvizToolWindow(
  645. parent=self, tree=self.GetLayerTree(), display=self.GetMapDisplay()
  646. )
  647. self._auimgr.AddPane(
  648. self.nviz,
  649. aui.AuiPaneInfo()
  650. .Name("nviz")
  651. .Caption("3D view")
  652. .Left()
  653. .Layer(1)
  654. .Position(3)
  655. .BestSize(self.PANE_BEST_SIZE)
  656. .MinSize(self.PANE_MIN_SIZE)
  657. .CloseButton(False)
  658. .MinimizeButton(True)
  659. .MaximizeButton(True),
  660. )
  661. self._auimgr.GetPane("nviz").Show()
  662. self._auimgr.Update()
  663. # this is a bit strange here since a new window is created everytime
  664. if not firstTime:
  665. for page in ("view", "light", "fringe", "constant", "cplane", "animation"):
  666. self.nviz.UpdatePage(page)
  667. def RemoveNvizTools(self):
  668. """Remove nviz notebook page"""
  669. # if more mapwindow3D were possible, check here if nb page should be
  670. # removed
  671. # hide toolbar
  672. self._auimgr.GetPane("toolbarNviz").Hide()
  673. for pos, toolbar in enumerate(
  674. ("toolbarWorkspace", "toolbarTools", "toolbarMisc")
  675. ):
  676. self._auimgr.GetPane(toolbar).Row(1).Position(pos)
  677. self._auimgr.DetachPane(self.nviz)
  678. self.nviz.Destroy()
  679. self._auimgr.Update()
  680. def OnLocationWizard(self, event):
  681. """Launch location wizard"""
  682. gisenv = grass.gisenv()
  683. grassdb, location, mapset = create_location_interactively(
  684. self, gisenv["GISDBASE"]
  685. )
  686. if location:
  687. self._giface.grassdbChanged.emit(
  688. grassdb=grassdb, location=location, action="new", element="location"
  689. )
  690. if grassdb == gisenv["GISDBASE"]:
  691. switch_grassdb = None
  692. else:
  693. switch_grassdb = grassdb
  694. if can_switch_mapset_interactive(self, grassdb, location, mapset):
  695. switch_mapset_interactively(
  696. self,
  697. self._giface,
  698. switch_grassdb,
  699. location,
  700. mapset,
  701. show_confirmation=True,
  702. )
  703. def OnSettingsChanged(self):
  704. """Here can be functions which have to be called
  705. after receiving settingsChanged signal.
  706. Now only set copying of selected text to clipboard (in goutput).
  707. """
  708. # self._createMenuBar() # bug when menu is re-created on the fly
  709. self._setCopyingOfSelectedText()
  710. def OnGCPManager(self, event=None, cmd=None):
  711. """Launch georectifier module. See OnIClass documentation"""
  712. from gcp.manager import GCPWizard
  713. GCPWizard(self, self._giface)
  714. def OnGModeler(self, event=None, cmd=None):
  715. """Launch Graphical Modeler. See OnIClass documentation"""
  716. from gmodeler.frame import ModelFrame
  717. win = ModelFrame(parent=self, giface=self._giface)
  718. win.CentreOnScreen()
  719. win.Show()
  720. def OnPsMap(self, event=None, cmd=None):
  721. """Launch Cartographic Composer. See OnIClass documentation"""
  722. from psmap.frame import PsMapFrame
  723. win = PsMapFrame(parent=self)
  724. win.CentreOnScreen()
  725. win.Show()
  726. def OnMapSwipe(self, event=None, cmd=None):
  727. """Launch Map Swipe. See OnIClass documentation"""
  728. from mapswipe.frame import SwipeMapDisplay
  729. frame = wx.Frame(
  730. parent=None, size=globalvar.MAP_WINDOW_SIZE, title=_("Map Swipe Tool")
  731. )
  732. win = SwipeMapDisplay(
  733. parent=frame,
  734. giface=self._giface,
  735. )
  736. rasters = []
  737. tree = self.GetLayerTree()
  738. if tree:
  739. for layer in tree.GetSelections():
  740. if tree.GetLayerInfo(layer, key="maplayer").GetType() != "raster":
  741. continue
  742. rasters.append(tree.GetLayerInfo(layer, key="maplayer").GetName())
  743. if len(rasters) >= 1:
  744. win.SetFirstRaster(rasters[0])
  745. if len(rasters) >= 2:
  746. win.SetSecondRaster(rasters[1])
  747. win.SetRasterNames()
  748. win.CentreOnScreen()
  749. win.Show()
  750. def OnRLiSetup(self, event=None, cmd=None):
  751. """Launch r.li setup. See OnIClass documentation"""
  752. from rlisetup.frame import RLiSetupFrame
  753. win = RLiSetupFrame(parent=self)
  754. win.CentreOnScreen()
  755. win.Show()
  756. def OnDataCatalog(self, event=None, cmd=None):
  757. """Launch Data Catalog"""
  758. from datacatalog.frame import DataCatalogFrame
  759. win = DataCatalogFrame(parent=self, giface=self._giface)
  760. win.CentreOnScreen()
  761. win.Show()
  762. def OnDone(self, event):
  763. """Command execution finished"""
  764. if hasattr(self, "model"):
  765. self.model.DeleteIntermediateData(log=self._gconsole)
  766. del self.model
  767. self.SetStatusText("")
  768. def OnRunModel(self, event):
  769. """Run model"""
  770. filename = ""
  771. dlg = wx.FileDialog(
  772. parent=self,
  773. message=_("Choose model to run"),
  774. defaultDir=os.getcwd(),
  775. wildcard=_("GRASS Model File (*.gxm)|*.gxm"),
  776. )
  777. if dlg.ShowModal() == wx.ID_OK:
  778. filename = dlg.GetPath()
  779. if not filename:
  780. dlg.Destroy()
  781. return
  782. from gmodeler.model import Model
  783. self.model = Model()
  784. self.model.LoadModel(filename)
  785. self.model.Run(log=self.GetLogWindow(), onDone=self.OnDone, parent=self)
  786. dlg.Destroy()
  787. def OnMapsets(self, event):
  788. """Launch mapset access dialog"""
  789. dlg = MapsetAccess(parent=self, id=wx.ID_ANY)
  790. dlg.CenterOnScreen()
  791. if dlg.ShowModal() == wx.ID_OK:
  792. ms = dlg.GetMapsets()
  793. RunCommand(
  794. "g.mapsets", parent=self, mapset="%s" % ",".join(ms), operation="set"
  795. )
  796. def OnCBPageChanged(self, event):
  797. """Page in notebook (display) changed.
  798. Also change active map notebook tab."""
  799. self.currentPage = self.notebookLayers.GetCurrentPage()
  800. self.currentPageNum = self.notebookLayers.GetSelection()
  801. try:
  802. self.mapnotebook.SetSelection(self.GetMapDisplayIndex())
  803. except Exception:
  804. pass
  805. event.Skip()
  806. def OnCBPageClosing(self, event):
  807. """Page of notebook is being closed
  808. from Layer Manager (x button next to arrows)
  809. Also close associated map display.
  810. """
  811. # save changes in the workspace
  812. name = self.notebookLayers.GetPageText(event.GetSelection())
  813. caption = _("Close Map Display {}").format(name)
  814. if not self.workspace_manager.CanClosePage(caption):
  815. event.Veto()
  816. return
  817. maptree = self.notebookLayers.GetPage(event.GetSelection()).maptree
  818. maptree.GetMapDisplay().CleanUp()
  819. self.mapnotebook.DeletePage(self.GetMapDisplayIndex())
  820. maptree.Close(True)
  821. self.currentPage = None
  822. event.Skip()
  823. def _closePageNoEvent(self, pgnum_dict):
  824. """Close page and destroy map display without generating notebook
  825. page closing event.
  826. :param dict pgnum_dict: dict "layers" key represent map display
  827. notebook layers tree page index and
  828. "mapnotebook" key represent map display
  829. notebook page index (single window mode)
  830. """
  831. self.notebookLayers.Unbind(FN.EVT_FLATNOTEBOOK_PAGE_CLOSING)
  832. self.notebookLayers.DeletePage(pgnum_dict["layers"])
  833. self.notebookLayers.Bind(
  834. FN.EVT_FLATNOTEBOOK_PAGE_CLOSING,
  835. self.OnCBPageClosing,
  836. )
  837. self.mapnotebook.DeletePage(pgnum_dict["mapnotebook"])
  838. def _focusPage(self, notification):
  839. """Focus the 'Console' notebook page according to event notification."""
  840. if (
  841. notification == Notification.HIGHLIGHT
  842. or notification == Notification.MAKE_VISIBLE
  843. or notification == Notification.RAISE_WINDOW
  844. ):
  845. self.FocusPage("Console")
  846. def FocusPage(self, page_text):
  847. """Focus the page if part of any of aui notebooks"""
  848. notebooks = self._auimgr.GetNotebooks()
  849. for notebook in notebooks:
  850. for i in range(notebook.GetPageCount()):
  851. if notebook.GetPageText(i) == page_text:
  852. notebook.SetSelection(i)
  853. def RunSpecialCmd(self, command):
  854. """Run command from command line, check for GUI wrappers"""
  855. if re.compile(r"^d\..*").search(command[0]):
  856. self.RunDisplayCmd(command)
  857. elif re.compile(r"r[3]?\.mapcalc").search(command[0]):
  858. self.OnMapCalculator(event=None, cmd=command)
  859. elif command[0] == "i.group":
  860. self.OnEditImageryGroups(event=None, cmd=command)
  861. elif command[0] == "r.import":
  862. self.OnImportGdalLayers(event=None, cmd=command)
  863. elif command[0] == "r.external":
  864. self.OnLinkGdalLayers(event=None, cmd=command)
  865. elif command[0] == "r.external.out":
  866. self.OnRasterOutputFormat(event=None)
  867. elif command[0] == "v.import":
  868. self.OnImportOgrLayers(event=None, cmd=command)
  869. elif command[0] == "v.external":
  870. self.OnLinkOgrLayers(event=None, cmd=command)
  871. elif command[0] == "v.external.out":
  872. self.OnVectorOutputFormat(event=None)
  873. elif command[0] == "cd":
  874. self.OnChangeCWD(event=None, cmd=command)
  875. else:
  876. raise ValueError(
  877. "Layer Manager special command (%s)"
  878. " not supported." % " ".join(command)
  879. )
  880. def RunDisplayCmd(self, command):
  881. """Handles display commands.
  882. :param command: command in a list
  883. """
  884. if not self.currentPage:
  885. self.NewDisplay(show=True)
  886. # here should be the d.* commands which are not layers
  887. if command[0] == "d.erase":
  888. # rest of d.erase is ignored
  889. self.GetLayerTree().DeleteAllLayers()
  890. return
  891. try:
  892. # display GRASS commands
  893. layertype = command2ltype[command[0]]
  894. except KeyError:
  895. GMessage(
  896. parent=self,
  897. message=_(
  898. "Command '%s' not yet implemented in the WxGUI. "
  899. "Try adding it as a command layer instead."
  900. )
  901. % command[0],
  902. )
  903. return
  904. if layertype == "barscale":
  905. if len(command) > 1:
  906. self.GetMapDisplay().AddBarscale(cmd=command)
  907. else:
  908. self.GetMapDisplay().AddBarscale()
  909. elif layertype == "rastleg":
  910. if len(command) > 1:
  911. self.GetMapDisplay().AddLegendRast(cmd=command)
  912. else:
  913. self.GetMapDisplay().AddLegendRast()
  914. elif layertype == "vectleg":
  915. if len(command) > 1:
  916. self.GetMapDisplay().AddLegendVect(cmd=command, showDialog=False)
  917. else:
  918. self.GetMapDisplay().AddLegendVect(showDialog=True)
  919. elif layertype == "northarrow":
  920. if len(command) > 1:
  921. self.GetMapDisplay().AddArrow(cmd=command)
  922. else:
  923. self.GetMapDisplay().AddArrow()
  924. elif layertype == "text":
  925. if len(command) > 1:
  926. self.GetMapDisplay().AddDtext(cmd=command)
  927. else:
  928. self.GetMapDisplay().AddDtext()
  929. elif layertype == "redraw":
  930. self.GetMapDisplay().OnRender(None)
  931. elif layertype == "export":
  932. GUI(parent=self, show=False).ParseCommand(
  933. command, completed=(self.GetMapDisplay().DOutFileOptData, "", "")
  934. )
  935. elif layertype == "torast":
  936. if len(command) <= 1:
  937. task = GUI(parent=self, show=True).ParseCommand(
  938. command, completed=(self.GetMapDisplay().DToRastOptData, "", "")
  939. )
  940. else:
  941. task = GUI(parent=self, show=None).ParseCommand(
  942. command, completed=(self.GetMapDisplay().DToRastOptData, "", "")
  943. )
  944. self.GetMapDisplay().DToRast(command=task.get_cmd())
  945. else:
  946. # add layer into layer tree
  947. lname, found = GetLayerNameFromCmd(
  948. command, fullyQualified=True, layerType=layertype
  949. )
  950. self.GetLayerTree().AddLayer(
  951. ltype=layertype,
  952. lchecked=True if lname else None,
  953. lname=lname,
  954. lcmd=command,
  955. )
  956. def GetLayerNotebook(self):
  957. """Get Layers Notebook"""
  958. return self.notebookLayers
  959. def GetLayerTree(self):
  960. """Get current layer tree
  961. :return: LayerTree instance
  962. :return: None no layer tree selected
  963. """
  964. if self.currentPage:
  965. return self.currentPage.maptree
  966. return None
  967. def GetMapDisplay(self, onlyCurrent=True):
  968. """Get current map display
  969. :param bool onlyCurrent: True to return only active mapdisplay
  970. False for list of all mapdisplays
  971. :return: MapPanel instance (or list)
  972. :return: None no mapdisplay selected
  973. """
  974. if onlyCurrent:
  975. if self.currentPage:
  976. return self.GetLayerTree().GetMapDisplay()
  977. else:
  978. return None
  979. else: # -> return list of all mapdisplays
  980. mlist = list()
  981. for idx in range(0, self.notebookLayers.GetPageCount()):
  982. mlist.append(self.notebookLayers.GetPage(idx).maptree.GetMapDisplay())
  983. return mlist
  984. def GetAllMapDisplays(self):
  985. """Get all (open) map displays"""
  986. return self.GetMapDisplay(onlyCurrent=False)
  987. def GetMapDisplayIndex(self):
  988. """Get the index of the currently active map display tab.
  989. Can be different than index of related layertree."""
  990. return self.mapnotebook.GetPageIndex(self.GetMapDisplay())
  991. def GetLogWindow(self):
  992. """Gets console for command output and messages"""
  993. return self._gconsole
  994. def GetToolbar(self, name):
  995. """Returns toolbar if exists else None"""
  996. if name in self.toolbars:
  997. return self.toolbars[name]
  998. return None
  999. def GetMenuCmd(self, event):
  1000. """Get GRASS command from menu item
  1001. :return: command as a list"""
  1002. layer = None
  1003. if event:
  1004. cmd = self.menucmd[event.GetId()]
  1005. else:
  1006. cmd = ""
  1007. try:
  1008. cmdlist = cmd.split(" ")
  1009. except Exception: # already list?
  1010. cmdlist = cmd
  1011. # check list of dummy commands for GUI modules that do not have GRASS
  1012. # bin modules or scripts.
  1013. if cmd in ["vcolors", "r.mapcalc", "r3.mapcalc"]:
  1014. return cmdlist
  1015. try:
  1016. layer = self.GetLayerTree().layer_selected
  1017. name = self.GetLayerTree().GetLayerInfo(layer, key="maplayer").name
  1018. type = self.GetLayerTree().GetLayerInfo(layer, key="type")
  1019. except Exception:
  1020. layer = None
  1021. if layer and len(cmdlist) == 1: # only if no parameters given
  1022. if (type == "raster" and cmdlist[0][0] == "r" and cmdlist[0][1] != "3") or (
  1023. type == "vector" and cmdlist[0][0] == "v"
  1024. ):
  1025. input = GUI().GetCommandInputMapParamKey(cmdlist[0])
  1026. if input:
  1027. cmdlist.append("%s=%s" % (input, name))
  1028. return cmdlist
  1029. def RunMenuCmd(self, event=None, cmd=[]):
  1030. """Run command selected from menu"""
  1031. if event:
  1032. cmd = self.GetMenuCmd(event)
  1033. self._gconsole.RunCmd(cmd)
  1034. def OnMenuCmd(self, event=None, cmd=[]):
  1035. """Parse command selected from menu"""
  1036. if event:
  1037. cmd = self.GetMenuCmd(event)
  1038. GUI(parent=self, giface=self._giface).ParseCommand(cmd)
  1039. def OnVNet(self, event):
  1040. """Vector network analysis tool"""
  1041. if self.GetMapDisplay():
  1042. self.GetMapDisplay().OnVNet(event)
  1043. else:
  1044. self.NewDisplay(show=True).OnVNet(event)
  1045. def OnVDigit(self, event):
  1046. """Start vector digitizer"""
  1047. if not self.currentPage:
  1048. self.MsgNoLayerSelected()
  1049. return
  1050. tree = self.GetLayerTree()
  1051. layer = tree.layer_selected
  1052. # no map layer selected
  1053. if not layer:
  1054. self.MsgNoLayerSelected()
  1055. return
  1056. # available only for vector map layers
  1057. try:
  1058. mapLayer = tree.GetLayerInfo(layer, key="maplayer")
  1059. except Exception:
  1060. mapLayer = None
  1061. if not mapLayer or mapLayer.GetType() != "vector":
  1062. GMessage(parent=self, message=_("Selected map layer is not vector."))
  1063. return
  1064. if mapLayer.GetMapset() != grass.gisenv()["MAPSET"]:
  1065. GMessage(
  1066. parent=self,
  1067. message=_(
  1068. "Editing is allowed only for vector maps from the "
  1069. "current mapset."
  1070. ),
  1071. )
  1072. return
  1073. if not tree.GetLayerInfo(layer):
  1074. return
  1075. dcmd = tree.GetLayerInfo(layer, key="cmd")
  1076. if not dcmd:
  1077. return
  1078. digitToolbar = self.GetMapDisplay().GetToolbar("vdigit")
  1079. if digitToolbar:
  1080. stopOnly = False
  1081. if mapLayer is digitToolbar.GetLayer():
  1082. stopOnly = True
  1083. tree.OnStopEditing(None) # TODO: change to signal
  1084. if stopOnly:
  1085. return
  1086. tree.OnStartEditing(None) # TODO: change to signal
  1087. def OnRunScript(self, event):
  1088. """Run user-defined script"""
  1089. # open dialog and choose script file
  1090. dlg = wx.FileDialog(
  1091. parent=self,
  1092. message=_("Choose script file to run"),
  1093. defaultDir=os.getcwd(),
  1094. wildcard=_("Python script (*.py)|*.py|Bash script (*.sh)|*.sh"),
  1095. )
  1096. filename = None
  1097. if dlg.ShowModal() == wx.ID_OK:
  1098. filename = dlg.GetPath()
  1099. if not filename:
  1100. return False
  1101. if not os.path.exists(filename):
  1102. GError(
  1103. parent=self,
  1104. message=_("Script file '%s' doesn't exist. " "Operation canceled.")
  1105. % filename,
  1106. )
  1107. return
  1108. # check permission
  1109. if not os.access(filename, os.X_OK):
  1110. dlg = wx.MessageDialog(
  1111. self,
  1112. message=_(
  1113. "Script <%s> is not executable. "
  1114. "Do you want to set the permissions "
  1115. "that allows you to run this script "
  1116. "(note that you must be the owner of the file)?"
  1117. % os.path.basename(filename)
  1118. ),
  1119. caption=_("Set permission?"),
  1120. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION,
  1121. )
  1122. if dlg.ShowModal() != wx.ID_YES:
  1123. return
  1124. dlg.Destroy()
  1125. try:
  1126. mode = stat.S_IMODE(os.lstat(filename)[stat.ST_MODE])
  1127. os.chmod(filename, mode | stat.S_IXUSR)
  1128. except OSError:
  1129. GError(_("Unable to set permission. Operation canceled."), parent=self)
  1130. return
  1131. # check GRASS_ADDON_PATH
  1132. addonPath = os.getenv("GRASS_ADDON_PATH", [])
  1133. if addonPath:
  1134. addonPath = addonPath.split(os.pathsep)
  1135. dirName = os.path.dirname(filename)
  1136. if dirName not in addonPath:
  1137. addonPath.append(dirName)
  1138. dlg = wx.MessageDialog(
  1139. self,
  1140. message=_(
  1141. "Directory '%s' is not defined in GRASS_ADDON_PATH. "
  1142. "Do you want add this directory to GRASS_ADDON_PATH?"
  1143. )
  1144. % dirName,
  1145. caption=_("Update Addons path?"),
  1146. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION,
  1147. )
  1148. if dlg.ShowModal() == wx.ID_YES:
  1149. SetAddOnPath(os.pathsep.join(addonPath), key="PATH")
  1150. dlg.Destroy()
  1151. self._gconsole.WriteCmdLog(_("Launching script '%s'...") % filename)
  1152. self._gconsole.RunCmd([filename])
  1153. def OnChangeLocation(self, event):
  1154. """Change current location"""
  1155. dlg = LocationDialog(parent=self)
  1156. gisenv = grass.gisenv()
  1157. if dlg.ShowModal() == wx.ID_OK:
  1158. location, mapset = dlg.GetValues()
  1159. dlg.Destroy()
  1160. if not location or not mapset:
  1161. GError(
  1162. parent=self,
  1163. message=_("No location/mapset provided. Operation canceled."),
  1164. )
  1165. return # this should not happen
  1166. if can_switch_mapset_interactive(
  1167. self, gisenv["GISDBASE"], location, mapset
  1168. ):
  1169. switch_mapset_interactively(self, self._giface, None, location, mapset)
  1170. def OnCreateMapset(self, event):
  1171. """Create new mapset"""
  1172. gisenv = grass.gisenv()
  1173. mapset = create_mapset_interactively(
  1174. self, gisenv["GISDBASE"], gisenv["LOCATION_NAME"]
  1175. )
  1176. if mapset:
  1177. self._giface.grassdbChanged.emit(
  1178. grassdb=gisenv["GISDBASE"],
  1179. location=gisenv["LOCATION_NAME"],
  1180. mapset=mapset,
  1181. action="new",
  1182. element="mapset",
  1183. )
  1184. if can_switch_mapset_interactive(
  1185. self, gisenv["GISDBASE"], gisenv["LOCATION_NAME"], mapset
  1186. ):
  1187. switch_mapset_interactively(
  1188. self, self._giface, None, None, mapset, show_confirmation=True
  1189. )
  1190. def OnChangeMapset(self, event):
  1191. """Change current mapset"""
  1192. dlg = MapsetDialog(parent=self)
  1193. gisenv = grass.gisenv()
  1194. if dlg.ShowModal() == wx.ID_OK:
  1195. mapset = dlg.GetMapset()
  1196. dlg.Destroy()
  1197. if not mapset:
  1198. GError(
  1199. parent=self, message=_("No mapset provided. Operation canceled.")
  1200. )
  1201. return
  1202. if can_switch_mapset_interactive(
  1203. self, gisenv["GISDBASE"], gisenv["LOCATION_NAME"], mapset
  1204. ):
  1205. switch_mapset_interactively(self, self._giface, None, None, mapset)
  1206. def OnMapsetChanged(self, dbase, location, mapset):
  1207. """Current mapset changed.
  1208. If location is None, mapset changed within location.
  1209. """
  1210. if not location:
  1211. self._setTitle()
  1212. else:
  1213. # close current workspace and create new one
  1214. self.OnWorkspaceClose()
  1215. self.OnWorkspaceNew()
  1216. def OnChangeCWD(self, event=None, cmd=None):
  1217. """Change current working directory
  1218. :param event: to be able to serve as a handler of wx event
  1219. :param cmd: command as a list (must start with 'cd')
  1220. """
  1221. # local functions
  1222. def write_beginning(parameter=None, command=None):
  1223. if parameter:
  1224. self._giface.WriteCmdLog('cd "' + parameter + '"')
  1225. else:
  1226. # naive concat but will be enough most of the time
  1227. self._giface.WriteCmdLog(" ".join(command))
  1228. def write_changed():
  1229. self._giface.WriteLog(
  1230. _('Working directory changed to:\n"%s"') % os.getcwd()
  1231. )
  1232. def write_end():
  1233. self._giface.WriteCmdLog(" ")
  1234. def write_help():
  1235. self._giface.WriteLog(
  1236. _("Changes current working directory" " for this GUI.")
  1237. )
  1238. self._giface.WriteLog(_("Usage: cd [directory]"))
  1239. self._giface.WriteLog(_("Without parameters it opens a dialog."))
  1240. # TODO: the following is longer then 80 chars
  1241. # but this should be solved by the function not caller
  1242. # also because of translations
  1243. self._giface.WriteLog(
  1244. _(
  1245. "If ~ (tilde) is present as the first"
  1246. " directory on the path, it is replaced"
  1247. " by user's home directory."
  1248. )
  1249. )
  1250. # check correctness of cmd
  1251. if cmd and cmd[0] != "cd":
  1252. # this is programmer's error
  1253. # can be relaxed in future
  1254. # but keep it strict unless needed otherwise
  1255. raise ValueError(
  1256. "OnChangeCWD cmd parameter must be list of"
  1257. " length 1 or 2 and 'cd' as a first item"
  1258. )
  1259. if cmd and len(cmd) > 2:
  1260. # this might be a user error
  1261. write_beginning(command=cmd)
  1262. self._giface.WriteError(_("More than one parameter provided."))
  1263. write_help()
  1264. write_end()
  1265. return
  1266. # use chdir or dialog
  1267. if cmd and len(cmd) == 2:
  1268. write_beginning(parameter=cmd[1])
  1269. if cmd[1] in ["-h", "--h", "--help", "help"]:
  1270. write_help()
  1271. write_end()
  1272. return
  1273. try:
  1274. path = os.path.expanduser(cmd[1])
  1275. os.chdir(path)
  1276. write_changed()
  1277. except OSError as error:
  1278. self._giface.WriteError(str(error))
  1279. write_end()
  1280. else:
  1281. dlg = wx.DirDialog(
  1282. parent=self,
  1283. message=_("Choose a working directory"),
  1284. defaultPath=os.getcwd(),
  1285. )
  1286. if dlg.ShowModal() == wx.ID_OK:
  1287. self.cwdPath = dlg.GetPath() # is saved in the workspace
  1288. write_beginning(parameter=self.cwdPath)
  1289. os.chdir(self.cwdPath)
  1290. write_changed()
  1291. write_end()
  1292. def GetCwdPath(self):
  1293. """Get current working directory or None"""
  1294. return self.cwdPath
  1295. def OnNewVector(self, event):
  1296. """Create new vector map layer"""
  1297. dlg = CreateNewVector(
  1298. self, giface=self._giface, cmd=(("v.edit", {"tool": "create"}, "map"))
  1299. )
  1300. if not dlg:
  1301. return
  1302. name = dlg.GetName(full=True)
  1303. if name and dlg.IsChecked("add"):
  1304. # add layer to map layer tree
  1305. self.GetLayerTree().AddLayer(
  1306. ltype="vector",
  1307. lname=name,
  1308. lchecked=True,
  1309. lcmd=["d.vect", "map=%s" % name],
  1310. )
  1311. dlg.Destroy()
  1312. def OnSystemInfo(self, event):
  1313. """Print system information"""
  1314. vInfo = grass.version()
  1315. if not vInfo:
  1316. sys.stderr.write(_("Unable to get GRASS version\n"))
  1317. # check also OSGeo4W on MS Windows
  1318. if sys.platform == "win32" and not os.path.exists(
  1319. os.path.join(os.getenv("GISBASE"), "WinGRASS-README.url")
  1320. ):
  1321. osgeo4w = " (OSGeo4W)"
  1322. else:
  1323. osgeo4w = ""
  1324. self._gconsole.WriteCmdLog(_("System Info"))
  1325. # platform decoding was added because of the Fedora 19 release
  1326. # which has the name "Schrödinger’s cat" (umlaut and special ' character)
  1327. # which appears in the platform.platform() string
  1328. platform_ = decode(platform.platform())
  1329. self._gconsole.WriteLog(
  1330. "%s: %s\n" "%s: %s\n" "%s: %s\n" "%s: %s\n"
  1331. # "%s: %s (%s)\n"
  1332. "GDAL: %s\n"
  1333. "PROJ: %s\n"
  1334. "GEOS: %s\n"
  1335. "SQLite: %s\n"
  1336. "Python: %s\n"
  1337. "wxPython: %s\n"
  1338. "%s: %s%s\n"
  1339. % (
  1340. _("GRASS version"),
  1341. vInfo.get("version", _("unknown version")),
  1342. _("Code revision"),
  1343. vInfo.get("revision", "?"),
  1344. _("Build date"),
  1345. vInfo.get("build_date", "?"),
  1346. _("Build platform"),
  1347. vInfo.get("build_platform", "?"),
  1348. # _("GIS Library Revision"),
  1349. # vInfo.get('libgis_revision'],
  1350. # vInfo.get('libgis_date'].split('
  1351. # ', 1)[0],
  1352. vInfo.get("gdal", "?"),
  1353. vInfo.get("proj", "?"),
  1354. vInfo.get("geos", "?"),
  1355. vInfo.get("sqlite", "?"),
  1356. platform.python_version(),
  1357. wx.__version__,
  1358. _("Platform"),
  1359. platform_,
  1360. osgeo4w,
  1361. ),
  1362. notification=Notification.MAKE_VISIBLE,
  1363. )
  1364. self._gconsole.WriteCmdLog(" ")
  1365. def OnAboutGRASS(self, event):
  1366. """Display 'About GRASS' dialog"""
  1367. from gui_core.ghelp import AboutWindow
  1368. win = AboutWindow(self)
  1369. win.CentreOnScreen()
  1370. win.Show(True)
  1371. def _popupMenu(self, data):
  1372. """Create popup menu"""
  1373. menu = Menu()
  1374. for key, handler in data:
  1375. if key is None:
  1376. menu.AppendSeparator()
  1377. continue
  1378. item = wx.MenuItem(menu, wx.ID_ANY, LMIcons[key].GetLabel())
  1379. item.SetBitmap(LMIcons[key].GetBitmap(self.iconsize))
  1380. menu.AppendItem(item)
  1381. self.Bind(wx.EVT_MENU, handler, item)
  1382. # create menu
  1383. self.PopupMenu(menu)
  1384. menu.Destroy()
  1385. def OnWorkspaceNew(self, event=None):
  1386. """Create new workspace file"""
  1387. self.workspace_manager.New()
  1388. def OnWorkspaceOpen(self, event=None):
  1389. """Open file with workspace definition"""
  1390. self.workspace_manager.Open()
  1391. def OnWorkspaceSave(self, event=None):
  1392. """Save file with workspace definition"""
  1393. self.workspace_manager.Save()
  1394. def OnWorkspaceSaveAs(self, event=None):
  1395. """Save workspace definition to selected file"""
  1396. self.workspace_manager.SaveAs()
  1397. def OnWorkspaceClose(self, event=None):
  1398. """Close file with workspace definition"""
  1399. self.workspace_manager.Close()
  1400. def OnDisplayClose(self, event=None):
  1401. """Close current map display window"""
  1402. if self.currentPage and self.GetMapDisplay():
  1403. self.GetMapDisplay().OnCloseWindow(event)
  1404. def OnDisplayCloseAll(self, event):
  1405. """Close all open map display windows (from menu)"""
  1406. if not self.workspace_manager.CanClosePage(caption=_("Close all Map Displays")):
  1407. return
  1408. self.DisplayCloseAll()
  1409. def DisplayCloseAll(self):
  1410. """Close all open map display windows"""
  1411. for display in self.GetMapDisplay(onlyCurrent=False):
  1412. display.OnCloseWindow(event=None, askIfSaveWorkspace=False)
  1413. def OnRenderAllMapDisplays(self, event=None):
  1414. for display in self.GetAllMapDisplays():
  1415. display.OnRender(None)
  1416. def OnRenameDisplay(self, event):
  1417. """Change Map Display name"""
  1418. name = self.notebookLayers.GetPageText(self.currentPageNum)
  1419. dlg = TextEntryDialog(
  1420. self,
  1421. message=_("Enter new name:"),
  1422. caption=_("Rename Map Display"),
  1423. value=name,
  1424. )
  1425. if dlg.ShowModal() == wx.ID_OK:
  1426. name = dlg.GetValue()
  1427. self.notebookLayers.SetPageText(page=self.currentPageNum, text=name)
  1428. self.mapnotebook.SetPageText(page_idx=self.GetMapDisplayIndex(), text=name)
  1429. dlg.Destroy()
  1430. def OnRasterRules(self, event):
  1431. """Launches dialog for raster color rules"""
  1432. from modules.colorrules import RasterColorTable
  1433. ctable = RasterColorTable(self, layerTree=self.GetLayerTree())
  1434. ctable.Show()
  1435. ctable.CentreOnScreen()
  1436. def OnVectorRules(self, event):
  1437. """Launches dialog for vector color rules"""
  1438. from modules.colorrules import VectorColorTable
  1439. ctable = VectorColorTable(
  1440. self, layerTree=self.GetLayerTree(), attributeType="color"
  1441. )
  1442. ctable.Show()
  1443. ctable.CentreOnScreen()
  1444. def OnEditImageryGroups(self, event, cmd=None):
  1445. """Show dialog for creating and editing groups."""
  1446. dlg = GroupDialog(self)
  1447. dlg.CentreOnScreen()
  1448. dlg.Show()
  1449. def OnInstallExtension(self, event):
  1450. """Install extension from GRASS Addons repository"""
  1451. from modules.extensions import InstallExtensionWindow
  1452. win = InstallExtensionWindow(self, giface=self._giface, size=(650, 550))
  1453. win.CentreOnScreen()
  1454. win.Show()
  1455. def OnManageExtension(self, event):
  1456. """Manage or uninstall extensions"""
  1457. from modules.extensions import ManageExtensionWindow
  1458. win = ManageExtensionWindow(self, size=(650, 300))
  1459. win.CentreOnScreen()
  1460. win.Show()
  1461. def OnPreferences(self, event):
  1462. """General GUI preferences/settings"""
  1463. if not self.dialogs["preferences"]:
  1464. dlg = PreferencesDialog(parent=self, giface=self._giface)
  1465. self.dialogs["preferences"] = dlg
  1466. self.dialogs["preferences"].CenterOnParent()
  1467. dlg.settingsChanged.connect(self.OnSettingsChanged)
  1468. self.Bind(
  1469. wx.EVT_CLOSE, lambda evt: self.dialogs.update(preferences=None), dlg
  1470. )
  1471. self.dialogs["preferences"].Show()
  1472. def OnNvizPreferences(self, event):
  1473. """Show nviz preferences"""
  1474. if not self.dialogs["nvizPreferences"]:
  1475. from nviz.preferences import NvizPreferencesDialog
  1476. dlg = NvizPreferencesDialog(parent=self, giface=self._giface)
  1477. self.dialogs["nvizPreferences"] = dlg
  1478. self.dialogs["nvizPreferences"].CenterOnScreen()
  1479. self.dialogs["nvizPreferences"].Show()
  1480. def OnHelp(self, event):
  1481. """Show help"""
  1482. self._gconsole.RunCmd(["g.manual", "-i"])
  1483. def OnIClass(self, event=None, cmd=None):
  1484. """Start wxIClass tool
  1485. The parameters of all handlers which are associated with module
  1486. and contained in menu/toolboxes must be event and cmd.
  1487. When called from menu event is always None and cmd is the
  1488. associated command (list containing a module name and parameters).
  1489. .. todo::
  1490. This documentation is actually documentation of some
  1491. component related to gui_core/menu.py file.
  1492. """
  1493. from iclass.frame import IClassMapDisplay, haveIClass, errMsg
  1494. if not haveIClass:
  1495. GError(
  1496. _('Unable to launch "Supervised Classification Tool".\n\n' "Reason: %s")
  1497. % errMsg
  1498. )
  1499. return
  1500. frame = wx.Frame(
  1501. parent=None,
  1502. size=globalvar.MAP_WINDOW_SIZE,
  1503. title=_("Supervised Classification Tool"),
  1504. )
  1505. win = IClassMapDisplay(parent=frame, giface=self._giface)
  1506. win.CentreOnScreen()
  1507. win.Show()
  1508. def OnAnimationTool(self, event=None, cmd=None):
  1509. """Launch Animation tool. See OnIClass documentation."""
  1510. from animation.frame import AnimationFrame
  1511. frame = AnimationFrame(parent=self, giface=self._giface)
  1512. frame.CentreOnScreen()
  1513. frame.Show()
  1514. tree = self.GetLayerTree()
  1515. if tree:
  1516. rasters = []
  1517. for layer in tree.GetSelectedLayers(checkedOnly=False):
  1518. if tree.GetLayerInfo(layer, key="type") == "raster":
  1519. rasters.append(tree.GetLayerInfo(layer, key="maplayer").GetName())
  1520. if len(rasters) >= 2:
  1521. from core.layerlist import LayerList
  1522. from animation.data import AnimLayer
  1523. layerList = LayerList()
  1524. layer = AnimLayer()
  1525. layer.mapType = "raster"
  1526. layer.name = ",".join(rasters)
  1527. layer.cmd = ["d.rast", "map="]
  1528. layerList.AddLayer(layer)
  1529. frame.SetAnimations([layerList, None, None, None])
  1530. def OnTimelineTool(self, event=None, cmd=None):
  1531. """Launch Timeline Tool"""
  1532. try:
  1533. from timeline.frame import TimelineFrame
  1534. except ImportError:
  1535. GError(parent=self, message=_("Unable to start Timeline Tool."))
  1536. return
  1537. frame = TimelineFrame(None)
  1538. frame.Show()
  1539. def OnTplotTool(self, event=None, cmd=None):
  1540. """Launch Temporal Plot Tool"""
  1541. try:
  1542. from tplot.frame import TplotFrame
  1543. except ImportError:
  1544. GError(parent=self, message=_("Unable to start Temporal Plot Tool."))
  1545. return
  1546. frame = TplotFrame(parent=self, giface=self._giface)
  1547. frame.Show()
  1548. def OnHistogram(self, event):
  1549. """Init histogram display canvas and tools"""
  1550. from modules.histogram import HistogramFrame
  1551. win = HistogramFrame(self, giface=self._giface)
  1552. win.CentreOnScreen()
  1553. win.Show()
  1554. win.Refresh()
  1555. win.Update()
  1556. def OnMapCalculator(self, event, cmd=""):
  1557. """Init map calculator for interactive creation of mapcalc statements"""
  1558. from modules.mcalc_builder import MapCalcFrame
  1559. if event:
  1560. try:
  1561. cmd = self.GetMenuCmd(event)
  1562. except KeyError:
  1563. cmd = ["r.mapcalc"]
  1564. win = MapCalcFrame(parent=self, giface=self._giface, cmd=cmd[0])
  1565. win.CentreOnScreen()
  1566. win.Show()
  1567. def OnVectorCleaning(self, event, cmd=""):
  1568. """Init interactive vector cleaning"""
  1569. from modules.vclean import VectorCleaningFrame
  1570. win = VectorCleaningFrame(parent=self)
  1571. win.CentreOnScreen()
  1572. win.Show()
  1573. def OnRasterOutputFormat(self, event):
  1574. """Set raster output format handler"""
  1575. self.OnMenuCmd(cmd=["r.external.out"])
  1576. def OnVectorOutputFormat(self, event):
  1577. """Set vector output format handler"""
  1578. from modules.import_export import GdalOutputDialog
  1579. dlg = GdalOutputDialog(parent=self, ogr=True)
  1580. dlg.CentreOnScreen()
  1581. dlg.Show()
  1582. def OnImportDxfFile(self, event, cmd=None):
  1583. """Convert multiple DXF layers to GRASS vector map layers"""
  1584. from modules.import_export import DxfImportDialog
  1585. dlg = DxfImportDialog(parent=self, giface=self._giface)
  1586. dlg.CentreOnScreen()
  1587. dlg.Show()
  1588. def OnImportGdalLayers(self, event, cmd=None):
  1589. """Convert multiple GDAL layers to GRASS raster map layers"""
  1590. from modules.import_export import GdalImportDialog
  1591. dlg = GdalImportDialog(parent=self, giface=self._giface)
  1592. dlg.CentreOnScreen()
  1593. dlg.Show()
  1594. def OnLinkGdalLayers(self, event, cmd=None):
  1595. """Link multiple GDAL layers to GRASS raster map layers"""
  1596. from modules.import_export import GdalImportDialog
  1597. dlg = GdalImportDialog(parent=self, giface=self._giface, link=True)
  1598. dlg.CentreOnScreen()
  1599. dlg.Show()
  1600. def OnImportOgrLayers(self, event, cmd=None):
  1601. """Convert multiple OGR layers to GRASS vector map layers"""
  1602. from modules.import_export import OgrImportDialog
  1603. dlg = OgrImportDialog(parent=self, giface=self._giface)
  1604. dlg.CentreOnScreen()
  1605. dlg.Show()
  1606. def OnLinkOgrLayers(self, event, cmd=None):
  1607. """Links multiple OGR layers to GRASS vector map layers"""
  1608. from modules.import_export import OgrImportDialog
  1609. dlg = OgrImportDialog(parent=self, giface=self._giface, link=True)
  1610. dlg.CentreOnScreen()
  1611. dlg.Show()
  1612. def OnAddWS(self, event, cmd=None):
  1613. """Add web services layer"""
  1614. from web_services.dialogs import AddWSDialog
  1615. dlg = AddWSDialog(parent=self, giface=self._giface)
  1616. dlg.CentreOnScreen()
  1617. x, y = dlg.GetPosition()
  1618. dlg.SetPosition((x, y - 200))
  1619. dlg.Show()
  1620. def OnSimpleEditor(self, event):
  1621. # import on demand
  1622. from gui_core.pyedit import PyEditFrame
  1623. # we don't keep track of them and we don't care about open files
  1624. # there when closing the main GUI
  1625. simpleEditor = PyEditFrame(parent=self, giface=self._giface)
  1626. simpleEditor.SetSize(self.GetSize())
  1627. simpleEditor.CenterOnScreen()
  1628. simpleEditor.Show()
  1629. def OnShowAttributeTable(self, event, selection=None):
  1630. """Show attribute table of the given vector map layer"""
  1631. if not self.currentPage:
  1632. self.MsgNoLayerSelected()
  1633. return
  1634. tree = self.GetLayerTree()
  1635. layer = tree.layer_selected
  1636. # no map layer selected
  1637. if not layer:
  1638. self.MsgNoLayerSelected()
  1639. return
  1640. # available only for vector map layers
  1641. try:
  1642. maptype = tree.GetLayerInfo(layer, key="maplayer").type
  1643. except Exception:
  1644. maptype = None
  1645. if not maptype or maptype != "vector":
  1646. GMessage(parent=self, message=_("Selected map layer is not vector."))
  1647. return
  1648. if not tree.GetLayerInfo(layer):
  1649. return
  1650. dcmd = tree.GetLayerInfo(layer, key="cmd")
  1651. if not dcmd:
  1652. return
  1653. from dbmgr.manager import AttributeManager
  1654. dbmanager = AttributeManager(
  1655. parent=self,
  1656. id=wx.ID_ANY,
  1657. size=wx.Size(500, 300),
  1658. item=layer,
  1659. log=self._gconsole,
  1660. selection=selection,
  1661. )
  1662. # register ATM dialog
  1663. self.dialogs["atm"].append(dbmanager)
  1664. # show ATM window
  1665. dbmanager.Show()
  1666. def _onMapDisplayFocus(self, notebookLayerPage):
  1667. """Changes bookcontrol page to page associated with display."""
  1668. # moved from mapdisp/frame.py
  1669. # TODO: why it is called 3 times when getting focus?
  1670. # and one times when loosing focus?
  1671. if self.workspace_manager.loadingWorkspace:
  1672. return
  1673. pgnum = self.notebookLayers.GetPageIndex(notebookLayerPage)
  1674. if pgnum > -1:
  1675. self.notebookLayers.SetSelection(pgnum)
  1676. self.currentPage = self.notebookLayers.GetCurrentPage()
  1677. def _onStarting3dMode(self, mapDisplayPage):
  1678. """Disables 3D mode for all map displays except for @p mapDisplay"""
  1679. # TODO: it should be disabled also for newly created map windows
  1680. # moreover mapdisp.Disable3dMode() does not work properly
  1681. for page in range(0, self.GetLayerNotebook().GetPageCount()):
  1682. mapdisp = self.GetLayerNotebook().GetPage(page).maptree.GetMapDisplay()
  1683. if self.GetLayerNotebook().GetPage(page) != mapDisplayPage:
  1684. mapdisp.Disable3dMode()
  1685. def OnAddMaps(self, event=None):
  1686. """Add selected map layers into layer tree"""
  1687. dialog = MapLayersDialog(
  1688. parent=self, title=_("Add selected map layers into layer tree")
  1689. )
  1690. dialog.applyAddingMapLayers.connect(self.AddMaps)
  1691. val = dialog.ShowModal()
  1692. if val == wx.ID_OK:
  1693. self.AddMaps(dialog.GetMapLayers(), dialog.GetLayerType(cmd=True))
  1694. dialog.Destroy()
  1695. def AddMaps(self, mapLayers, ltype, check=False):
  1696. """Add map layers to layer tree.
  1697. :param list mapLayers: list of map names
  1698. :param str ltype: layer type ('raster', 'raster_3d', 'vector')
  1699. :param bool check: True if new layers should be checked in
  1700. layer tree False otherwise
  1701. """
  1702. # start new map display if no display is available
  1703. if not self.currentPage:
  1704. self.NewDisplay()
  1705. maptree = self.GetLayerTree()
  1706. for layerName in mapLayers:
  1707. if ltype == "raster":
  1708. cmd = ["d.rast", "map=%s" % layerName]
  1709. elif ltype == "raster_3d":
  1710. cmd = ["d.rast3d", "map=%s" % layerName]
  1711. elif ltype == "vector":
  1712. cmd = ["d.vect", "map=%s" % layerName] + GetDisplayVectSettings()
  1713. else:
  1714. GError(
  1715. parent=self, message=_("Unsupported map layer type <%s>.") % ltype
  1716. )
  1717. return
  1718. maptree.AddLayer(
  1719. ltype=ltype,
  1720. lname=layerName,
  1721. lchecked=check,
  1722. lopacity=1.0,
  1723. lcmd=cmd,
  1724. lgroup=None,
  1725. )
  1726. def _updateCurrentMap(self, **kwargs):
  1727. """Updates map of the current map window."""
  1728. if "delay" in kwargs:
  1729. self.GetMapDisplay().GetWindow().UpdateMap(delay=kwargs["delay"])
  1730. else:
  1731. self.GetMapDisplay().GetWindow().UpdateMap()
  1732. def OnMapCreated(self, name, ltype, add=None):
  1733. """Decides whether the map should be added to layer tree."""
  1734. if add is None:
  1735. # add new map into layer if globally enabled
  1736. if UserSettings.Get(group="cmd", key="addNewLayer", subkey="enabled"):
  1737. self.AddOrUpdateMap(name, ltype)
  1738. elif add:
  1739. # add new map into layer tree
  1740. self.AddOrUpdateMap(name, ltype)
  1741. else:
  1742. # update the map
  1743. display = self.GetMapDisplay()
  1744. display.GetWindow().UpdateMap(render=True)
  1745. def AddOrUpdateMap(self, mapName, ltype):
  1746. """Add map layer or update"""
  1747. # start new map display if no display is available
  1748. if ltype not in ["raster", "raster_3d", "vector"]:
  1749. GError(parent=self, message=_("Unsupported map layer type <%s>.") % ltype)
  1750. return
  1751. if not self.currentPage:
  1752. self.AddMaps([mapName], ltype, check=True)
  1753. else:
  1754. display = self.GetMapDisplay()
  1755. mapLayers = map(
  1756. lambda x: x.GetName(), display.GetMap().GetListOfLayers(ltype=ltype)
  1757. )
  1758. if mapName in mapLayers:
  1759. display.GetWindow().UpdateMap(render=True)
  1760. else:
  1761. self.AddMaps([mapName], ltype, check=True)
  1762. def OnAddRaster(self, event):
  1763. """Add raster map layer"""
  1764. # start new map display if no display is available
  1765. if not self.currentPage:
  1766. self.NewDisplay(show=True)
  1767. self.GetLayerTree().AddLayer("raster")
  1768. def OnAddRasterMisc(self, event):
  1769. """Create misc raster popup-menu"""
  1770. # start new map display if no display is available
  1771. if not self.currentPage:
  1772. self.NewDisplay(show=True)
  1773. self._popupMenu(
  1774. (
  1775. ("layerRaster_3d", self.OnAddRaster3D),
  1776. (None, None),
  1777. ("layerRgb", self.OnAddRasterRGB),
  1778. ("layerHis", self.OnAddRasterHIS),
  1779. (None, None),
  1780. ("layerShaded", self.OnAddRasterShaded),
  1781. (None, None),
  1782. ("layerRastarrow", self.OnAddRasterArrow),
  1783. ("layerRastnum", self.OnAddRasterNum),
  1784. )
  1785. )
  1786. def OnAddVector(self, event):
  1787. """Add vector map to the current layer tree"""
  1788. # start new map display if no display is available
  1789. if not self.currentPage:
  1790. self.NewDisplay(show=True)
  1791. self.GetLayerTree().AddLayer("vector")
  1792. def OnAddVectorMisc(self, event):
  1793. """Create misc vector popup-menu"""
  1794. # start new map display if no display is available
  1795. if not self.currentPage:
  1796. self.NewDisplay(show=True)
  1797. self._popupMenu(
  1798. (
  1799. ("layerThememap", self.OnAddVectorTheme),
  1800. ("layerThemechart", self.OnAddVectorChart),
  1801. )
  1802. )
  1803. def OnAddVectorTheme(self, event):
  1804. """Add thematic vector map to the current layer tree"""
  1805. self.GetLayerTree().AddLayer("thememap")
  1806. def OnAddVectorChart(self, event):
  1807. """Add chart vector map to the current layer tree"""
  1808. self.GetLayerTree().AddLayer("themechart")
  1809. def OnAddOverlay(self, event):
  1810. """Create decoration overlay menu"""
  1811. # start new map display if no display is available
  1812. if not self.currentPage:
  1813. self.NewDisplay(show=True)
  1814. self._popupMenu(
  1815. (
  1816. ("layerGrid", self.OnAddGrid),
  1817. ("layerLabels", self.OnAddLabels),
  1818. ("layerGeodesic", self.OnAddGeodesic),
  1819. ("layerRhumb", self.OnAddRhumb),
  1820. (None, None),
  1821. ("layerCmd", self.OnAddCommand),
  1822. )
  1823. )
  1824. def OnAddRaster3D(self, event):
  1825. """Add 3D raster map to the current layer tree"""
  1826. self.GetLayerTree().AddLayer("raster_3d")
  1827. def OnAddRasterRGB(self, event):
  1828. """Add RGB raster map to the current layer tree"""
  1829. self.GetLayerTree().AddLayer("rgb")
  1830. def OnAddRasterHIS(self, event):
  1831. """Add HIS raster map to the current layer tree"""
  1832. self.GetLayerTree().AddLayer("his")
  1833. def OnAddRasterShaded(self, event):
  1834. """Add shaded relief raster map to the current layer tree"""
  1835. self.GetLayerTree().AddLayer("shaded")
  1836. def OnAddRasterArrow(self, event):
  1837. """Add flow arrows raster map to the current layer tree"""
  1838. # here it seems that it should be retrieved from the mapwindow
  1839. mapdisplay = self.GetMapDisplay()
  1840. resolution = mapdisplay.mapWindowProperties.resolution
  1841. if not resolution:
  1842. dlg = self.MsgDisplayResolution()
  1843. if dlg.ShowModal() == wx.ID_YES:
  1844. mapdisplay.mapWindowProperties.resolution = True
  1845. dlg.Destroy()
  1846. self.GetLayerTree().AddLayer("rastarrow")
  1847. def OnAddRasterNum(self, event):
  1848. """Add cell number raster map to the current layer tree"""
  1849. mapdisplay = self.GetMapDisplay()
  1850. resolution = mapdisplay.mapWindowProperties.resolution
  1851. if not resolution:
  1852. limitText = _(
  1853. "Note that cell values can only be displayed for "
  1854. "regions of less than 10,000 cells."
  1855. )
  1856. dlg = self.MsgDisplayResolution(limitText)
  1857. if dlg.ShowModal() == wx.ID_YES:
  1858. mapdisplay.mapWindowProperties.resolution = True
  1859. dlg.Destroy()
  1860. # region = tree.GetMap().GetCurrentRegion()
  1861. # if region['cells'] > 10000:
  1862. # GMessage(message = "Cell values can only be displayed
  1863. # for regions of < 10,000 cells.", parent = self)
  1864. self.GetLayerTree().AddLayer("rastnum")
  1865. def OnAddCommand(self, event):
  1866. """Add command line map layer to the current layer tree"""
  1867. # start new map display if no display is available
  1868. if not self.currentPage:
  1869. self.NewDisplay(show=True)
  1870. self.GetLayerTree().AddLayer("command")
  1871. def OnAddGroup(self, event):
  1872. """Add layer group"""
  1873. # start new map display if no display is available
  1874. if not self.currentPage:
  1875. self.NewDisplay(show=True)
  1876. self.GetLayerTree().AddLayer("group")
  1877. def OnAddGrid(self, event):
  1878. """Add grid map layer to the current layer tree"""
  1879. self.GetLayerTree().AddLayer("grid")
  1880. def OnAddGeodesic(self, event):
  1881. """Add geodesic line map layer to the current layer tree"""
  1882. self.GetLayerTree().AddLayer("geodesic")
  1883. def OnAddRhumb(self, event):
  1884. """Add rhumb map layer to the current layer tree"""
  1885. self.GetLayerTree().AddLayer("rhumb")
  1886. def OnAddLabels(self, event):
  1887. """Add vector labels map layer to the current layer tree"""
  1888. # start new map display if no display is available
  1889. if not self.currentPage:
  1890. self.NewDisplay(show=True)
  1891. self.GetLayerTree().AddLayer("labels")
  1892. def OnShowRegionExtent(self, event):
  1893. """Add vector labels map layer to the current layer tree"""
  1894. # start new map display if no display is available
  1895. if not self.currentPage:
  1896. self.NewDisplay(show=True)
  1897. # get current map display
  1898. mapdisp = self.GetMapDisplay()
  1899. # change the property
  1900. mapdisp.mapWindowProperties.showRegion = True
  1901. # show map display (user said show so make sure it is visible)
  1902. mapdisp.Show()
  1903. # redraw map if auto-rendering is enabled
  1904. # seems little too low level for this place
  1905. # no redraw when Render is unchecked
  1906. if mapdisp.IsAutoRendered():
  1907. mapdisp.GetMapWindow().UpdateMap(render=False)
  1908. def OnDeleteLayer(self, event):
  1909. """Remove selected map layer from the current layer Tree"""
  1910. if not self.currentPage or not self.GetLayerTree().layer_selected:
  1911. self.MsgNoLayerSelected()
  1912. return
  1913. if UserSettings.Get(group="manager", key="askOnRemoveLayer", subkey="enabled"):
  1914. layerName = ""
  1915. for item in self.GetLayerTree().GetSelections():
  1916. name = self.GetLayerTree().GetItemText(item)
  1917. idx = name.find("(" + _("opacity:"))
  1918. if idx > -1:
  1919. layerName += "<" + name[:idx].strip(" ") + ">,\n"
  1920. else:
  1921. layerName += "<" + name + ">,\n"
  1922. layerName = layerName.rstrip(",\n")
  1923. if len(layerName) > 2: # <>
  1924. message = (
  1925. _("Do you want to remove map layer(s)\n%s\n" "from layer tree?")
  1926. % layerName
  1927. )
  1928. else:
  1929. message = _(
  1930. "Do you want to remove selected map layer(s) " "from layer tree?"
  1931. )
  1932. dlg = wx.MessageDialog(
  1933. parent=self,
  1934. message=message,
  1935. caption=_("Remove map layer"),
  1936. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION,
  1937. )
  1938. if dlg.ShowModal() != wx.ID_YES:
  1939. dlg.Destroy()
  1940. return
  1941. dlg.Destroy()
  1942. for layer in self.GetLayerTree().GetSelections():
  1943. if self.GetLayerTree().GetLayerInfo(layer, key="type") == "group":
  1944. self.GetLayerTree().DeleteChildren(layer)
  1945. # nested children group layer in the parent group layer (both selected)
  1946. try:
  1947. self.GetLayerTree().Delete(layer)
  1948. except ValueError:
  1949. pass
  1950. def OnKeyDown(self, event):
  1951. """Key pressed"""
  1952. kc = event.GetKeyCode()
  1953. try:
  1954. kc = chr(kc)
  1955. except ValueError:
  1956. event.Skip()
  1957. return
  1958. if event.CtrlDown():
  1959. if kc == "R":
  1960. self.OnAddRaster(None)
  1961. elif kc == "V":
  1962. self.OnAddVector(None)
  1963. event.Skip()
  1964. def OnCloseWindow(self, event):
  1965. """Cleanup when wxGUI is quitted"""
  1966. self._closeWindow(event)
  1967. def OnCloseWindowOrExit(self, event):
  1968. """Cleanup when wxGUI is quitted
  1969. Ask user also to quit GRASS including terminal
  1970. """
  1971. dlg = QuitDialog(self)
  1972. ret = dlg.ShowModal()
  1973. dlg.Destroy()
  1974. if ret != wx.ID_CANCEL:
  1975. self._closeWindow(event)
  1976. if ret == wx.ID_YES:
  1977. self._quitGRASS()
  1978. def _closeWindow(self, event):
  1979. """Close wxGUI"""
  1980. # save command protocol if actived
  1981. if self.goutput.btnCmdProtocol.GetValue():
  1982. self.goutput.CmdProtocolSave()
  1983. if not self.currentPage:
  1984. self._auimgr.UnInit()
  1985. self.Destroy()
  1986. return
  1987. if not self.workspace_manager.CanClosePage(caption=_("Quit GRASS GUI")):
  1988. # when called from menu, it gets CommandEvent and not
  1989. # CloseEvent
  1990. if hasattr(event, "Veto"):
  1991. event.Veto()
  1992. return
  1993. self.DisplayCloseAll()
  1994. self._auimgr.UnInit()
  1995. self.Destroy()
  1996. def _quitGRASS(self):
  1997. """Quit GRASS terminal"""
  1998. shellPid = get_shell_pid()
  1999. if shellPid is None:
  2000. return
  2001. Debug.msg(1, "Exiting shell with pid={0}".format(shellPid))
  2002. import signal
  2003. os.kill(shellPid, signal.SIGTERM)
  2004. def MsgNoLayerSelected(self):
  2005. """Show dialog message 'No layer selected'"""
  2006. wx.MessageBox(
  2007. parent=self,
  2008. message=_("No map layer selected. Operation canceled."),
  2009. caption=_("Message"),
  2010. style=wx.OK | wx.ICON_INFORMATION | wx.CENTRE,
  2011. )
  2012. def MsgDisplayResolution(self, limitText=None):
  2013. """Returns dialog for d.rast.num, d.rast.arrow
  2014. when display resolution is not constrained
  2015. :param limitText: adds a note about cell limit
  2016. """
  2017. message = _(
  2018. "Display resolution is currently not constrained to "
  2019. "computational settings. "
  2020. "It's suggested to constrain map to region geometry. "
  2021. "Do you want to constrain "
  2022. "the resolution?"
  2023. )
  2024. if limitText:
  2025. message += "\n\n%s" % _(limitText)
  2026. dlg = wx.MessageDialog(
  2027. parent=self,
  2028. message=message,
  2029. caption=_("Constrain map to region geometry?"),
  2030. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION | wx.CENTRE,
  2031. )
  2032. return dlg
  2033. def OnMapNotebookClose(self, event):
  2034. """Page of map notebook is being closed"""
  2035. display = self.GetMapDisplay(onlyCurrent=True)
  2036. display.OnCloseWindow(event=None, askIfSaveWorkspace=True)
  2037. event.Veto()