frame.py 81 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377
  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 // 3 for t in self.size)
  132. self.PANE_MIN_SIZE = tuple(t // 5 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.Show()
  155. self.Maximize(True)
  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.MinSize(self.search.GetMinSize())
  597. wx.CallAfter(self.datacatalog.LoadItems)
  598. self._auimgr.Update()
  599. def BindEvents(self):
  600. # bindings
  601. self.Bind(wx.EVT_CLOSE, self.OnCloseWindowOrExit)
  602. self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDown)
  603. def _show_demo_map(self):
  604. """If in demolocation, add demo map to map display
  605. This provides content for first-time user experience.
  606. """
  607. def show_demo():
  608. layer_name = "country_boundaries@PERMANENT"
  609. exists = grass.find_file(name=layer_name, element="vector")["name"]
  610. if not exists:
  611. # Do not fail nor report errors to the first-time user when not found.
  612. Debug.msg(
  613. 5, "GMFrame._show_demo_map(): {} does not exist".format(layer_name)
  614. )
  615. return
  616. self.GetLayerTree().AddLayer(
  617. ltype="vector",
  618. lname=layer_name,
  619. lchecked=True,
  620. lcmd=["d.vect", "map={}".format(layer_name)],
  621. )
  622. if is_first_time_user():
  623. # Show only after everything is initialized for proper map alignment.
  624. wx.CallLater(1000, show_demo)
  625. def AddNvizTools(self, firstTime):
  626. """Add nviz notebook page
  627. :param firstTime: if a mapdisplay is starting 3D mode for the
  628. first time
  629. """
  630. Debug.msg(5, "GMFrame.AddNvizTools()")
  631. from nviz.main import haveNviz
  632. if not haveNviz:
  633. return
  634. from nviz.main import NvizToolWindow
  635. # show toolbar
  636. self._auimgr.GetPane("toolbarNviz").Show()
  637. # reorder other toolbars
  638. for pos, toolbar in enumerate(
  639. ("toolbarWorkspace", "toolbarTools", "toolbarMisc", "toolbarNviz")
  640. ):
  641. self._auimgr.GetPane(toolbar).Row(1).Position(pos)
  642. # create nviz tools tab
  643. self.nviz = NvizToolWindow(
  644. parent=self, tree=self.GetLayerTree(), display=self.GetMapDisplay()
  645. )
  646. self._auimgr.AddPane(
  647. self.nviz,
  648. aui.AuiPaneInfo()
  649. .Name("nviz")
  650. .Caption("3D view")
  651. .Left()
  652. .Layer(1)
  653. .Position(3)
  654. .BestSize(self.PANE_BEST_SIZE)
  655. .MinSize(self.PANE_MIN_SIZE)
  656. .CloseButton(False)
  657. .MinimizeButton(True)
  658. .MaximizeButton(True),
  659. )
  660. self._auimgr.GetPane("nviz").Show()
  661. self._auimgr.Update()
  662. # this is a bit strange here since a new window is created everytime
  663. if not firstTime:
  664. for page in ("view", "light", "fringe", "constant", "cplane", "animation"):
  665. self.nviz.UpdatePage(page)
  666. def RemoveNvizTools(self):
  667. """Remove nviz notebook page"""
  668. # if more mapwindow3D were possible, check here if nb page should be
  669. # removed
  670. # hide toolbar
  671. self._auimgr.GetPane("toolbarNviz").Hide()
  672. for pos, toolbar in enumerate(
  673. ("toolbarWorkspace", "toolbarTools", "toolbarMisc")
  674. ):
  675. self._auimgr.GetPane(toolbar).Row(1).Position(pos)
  676. self._auimgr.DetachPane(self.nviz)
  677. self.nviz.Destroy()
  678. self._auimgr.Update()
  679. def OnLocationWizard(self, event):
  680. """Launch location wizard"""
  681. gisenv = grass.gisenv()
  682. grassdb, location, mapset = create_location_interactively(
  683. self, gisenv["GISDBASE"]
  684. )
  685. if location:
  686. self._giface.grassdbChanged.emit(
  687. grassdb=grassdb, location=location, action="new", element="location"
  688. )
  689. if grassdb == gisenv["GISDBASE"]:
  690. switch_grassdb = None
  691. else:
  692. switch_grassdb = grassdb
  693. if can_switch_mapset_interactive(self, grassdb, location, mapset):
  694. switch_mapset_interactively(
  695. self,
  696. self._giface,
  697. switch_grassdb,
  698. location,
  699. mapset,
  700. show_confirmation=True,
  701. )
  702. def OnSettingsChanged(self):
  703. """Here can be functions which have to be called
  704. after receiving settingsChanged signal.
  705. Now only set copying of selected text to clipboard (in goutput).
  706. """
  707. # self._createMenuBar() # bug when menu is re-created on the fly
  708. self._setCopyingOfSelectedText()
  709. def OnGCPManager(self, event=None, cmd=None):
  710. """Launch georectifier module. See OnIClass documentation"""
  711. from gcp.manager import GCPWizard
  712. GCPWizard(self, self._giface)
  713. def OnGModeler(self, event=None, cmd=None):
  714. """Launch Graphical Modeler. See OnIClass documentation"""
  715. from gmodeler.frame import ModelFrame
  716. win = ModelFrame(parent=self, giface=self._giface)
  717. win.CentreOnScreen()
  718. win.Show()
  719. def OnPsMap(self, event=None, cmd=None):
  720. """Launch Cartographic Composer. See OnIClass documentation"""
  721. from psmap.frame import PsMapFrame
  722. win = PsMapFrame(parent=self)
  723. win.CentreOnScreen()
  724. win.Show()
  725. def OnMapSwipe(self, event=None, cmd=None):
  726. """Launch Map Swipe. See OnIClass documentation"""
  727. from mapswipe.frame import SwipeMapDisplay
  728. frame = wx.Frame(
  729. parent=None, size=globalvar.MAP_WINDOW_SIZE, title=_("Map Swipe Tool")
  730. )
  731. win = SwipeMapDisplay(
  732. parent=frame,
  733. giface=self._giface,
  734. )
  735. rasters = []
  736. tree = self.GetLayerTree()
  737. if tree:
  738. for layer in tree.GetSelections():
  739. if tree.GetLayerInfo(layer, key="maplayer").GetType() != "raster":
  740. continue
  741. rasters.append(tree.GetLayerInfo(layer, key="maplayer").GetName())
  742. if len(rasters) >= 1:
  743. win.SetFirstRaster(rasters[0])
  744. if len(rasters) >= 2:
  745. win.SetSecondRaster(rasters[1])
  746. win.SetRasterNames()
  747. win.CentreOnScreen()
  748. win.Show()
  749. def OnRLiSetup(self, event=None, cmd=None):
  750. """Launch r.li setup. See OnIClass documentation"""
  751. from rlisetup.frame import RLiSetupFrame
  752. win = RLiSetupFrame(parent=self)
  753. win.CentreOnScreen()
  754. win.Show()
  755. def OnDataCatalog(self, event=None, cmd=None):
  756. """Launch Data Catalog"""
  757. from datacatalog.frame import DataCatalogFrame
  758. win = DataCatalogFrame(parent=self, giface=self._giface)
  759. win.CentreOnScreen()
  760. win.Show()
  761. def OnDone(self, event):
  762. """Command execution finished"""
  763. if hasattr(self, "model"):
  764. self.model.DeleteIntermediateData(log=self._gconsole)
  765. del self.model
  766. self.SetStatusText("")
  767. def OnRunModel(self, event):
  768. """Run model"""
  769. filename = ""
  770. dlg = wx.FileDialog(
  771. parent=self,
  772. message=_("Choose model to run"),
  773. defaultDir=os.getcwd(),
  774. wildcard=_("GRASS Model File (*.gxm)|*.gxm"),
  775. )
  776. if dlg.ShowModal() == wx.ID_OK:
  777. filename = dlg.GetPath()
  778. if not filename:
  779. dlg.Destroy()
  780. return
  781. from gmodeler.model import Model
  782. self.model = Model()
  783. self.model.LoadModel(filename)
  784. self.model.Run(log=self.GetLogWindow(), onDone=self.OnDone, parent=self)
  785. dlg.Destroy()
  786. def OnMapsets(self, event):
  787. """Launch mapset access dialog"""
  788. dlg = MapsetAccess(parent=self, id=wx.ID_ANY)
  789. dlg.CenterOnScreen()
  790. if dlg.ShowModal() == wx.ID_OK:
  791. ms = dlg.GetMapsets()
  792. RunCommand(
  793. "g.mapsets", parent=self, mapset="%s" % ",".join(ms), operation="set"
  794. )
  795. def OnCBPageChanged(self, event):
  796. """Page in notebook (display) changed.
  797. Also change active map notebook tab."""
  798. self.currentPage = self.notebookLayers.GetCurrentPage()
  799. self.currentPageNum = self.notebookLayers.GetSelection()
  800. try:
  801. self.mapnotebook.SetSelection(self.GetMapDisplayIndex())
  802. except Exception:
  803. pass
  804. event.Skip()
  805. def OnCBPageClosing(self, event):
  806. """Page of notebook is being closed
  807. from Layer Manager (x button next to arrows)
  808. Also close associated map display.
  809. """
  810. # save changes in the workspace
  811. name = self.notebookLayers.GetPageText(event.GetSelection())
  812. caption = _("Close Map Display {}").format(name)
  813. if not self.workspace_manager.CanClosePage(caption):
  814. event.Veto()
  815. return
  816. maptree = self.notebookLayers.GetPage(event.GetSelection()).maptree
  817. maptree.GetMapDisplay().CleanUp()
  818. self.mapnotebook.DeletePage(self.GetMapDisplayIndex())
  819. maptree.Close(True)
  820. self.currentPage = None
  821. event.Skip()
  822. def _closePageNoEvent(self, pgnum_dict):
  823. """Close page and destroy map display without generating notebook
  824. page closing event.
  825. :param dict pgnum_dict: dict "layers" key represent map display
  826. notebook layers tree page index and
  827. "mapnotebook" key represent map display
  828. notebook page index (single window mode)
  829. """
  830. self.notebookLayers.Unbind(FN.EVT_FLATNOTEBOOK_PAGE_CLOSING)
  831. self.notebookLayers.DeletePage(pgnum_dict["layers"])
  832. self.notebookLayers.Bind(
  833. FN.EVT_FLATNOTEBOOK_PAGE_CLOSING,
  834. self.OnCBPageClosing,
  835. )
  836. self.mapnotebook.DeletePage(pgnum_dict["mapnotebook"])
  837. def _focusPage(self, notification):
  838. """Focus the 'Console' notebook page according to event notification."""
  839. if (
  840. notification == Notification.HIGHLIGHT
  841. or notification == Notification.MAKE_VISIBLE
  842. or notification == Notification.RAISE_WINDOW
  843. ):
  844. self.FocusPage("Console")
  845. def FocusPage(self, page_text):
  846. """Focus the page if part of any of aui notebooks"""
  847. notebooks = self._auimgr.GetNotebooks()
  848. for notebook in notebooks:
  849. for i in range(notebook.GetPageCount()):
  850. if notebook.GetPageText(i) == page_text:
  851. notebook.SetSelection(i)
  852. def RunSpecialCmd(self, command):
  853. """Run command from command line, check for GUI wrappers"""
  854. if re.compile(r"^d\..*").search(command[0]):
  855. self.RunDisplayCmd(command)
  856. elif re.compile(r"r[3]?\.mapcalc").search(command[0]):
  857. self.OnMapCalculator(event=None, cmd=command)
  858. elif command[0] == "i.group":
  859. self.OnEditImageryGroups(event=None, cmd=command)
  860. elif command[0] == "r.import":
  861. self.OnImportGdalLayers(event=None, cmd=command)
  862. elif command[0] == "r.external":
  863. self.OnLinkGdalLayers(event=None, cmd=command)
  864. elif command[0] == "r.external.out":
  865. self.OnRasterOutputFormat(event=None)
  866. elif command[0] == "v.import":
  867. self.OnImportOgrLayers(event=None, cmd=command)
  868. elif command[0] == "v.external":
  869. self.OnLinkOgrLayers(event=None, cmd=command)
  870. elif command[0] == "v.external.out":
  871. self.OnVectorOutputFormat(event=None)
  872. elif command[0] == "cd":
  873. self.OnChangeCWD(event=None, cmd=command)
  874. else:
  875. raise ValueError(
  876. "Layer Manager special command (%s)"
  877. " not supported." % " ".join(command)
  878. )
  879. def RunDisplayCmd(self, command):
  880. """Handles display commands.
  881. :param command: command in a list
  882. """
  883. if not self.currentPage:
  884. self.NewDisplay(show=True)
  885. # here should be the d.* commands which are not layers
  886. if command[0] == "d.erase":
  887. # rest of d.erase is ignored
  888. self.GetLayerTree().DeleteAllLayers()
  889. return
  890. try:
  891. # display GRASS commands
  892. layertype = command2ltype[command[0]]
  893. except KeyError:
  894. GMessage(
  895. parent=self,
  896. message=_(
  897. "Command '%s' not yet implemented in the WxGUI. "
  898. "Try adding it as a command layer instead."
  899. )
  900. % command[0],
  901. )
  902. return
  903. if layertype == "barscale":
  904. if len(command) > 1:
  905. self.GetMapDisplay().AddBarscale(cmd=command)
  906. else:
  907. self.GetMapDisplay().AddBarscale()
  908. elif layertype == "rastleg":
  909. if len(command) > 1:
  910. self.GetMapDisplay().AddLegendRast(cmd=command)
  911. else:
  912. self.GetMapDisplay().AddLegendRast()
  913. elif layertype == "vectleg":
  914. if len(command) > 1:
  915. self.GetMapDisplay().AddLegendVect(cmd=command, showDialog=False)
  916. else:
  917. self.GetMapDisplay().AddLegendVect(showDialog=True)
  918. elif layertype == "northarrow":
  919. if len(command) > 1:
  920. self.GetMapDisplay().AddArrow(cmd=command)
  921. else:
  922. self.GetMapDisplay().AddArrow()
  923. elif layertype == "text":
  924. if len(command) > 1:
  925. self.GetMapDisplay().AddDtext(cmd=command)
  926. else:
  927. self.GetMapDisplay().AddDtext()
  928. elif layertype == "redraw":
  929. self.GetMapDisplay().OnRender(None)
  930. elif layertype == "export":
  931. GUI(parent=self, show=False).ParseCommand(
  932. command, completed=(self.GetMapDisplay().DOutFileOptData, "", "")
  933. )
  934. elif layertype == "torast":
  935. if len(command) <= 1:
  936. task = GUI(parent=self, show=True).ParseCommand(
  937. command, completed=(self.GetMapDisplay().DToRastOptData, "", "")
  938. )
  939. else:
  940. task = GUI(parent=self, show=None).ParseCommand(
  941. command, completed=(self.GetMapDisplay().DToRastOptData, "", "")
  942. )
  943. self.GetMapDisplay().DToRast(command=task.get_cmd())
  944. else:
  945. # add layer into layer tree
  946. lname, found = GetLayerNameFromCmd(
  947. command, fullyQualified=True, layerType=layertype
  948. )
  949. self.GetLayerTree().AddLayer(
  950. ltype=layertype,
  951. lchecked=True if lname else None,
  952. lname=lname,
  953. lcmd=command,
  954. )
  955. def GetLayerNotebook(self):
  956. """Get Layers Notebook"""
  957. return self.notebookLayers
  958. def GetLayerTree(self):
  959. """Get current layer tree
  960. :return: LayerTree instance
  961. :return: None no layer tree selected
  962. """
  963. if self.currentPage:
  964. return self.currentPage.maptree
  965. return None
  966. def GetMapDisplay(self, onlyCurrent=True):
  967. """Get current map display
  968. :param bool onlyCurrent: True to return only active mapdisplay
  969. False for list of all mapdisplays
  970. :return: MapPanel instance (or list)
  971. :return: None no mapdisplay selected
  972. """
  973. if onlyCurrent:
  974. if self.currentPage:
  975. return self.GetLayerTree().GetMapDisplay()
  976. else:
  977. return None
  978. else: # -> return list of all mapdisplays
  979. mlist = list()
  980. for idx in range(0, self.notebookLayers.GetPageCount()):
  981. mlist.append(self.notebookLayers.GetPage(idx).maptree.GetMapDisplay())
  982. return mlist
  983. def GetAllMapDisplays(self):
  984. """Get all (open) map displays"""
  985. return self.GetMapDisplay(onlyCurrent=False)
  986. def GetMapDisplayIndex(self):
  987. """Get the index of the currently active map display tab.
  988. Can be different than index of related layertree."""
  989. return self.mapnotebook.GetPageIndex(self.GetMapDisplay())
  990. def GetLogWindow(self):
  991. """Gets console for command output and messages"""
  992. return self._gconsole
  993. def GetToolbar(self, name):
  994. """Returns toolbar if exists else None"""
  995. if name in self.toolbars:
  996. return self.toolbars[name]
  997. return None
  998. def GetMenuCmd(self, event):
  999. """Get GRASS command from menu item
  1000. :return: command as a list"""
  1001. layer = None
  1002. if event:
  1003. cmd = self.menucmd[event.GetId()]
  1004. else:
  1005. cmd = ""
  1006. try:
  1007. cmdlist = cmd.split(" ")
  1008. except Exception: # already list?
  1009. cmdlist = cmd
  1010. # check list of dummy commands for GUI modules that do not have GRASS
  1011. # bin modules or scripts.
  1012. if cmd in ["vcolors", "r.mapcalc", "r3.mapcalc"]:
  1013. return cmdlist
  1014. try:
  1015. layer = self.GetLayerTree().layer_selected
  1016. name = self.GetLayerTree().GetLayerInfo(layer, key="maplayer").name
  1017. type = self.GetLayerTree().GetLayerInfo(layer, key="type")
  1018. except Exception:
  1019. layer = None
  1020. if layer and len(cmdlist) == 1: # only if no parameters given
  1021. if (type == "raster" and cmdlist[0][0] == "r" and cmdlist[0][1] != "3") or (
  1022. type == "vector" and cmdlist[0][0] == "v"
  1023. ):
  1024. input = GUI().GetCommandInputMapParamKey(cmdlist[0])
  1025. if input:
  1026. cmdlist.append("%s=%s" % (input, name))
  1027. return cmdlist
  1028. def RunMenuCmd(self, event=None, cmd=[]):
  1029. """Run command selected from menu"""
  1030. if event:
  1031. cmd = self.GetMenuCmd(event)
  1032. self._gconsole.RunCmd(cmd)
  1033. def OnMenuCmd(self, event=None, cmd=[]):
  1034. """Parse command selected from menu"""
  1035. if event:
  1036. cmd = self.GetMenuCmd(event)
  1037. GUI(parent=self, giface=self._giface).ParseCommand(cmd)
  1038. def OnVNet(self, event):
  1039. """Vector network analysis tool"""
  1040. if self.GetMapDisplay():
  1041. self.GetMapDisplay().OnVNet(event)
  1042. else:
  1043. self.NewDisplay(show=True).OnVNet(event)
  1044. def OnVDigit(self, event):
  1045. """Start vector digitizer"""
  1046. if not self.currentPage:
  1047. self.MsgNoLayerSelected()
  1048. return
  1049. tree = self.GetLayerTree()
  1050. layer = tree.layer_selected
  1051. # no map layer selected
  1052. if not layer:
  1053. self.MsgNoLayerSelected()
  1054. return
  1055. # available only for vector map layers
  1056. try:
  1057. mapLayer = tree.GetLayerInfo(layer, key="maplayer")
  1058. except Exception:
  1059. mapLayer = None
  1060. if not mapLayer or mapLayer.GetType() != "vector":
  1061. GMessage(parent=self, message=_("Selected map layer is not vector."))
  1062. return
  1063. if mapLayer.GetMapset() != grass.gisenv()["MAPSET"]:
  1064. GMessage(
  1065. parent=self,
  1066. message=_(
  1067. "Editing is allowed only for vector maps from the "
  1068. "current mapset."
  1069. ),
  1070. )
  1071. return
  1072. if not tree.GetLayerInfo(layer):
  1073. return
  1074. dcmd = tree.GetLayerInfo(layer, key="cmd")
  1075. if not dcmd:
  1076. return
  1077. digitToolbar = self.GetMapDisplay().GetToolbar("vdigit")
  1078. if digitToolbar:
  1079. stopOnly = False
  1080. if mapLayer is digitToolbar.GetLayer():
  1081. stopOnly = True
  1082. tree.OnStopEditing(None) # TODO: change to signal
  1083. if stopOnly:
  1084. return
  1085. tree.OnStartEditing(None) # TODO: change to signal
  1086. def OnRunScript(self, event):
  1087. """Run user-defined script"""
  1088. # open dialog and choose script file
  1089. dlg = wx.FileDialog(
  1090. parent=self,
  1091. message=_("Choose script file to run"),
  1092. defaultDir=os.getcwd(),
  1093. wildcard=_("Python script (*.py)|*.py|Bash script (*.sh)|*.sh"),
  1094. )
  1095. filename = None
  1096. if dlg.ShowModal() == wx.ID_OK:
  1097. filename = dlg.GetPath()
  1098. if not filename:
  1099. return False
  1100. if not os.path.exists(filename):
  1101. GError(
  1102. parent=self,
  1103. message=_("Script file '%s' doesn't exist. " "Operation canceled.")
  1104. % filename,
  1105. )
  1106. return
  1107. # check permission
  1108. if not os.access(filename, os.X_OK):
  1109. dlg = wx.MessageDialog(
  1110. self,
  1111. message=_(
  1112. "Script <%s> is not executable. "
  1113. "Do you want to set the permissions "
  1114. "that allows you to run this script "
  1115. "(note that you must be the owner of the file)?"
  1116. % os.path.basename(filename)
  1117. ),
  1118. caption=_("Set permission?"),
  1119. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION,
  1120. )
  1121. if dlg.ShowModal() != wx.ID_YES:
  1122. return
  1123. dlg.Destroy()
  1124. try:
  1125. mode = stat.S_IMODE(os.lstat(filename)[stat.ST_MODE])
  1126. os.chmod(filename, mode | stat.S_IXUSR)
  1127. except OSError:
  1128. GError(_("Unable to set permission. Operation canceled."), parent=self)
  1129. return
  1130. # check GRASS_ADDON_PATH
  1131. addonPath = os.getenv("GRASS_ADDON_PATH", [])
  1132. if addonPath:
  1133. addonPath = addonPath.split(os.pathsep)
  1134. dirName = os.path.dirname(filename)
  1135. if dirName not in addonPath:
  1136. addonPath.append(dirName)
  1137. dlg = wx.MessageDialog(
  1138. self,
  1139. message=_(
  1140. "Directory '%s' is not defined in GRASS_ADDON_PATH. "
  1141. "Do you want add this directory to GRASS_ADDON_PATH?"
  1142. )
  1143. % dirName,
  1144. caption=_("Update Addons path?"),
  1145. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION,
  1146. )
  1147. if dlg.ShowModal() == wx.ID_YES:
  1148. SetAddOnPath(os.pathsep.join(addonPath), key="PATH")
  1149. dlg.Destroy()
  1150. self._gconsole.WriteCmdLog(_("Launching script '%s'...") % filename)
  1151. self._gconsole.RunCmd([filename])
  1152. def OnChangeLocation(self, event):
  1153. """Change current location"""
  1154. dlg = LocationDialog(parent=self)
  1155. gisenv = grass.gisenv()
  1156. if dlg.ShowModal() == wx.ID_OK:
  1157. location, mapset = dlg.GetValues()
  1158. dlg.Destroy()
  1159. if not location or not mapset:
  1160. GError(
  1161. parent=self,
  1162. message=_("No location/mapset provided. Operation canceled."),
  1163. )
  1164. return # this should not happen
  1165. if can_switch_mapset_interactive(
  1166. self, gisenv["GISDBASE"], location, mapset
  1167. ):
  1168. switch_mapset_interactively(self, self._giface, None, location, mapset)
  1169. def OnCreateMapset(self, event):
  1170. """Create new mapset"""
  1171. gisenv = grass.gisenv()
  1172. mapset = create_mapset_interactively(
  1173. self, gisenv["GISDBASE"], gisenv["LOCATION_NAME"]
  1174. )
  1175. if mapset:
  1176. self._giface.grassdbChanged.emit(
  1177. grassdb=gisenv["GISDBASE"],
  1178. location=gisenv["LOCATION_NAME"],
  1179. mapset=mapset,
  1180. action="new",
  1181. element="mapset",
  1182. )
  1183. if can_switch_mapset_interactive(
  1184. self, gisenv["GISDBASE"], gisenv["LOCATION_NAME"], mapset
  1185. ):
  1186. switch_mapset_interactively(
  1187. self, self._giface, None, None, mapset, show_confirmation=True
  1188. )
  1189. def OnChangeMapset(self, event):
  1190. """Change current mapset"""
  1191. dlg = MapsetDialog(parent=self)
  1192. gisenv = grass.gisenv()
  1193. if dlg.ShowModal() == wx.ID_OK:
  1194. mapset = dlg.GetMapset()
  1195. dlg.Destroy()
  1196. if not mapset:
  1197. GError(
  1198. parent=self, message=_("No mapset provided. Operation canceled.")
  1199. )
  1200. return
  1201. if can_switch_mapset_interactive(
  1202. self, gisenv["GISDBASE"], gisenv["LOCATION_NAME"], mapset
  1203. ):
  1204. switch_mapset_interactively(self, self._giface, None, None, mapset)
  1205. def OnMapsetChanged(self, dbase, location, mapset):
  1206. """Current mapset changed.
  1207. If location is None, mapset changed within location.
  1208. """
  1209. if not location:
  1210. self._setTitle()
  1211. else:
  1212. # close current workspace and create new one
  1213. self.OnWorkspaceClose()
  1214. self.OnWorkspaceNew()
  1215. def OnChangeCWD(self, event=None, cmd=None):
  1216. """Change current working directory
  1217. :param event: to be able to serve as a handler of wx event
  1218. :param cmd: command as a list (must start with 'cd')
  1219. """
  1220. # local functions
  1221. def write_beginning(parameter=None, command=None):
  1222. if parameter:
  1223. self._giface.WriteCmdLog('cd "' + parameter + '"')
  1224. else:
  1225. # naive concat but will be enough most of the time
  1226. self._giface.WriteCmdLog(" ".join(command))
  1227. def write_changed():
  1228. self._giface.WriteLog(
  1229. _('Working directory changed to:\n"%s"') % os.getcwd()
  1230. )
  1231. def write_end():
  1232. self._giface.WriteCmdLog(" ")
  1233. def write_help():
  1234. self._giface.WriteLog(
  1235. _("Changes current working directory" " for this GUI.")
  1236. )
  1237. self._giface.WriteLog(_("Usage: cd [directory]"))
  1238. self._giface.WriteLog(_("Without parameters it opens a dialog."))
  1239. # TODO: the following is longer then 80 chars
  1240. # but this should be solved by the function not caller
  1241. # also because of translations
  1242. self._giface.WriteLog(
  1243. _(
  1244. "If ~ (tilde) is present as the first"
  1245. " directory on the path, it is replaced"
  1246. " by user's home directory."
  1247. )
  1248. )
  1249. # check correctness of cmd
  1250. if cmd and cmd[0] != "cd":
  1251. # this is programmer's error
  1252. # can be relaxed in future
  1253. # but keep it strict unless needed otherwise
  1254. raise ValueError(
  1255. "OnChangeCWD cmd parameter must be list of"
  1256. " length 1 or 2 and 'cd' as a first item"
  1257. )
  1258. if cmd and len(cmd) > 2:
  1259. # this might be a user error
  1260. write_beginning(command=cmd)
  1261. self._giface.WriteError(_("More than one parameter provided."))
  1262. write_help()
  1263. write_end()
  1264. return
  1265. # use chdir or dialog
  1266. if cmd and len(cmd) == 2:
  1267. write_beginning(parameter=cmd[1])
  1268. if cmd[1] in ["-h", "--h", "--help", "help"]:
  1269. write_help()
  1270. write_end()
  1271. return
  1272. try:
  1273. path = os.path.expanduser(cmd[1])
  1274. os.chdir(path)
  1275. write_changed()
  1276. except OSError as error:
  1277. self._giface.WriteError(str(error))
  1278. write_end()
  1279. else:
  1280. dlg = wx.DirDialog(
  1281. parent=self,
  1282. message=_("Choose a working directory"),
  1283. defaultPath=os.getcwd(),
  1284. )
  1285. if dlg.ShowModal() == wx.ID_OK:
  1286. self.cwdPath = dlg.GetPath() # is saved in the workspace
  1287. write_beginning(parameter=self.cwdPath)
  1288. os.chdir(self.cwdPath)
  1289. write_changed()
  1290. write_end()
  1291. def GetCwdPath(self):
  1292. """Get current working directory or None"""
  1293. return self.cwdPath
  1294. def OnNewVector(self, event):
  1295. """Create new vector map layer"""
  1296. dlg = CreateNewVector(
  1297. self, giface=self._giface, cmd=(("v.edit", {"tool": "create"}, "map"))
  1298. )
  1299. if not dlg:
  1300. return
  1301. name = dlg.GetName(full=True)
  1302. if name and dlg.IsChecked("add"):
  1303. # add layer to map layer tree
  1304. self.GetLayerTree().AddLayer(
  1305. ltype="vector",
  1306. lname=name,
  1307. lchecked=True,
  1308. lcmd=["d.vect", "map=%s" % name],
  1309. )
  1310. dlg.Destroy()
  1311. def OnSystemInfo(self, event):
  1312. """Print system information"""
  1313. vInfo = grass.version()
  1314. if not vInfo:
  1315. sys.stderr.write(_("Unable to get GRASS version\n"))
  1316. # check also OSGeo4W on MS Windows
  1317. if sys.platform == "win32" and not os.path.exists(
  1318. os.path.join(os.getenv("GISBASE"), "WinGRASS-README.url")
  1319. ):
  1320. osgeo4w = " (OSGeo4W)"
  1321. else:
  1322. osgeo4w = ""
  1323. self._gconsole.WriteCmdLog(_("System Info"))
  1324. # platform decoding was added because of the Fedora 19 release
  1325. # which has the name "Schrödinger’s cat" (umlaut and special ' character)
  1326. # which appears in the platform.platform() string
  1327. platform_ = decode(platform.platform())
  1328. self._gconsole.WriteLog(
  1329. "%s: %s\n" "%s: %s\n" "%s: %s\n" "%s: %s\n"
  1330. # "%s: %s (%s)\n"
  1331. "GDAL: %s\n"
  1332. "PROJ: %s\n"
  1333. "GEOS: %s\n"
  1334. "SQLite: %s\n"
  1335. "Python: %s\n"
  1336. "wxPython: %s\n"
  1337. "%s: %s%s\n"
  1338. % (
  1339. _("GRASS version"),
  1340. vInfo.get("version", _("unknown version")),
  1341. _("Code revision"),
  1342. vInfo.get("revision", "?"),
  1343. _("Build date"),
  1344. vInfo.get("build_date", "?"),
  1345. _("Build platform"),
  1346. vInfo.get("build_platform", "?"),
  1347. # _("GIS Library Revision"),
  1348. # vInfo.get('libgis_revision'],
  1349. # vInfo.get('libgis_date'].split('
  1350. # ', 1)[0],
  1351. vInfo.get("gdal", "?"),
  1352. vInfo.get("proj", "?"),
  1353. vInfo.get("geos", "?"),
  1354. vInfo.get("sqlite", "?"),
  1355. platform.python_version(),
  1356. wx.__version__,
  1357. _("Platform"),
  1358. platform_,
  1359. osgeo4w,
  1360. ),
  1361. notification=Notification.MAKE_VISIBLE,
  1362. )
  1363. self._gconsole.WriteCmdLog(" ")
  1364. def OnAboutGRASS(self, event):
  1365. """Display 'About GRASS' dialog"""
  1366. from gui_core.ghelp import AboutWindow
  1367. win = AboutWindow(self)
  1368. win.CentreOnScreen()
  1369. win.Show(True)
  1370. def _popupMenu(self, data):
  1371. """Create popup menu"""
  1372. menu = Menu()
  1373. for key, handler in data:
  1374. if key is None:
  1375. menu.AppendSeparator()
  1376. continue
  1377. item = wx.MenuItem(menu, wx.ID_ANY, LMIcons[key].GetLabel())
  1378. item.SetBitmap(LMIcons[key].GetBitmap(self.iconsize))
  1379. menu.AppendItem(item)
  1380. self.Bind(wx.EVT_MENU, handler, item)
  1381. # create menu
  1382. self.PopupMenu(menu)
  1383. menu.Destroy()
  1384. def OnWorkspaceNew(self, event=None):
  1385. """Create new workspace file"""
  1386. self.workspace_manager.New()
  1387. def OnWorkspaceOpen(self, event=None):
  1388. """Open file with workspace definition"""
  1389. self.workspace_manager.Open()
  1390. def OnWorkspaceSave(self, event=None):
  1391. """Save file with workspace definition"""
  1392. self.workspace_manager.Save()
  1393. def OnWorkspaceSaveAs(self, event=None):
  1394. """Save workspace definition to selected file"""
  1395. self.workspace_manager.SaveAs()
  1396. def OnWorkspaceClose(self, event=None):
  1397. """Close file with workspace definition"""
  1398. self.workspace_manager.Close()
  1399. def OnDisplayClose(self, event=None):
  1400. """Close current map display window"""
  1401. if self.currentPage and self.GetMapDisplay():
  1402. self.GetMapDisplay().OnCloseWindow(event)
  1403. def OnDisplayCloseAll(self, event):
  1404. """Close all open map display windows (from menu)"""
  1405. if not self.workspace_manager.CanClosePage(caption=_("Close all Map Displays")):
  1406. return
  1407. self.DisplayCloseAll()
  1408. def DisplayCloseAll(self):
  1409. """Close all open map display windows"""
  1410. for display in self.GetMapDisplay(onlyCurrent=False):
  1411. display.OnCloseWindow(event=None, askIfSaveWorkspace=False)
  1412. def OnRenderAllMapDisplays(self, event=None):
  1413. for display in self.GetAllMapDisplays():
  1414. display.OnRender(None)
  1415. def OnRenameDisplay(self, event):
  1416. """Change Map Display name"""
  1417. name = self.notebookLayers.GetPageText(self.currentPageNum)
  1418. dlg = TextEntryDialog(
  1419. self,
  1420. message=_("Enter new name:"),
  1421. caption=_("Rename Map Display"),
  1422. value=name,
  1423. )
  1424. if dlg.ShowModal() == wx.ID_OK:
  1425. name = dlg.GetValue()
  1426. self.notebookLayers.SetPageText(page=self.currentPageNum, text=name)
  1427. self.mapnotebook.SetPageText(page_idx=self.GetMapDisplayIndex(), text=name)
  1428. dlg.Destroy()
  1429. def OnRasterRules(self, event):
  1430. """Launches dialog for raster color rules"""
  1431. from modules.colorrules import RasterColorTable
  1432. ctable = RasterColorTable(self, layerTree=self.GetLayerTree())
  1433. ctable.Show()
  1434. ctable.CentreOnScreen()
  1435. def OnVectorRules(self, event):
  1436. """Launches dialog for vector color rules"""
  1437. from modules.colorrules import VectorColorTable
  1438. ctable = VectorColorTable(
  1439. self, layerTree=self.GetLayerTree(), attributeType="color"
  1440. )
  1441. ctable.Show()
  1442. ctable.CentreOnScreen()
  1443. def OnEditImageryGroups(self, event, cmd=None):
  1444. """Show dialog for creating and editing groups."""
  1445. dlg = GroupDialog(self)
  1446. dlg.CentreOnScreen()
  1447. dlg.Show()
  1448. def OnInstallExtension(self, event):
  1449. """Install extension from GRASS Addons repository"""
  1450. from modules.extensions import InstallExtensionWindow
  1451. win = InstallExtensionWindow(self, giface=self._giface, size=(650, 550))
  1452. win.CentreOnScreen()
  1453. win.Show()
  1454. def OnManageExtension(self, event):
  1455. """Manage or uninstall extensions"""
  1456. from modules.extensions import ManageExtensionWindow
  1457. win = ManageExtensionWindow(self, size=(650, 300))
  1458. win.CentreOnScreen()
  1459. win.Show()
  1460. def OnPreferences(self, event):
  1461. """General GUI preferences/settings"""
  1462. if not self.dialogs["preferences"]:
  1463. dlg = PreferencesDialog(parent=self, giface=self._giface)
  1464. self.dialogs["preferences"] = dlg
  1465. self.dialogs["preferences"].CenterOnParent()
  1466. dlg.settingsChanged.connect(self.OnSettingsChanged)
  1467. self.Bind(
  1468. wx.EVT_CLOSE, lambda evt: self.dialogs.update(preferences=None), dlg
  1469. )
  1470. self.dialogs["preferences"].Show()
  1471. def OnNvizPreferences(self, event):
  1472. """Show nviz preferences"""
  1473. if not self.dialogs["nvizPreferences"]:
  1474. from nviz.preferences import NvizPreferencesDialog
  1475. dlg = NvizPreferencesDialog(parent=self, giface=self._giface)
  1476. self.dialogs["nvizPreferences"] = dlg
  1477. self.dialogs["nvizPreferences"].CenterOnScreen()
  1478. self.dialogs["nvizPreferences"].Show()
  1479. def OnHelp(self, event):
  1480. """Show help"""
  1481. self._gconsole.RunCmd(["g.manual", "-i"])
  1482. def OnIClass(self, event=None, cmd=None):
  1483. """Start wxIClass tool
  1484. The parameters of all handlers which are associated with module
  1485. and contained in menu/toolboxes must be event and cmd.
  1486. When called from menu event is always None and cmd is the
  1487. associated command (list containing a module name and parameters).
  1488. .. todo::
  1489. This documentation is actually documentation of some
  1490. component related to gui_core/menu.py file.
  1491. """
  1492. from iclass.frame import IClassMapDisplay, haveIClass, errMsg
  1493. if not haveIClass:
  1494. GError(
  1495. _('Unable to launch "Supervised Classification Tool".\n\n' "Reason: %s")
  1496. % errMsg
  1497. )
  1498. return
  1499. frame = wx.Frame(
  1500. parent=None,
  1501. size=globalvar.MAP_WINDOW_SIZE,
  1502. title=_("Supervised Classification Tool"),
  1503. )
  1504. win = IClassMapDisplay(parent=frame, giface=self._giface)
  1505. win.CentreOnScreen()
  1506. win.Show()
  1507. def OnAnimationTool(self, event=None, cmd=None):
  1508. """Launch Animation tool. See OnIClass documentation."""
  1509. from animation.frame import AnimationFrame
  1510. frame = AnimationFrame(parent=self, giface=self._giface)
  1511. frame.CentreOnScreen()
  1512. frame.Show()
  1513. tree = self.GetLayerTree()
  1514. if tree:
  1515. rasters = []
  1516. for layer in tree.GetSelectedLayers(checkedOnly=False):
  1517. if tree.GetLayerInfo(layer, key="type") == "raster":
  1518. rasters.append(tree.GetLayerInfo(layer, key="maplayer").GetName())
  1519. if len(rasters) >= 2:
  1520. from core.layerlist import LayerList
  1521. from animation.data import AnimLayer
  1522. layerList = LayerList()
  1523. layer = AnimLayer()
  1524. layer.mapType = "raster"
  1525. layer.name = ",".join(rasters)
  1526. layer.cmd = ["d.rast", "map="]
  1527. layerList.AddLayer(layer)
  1528. frame.SetAnimations([layerList, None, None, None])
  1529. def OnTimelineTool(self, event=None, cmd=None):
  1530. """Launch Timeline Tool"""
  1531. try:
  1532. from timeline.frame import TimelineFrame
  1533. except ImportError:
  1534. GError(parent=self, message=_("Unable to start Timeline Tool."))
  1535. return
  1536. frame = TimelineFrame(None)
  1537. frame.Show()
  1538. def OnTplotTool(self, event=None, cmd=None):
  1539. """Launch Temporal Plot Tool"""
  1540. try:
  1541. from tplot.frame import TplotFrame
  1542. except ImportError:
  1543. GError(parent=self, message=_("Unable to start Temporal Plot Tool."))
  1544. return
  1545. frame = TplotFrame(parent=self, giface=self._giface)
  1546. frame.Show()
  1547. def OnHistogram(self, event):
  1548. """Init histogram display canvas and tools"""
  1549. from modules.histogram import HistogramFrame
  1550. win = HistogramFrame(self, giface=self._giface)
  1551. win.CentreOnScreen()
  1552. win.Show()
  1553. win.Refresh()
  1554. win.Update()
  1555. def OnMapCalculator(self, event, cmd=""):
  1556. """Init map calculator for interactive creation of mapcalc statements"""
  1557. from modules.mcalc_builder import MapCalcFrame
  1558. if event:
  1559. try:
  1560. cmd = self.GetMenuCmd(event)
  1561. except KeyError:
  1562. cmd = ["r.mapcalc"]
  1563. win = MapCalcFrame(parent=self, giface=self._giface, cmd=cmd[0])
  1564. win.CentreOnScreen()
  1565. win.Show()
  1566. def OnVectorCleaning(self, event, cmd=""):
  1567. """Init interactive vector cleaning"""
  1568. from modules.vclean import VectorCleaningFrame
  1569. win = VectorCleaningFrame(parent=self)
  1570. win.CentreOnScreen()
  1571. win.Show()
  1572. def OnRasterOutputFormat(self, event):
  1573. """Set raster output format handler"""
  1574. self.OnMenuCmd(cmd=["r.external.out"])
  1575. def OnVectorOutputFormat(self, event):
  1576. """Set vector output format handler"""
  1577. from modules.import_export import GdalOutputDialog
  1578. dlg = GdalOutputDialog(parent=self, ogr=True)
  1579. dlg.CentreOnScreen()
  1580. dlg.Show()
  1581. def OnImportDxfFile(self, event, cmd=None):
  1582. """Convert multiple DXF layers to GRASS vector map layers"""
  1583. from modules.import_export import DxfImportDialog
  1584. dlg = DxfImportDialog(parent=self, giface=self._giface)
  1585. dlg.CentreOnScreen()
  1586. dlg.Show()
  1587. def OnImportGdalLayers(self, event, cmd=None):
  1588. """Convert multiple GDAL layers to GRASS raster map layers"""
  1589. from modules.import_export import GdalImportDialog
  1590. dlg = GdalImportDialog(parent=self, giface=self._giface)
  1591. dlg.CentreOnScreen()
  1592. dlg.Show()
  1593. def OnLinkGdalLayers(self, event, cmd=None):
  1594. """Link multiple GDAL layers to GRASS raster map layers"""
  1595. from modules.import_export import GdalImportDialog
  1596. dlg = GdalImportDialog(parent=self, giface=self._giface, link=True)
  1597. dlg.CentreOnScreen()
  1598. dlg.Show()
  1599. def OnImportOgrLayers(self, event, cmd=None):
  1600. """Convert multiple OGR layers to GRASS vector map layers"""
  1601. from modules.import_export import OgrImportDialog
  1602. dlg = OgrImportDialog(parent=self, giface=self._giface)
  1603. dlg.CentreOnScreen()
  1604. dlg.Show()
  1605. def OnLinkOgrLayers(self, event, cmd=None):
  1606. """Links multiple OGR layers to GRASS vector map layers"""
  1607. from modules.import_export import OgrImportDialog
  1608. dlg = OgrImportDialog(parent=self, giface=self._giface, link=True)
  1609. dlg.CentreOnScreen()
  1610. dlg.Show()
  1611. def OnAddWS(self, event, cmd=None):
  1612. """Add web services layer"""
  1613. from web_services.dialogs import AddWSDialog
  1614. dlg = AddWSDialog(parent=self, giface=self._giface)
  1615. dlg.CentreOnScreen()
  1616. x, y = dlg.GetPosition()
  1617. dlg.SetPosition((x, y - 200))
  1618. dlg.Show()
  1619. def OnSimpleEditor(self, event):
  1620. # import on demand
  1621. from gui_core.pyedit import PyEditFrame
  1622. # we don't keep track of them and we don't care about open files
  1623. # there when closing the main GUI
  1624. simpleEditor = PyEditFrame(parent=self, giface=self._giface)
  1625. simpleEditor.SetSize(self.GetSize())
  1626. simpleEditor.CenterOnScreen()
  1627. simpleEditor.Show()
  1628. def OnShowAttributeTable(self, event, selection=None):
  1629. """Show attribute table of the given vector map layer"""
  1630. if not self.currentPage:
  1631. self.MsgNoLayerSelected()
  1632. return
  1633. tree = self.GetLayerTree()
  1634. layer = tree.layer_selected
  1635. # no map layer selected
  1636. if not layer:
  1637. self.MsgNoLayerSelected()
  1638. return
  1639. # available only for vector map layers
  1640. try:
  1641. maptype = tree.GetLayerInfo(layer, key="maplayer").type
  1642. except Exception:
  1643. maptype = None
  1644. if not maptype or maptype != "vector":
  1645. GMessage(parent=self, message=_("Selected map layer is not vector."))
  1646. return
  1647. if not tree.GetLayerInfo(layer):
  1648. return
  1649. dcmd = tree.GetLayerInfo(layer, key="cmd")
  1650. if not dcmd:
  1651. return
  1652. from dbmgr.manager import AttributeManager
  1653. dbmanager = AttributeManager(
  1654. parent=self,
  1655. id=wx.ID_ANY,
  1656. size=wx.Size(500, 300),
  1657. item=layer,
  1658. log=self._gconsole,
  1659. selection=selection,
  1660. )
  1661. # register ATM dialog
  1662. self.dialogs["atm"].append(dbmanager)
  1663. # show ATM window
  1664. dbmanager.Show()
  1665. def _onMapDisplayFocus(self, notebookLayerPage):
  1666. """Changes bookcontrol page to page associated with display."""
  1667. # moved from mapdisp/frame.py
  1668. # TODO: why it is called 3 times when getting focus?
  1669. # and one times when loosing focus?
  1670. if self.workspace_manager.loadingWorkspace:
  1671. return
  1672. pgnum = self.notebookLayers.GetPageIndex(notebookLayerPage)
  1673. if pgnum > -1:
  1674. self.notebookLayers.SetSelection(pgnum)
  1675. self.currentPage = self.notebookLayers.GetCurrentPage()
  1676. def _onStarting3dMode(self, mapDisplayPage):
  1677. """Disables 3D mode for all map displays except for @p mapDisplay"""
  1678. # TODO: it should be disabled also for newly created map windows
  1679. # moreover mapdisp.Disable3dMode() does not work properly
  1680. for page in range(0, self.GetLayerNotebook().GetPageCount()):
  1681. mapdisp = self.GetLayerNotebook().GetPage(page).maptree.GetMapDisplay()
  1682. if self.GetLayerNotebook().GetPage(page) != mapDisplayPage:
  1683. mapdisp.Disable3dMode()
  1684. def OnAddMaps(self, event=None):
  1685. """Add selected map layers into layer tree"""
  1686. dialog = MapLayersDialog(
  1687. parent=self, title=_("Add selected map layers into layer tree")
  1688. )
  1689. dialog.applyAddingMapLayers.connect(self.AddMaps)
  1690. val = dialog.ShowModal()
  1691. if val == wx.ID_OK:
  1692. self.AddMaps(dialog.GetMapLayers(), dialog.GetLayerType(cmd=True))
  1693. dialog.Destroy()
  1694. def AddMaps(self, mapLayers, ltype, check=False):
  1695. """Add map layers to layer tree.
  1696. :param list mapLayers: list of map names
  1697. :param str ltype: layer type ('raster', 'raster_3d', 'vector')
  1698. :param bool check: True if new layers should be checked in
  1699. layer tree False otherwise
  1700. """
  1701. # start new map display if no display is available
  1702. if not self.currentPage:
  1703. self.NewDisplay()
  1704. maptree = self.GetLayerTree()
  1705. for layerName in mapLayers:
  1706. if ltype == "raster":
  1707. cmd = ["d.rast", "map=%s" % layerName]
  1708. elif ltype == "raster_3d":
  1709. cmd = ["d.rast3d", "map=%s" % layerName]
  1710. elif ltype == "vector":
  1711. cmd = ["d.vect", "map=%s" % layerName] + GetDisplayVectSettings()
  1712. else:
  1713. GError(
  1714. parent=self, message=_("Unsupported map layer type <%s>.") % ltype
  1715. )
  1716. return
  1717. maptree.AddLayer(
  1718. ltype=ltype,
  1719. lname=layerName,
  1720. lchecked=check,
  1721. lopacity=1.0,
  1722. lcmd=cmd,
  1723. lgroup=None,
  1724. )
  1725. def _updateCurrentMap(self, **kwargs):
  1726. """Updates map of the current map window."""
  1727. if "delay" in kwargs:
  1728. self.GetMapDisplay().GetWindow().UpdateMap(delay=kwargs["delay"])
  1729. else:
  1730. self.GetMapDisplay().GetWindow().UpdateMap()
  1731. def OnMapCreated(self, name, ltype, add=None):
  1732. """Decides whether the map should be added to layer tree."""
  1733. if add is None:
  1734. # add new map into layer if globally enabled
  1735. if UserSettings.Get(group="cmd", key="addNewLayer", subkey="enabled"):
  1736. self.AddOrUpdateMap(name, ltype)
  1737. elif add:
  1738. # add new map into layer tree
  1739. self.AddOrUpdateMap(name, ltype)
  1740. else:
  1741. # update the map
  1742. display = self.GetMapDisplay()
  1743. display.GetWindow().UpdateMap(render=True)
  1744. def AddOrUpdateMap(self, mapName, ltype):
  1745. """Add map layer or update"""
  1746. # start new map display if no display is available
  1747. if ltype not in ["raster", "raster_3d", "vector"]:
  1748. GError(parent=self, message=_("Unsupported map layer type <%s>.") % ltype)
  1749. return
  1750. if not self.currentPage:
  1751. self.AddMaps([mapName], ltype, check=True)
  1752. else:
  1753. display = self.GetMapDisplay()
  1754. mapLayers = map(
  1755. lambda x: x.GetName(), display.GetMap().GetListOfLayers(ltype=ltype)
  1756. )
  1757. if mapName in mapLayers:
  1758. display.GetWindow().UpdateMap(render=True)
  1759. else:
  1760. self.AddMaps([mapName], ltype, check=True)
  1761. def OnAddRaster(self, event):
  1762. """Add raster map layer"""
  1763. # start new map display if no display is available
  1764. if not self.currentPage:
  1765. self.NewDisplay(show=True)
  1766. self.GetLayerTree().AddLayer("raster")
  1767. def OnAddRasterMisc(self, event):
  1768. """Create misc raster popup-menu"""
  1769. # start new map display if no display is available
  1770. if not self.currentPage:
  1771. self.NewDisplay(show=True)
  1772. self._popupMenu(
  1773. (
  1774. ("layerRaster_3d", self.OnAddRaster3D),
  1775. (None, None),
  1776. ("layerRgb", self.OnAddRasterRGB),
  1777. ("layerHis", self.OnAddRasterHIS),
  1778. (None, None),
  1779. ("layerShaded", self.OnAddRasterShaded),
  1780. (None, None),
  1781. ("layerRastarrow", self.OnAddRasterArrow),
  1782. ("layerRastnum", self.OnAddRasterNum),
  1783. )
  1784. )
  1785. def OnAddVector(self, event):
  1786. """Add vector map to the current layer tree"""
  1787. # start new map display if no display is available
  1788. if not self.currentPage:
  1789. self.NewDisplay(show=True)
  1790. self.GetLayerTree().AddLayer("vector")
  1791. def OnAddVectorMisc(self, event):
  1792. """Create misc vector popup-menu"""
  1793. # start new map display if no display is available
  1794. if not self.currentPage:
  1795. self.NewDisplay(show=True)
  1796. self._popupMenu(
  1797. (
  1798. ("layerThememap", self.OnAddVectorTheme),
  1799. ("layerThemechart", self.OnAddVectorChart),
  1800. )
  1801. )
  1802. def OnAddVectorTheme(self, event):
  1803. """Add thematic vector map to the current layer tree"""
  1804. self.GetLayerTree().AddLayer("thememap")
  1805. def OnAddVectorChart(self, event):
  1806. """Add chart vector map to the current layer tree"""
  1807. self.GetLayerTree().AddLayer("themechart")
  1808. def OnAddOverlay(self, event):
  1809. """Create decoration overlay menu"""
  1810. # start new map display if no display is available
  1811. if not self.currentPage:
  1812. self.NewDisplay(show=True)
  1813. self._popupMenu(
  1814. (
  1815. ("layerGrid", self.OnAddGrid),
  1816. ("layerLabels", self.OnAddLabels),
  1817. ("layerGeodesic", self.OnAddGeodesic),
  1818. ("layerRhumb", self.OnAddRhumb),
  1819. (None, None),
  1820. ("layerCmd", self.OnAddCommand),
  1821. )
  1822. )
  1823. def OnAddRaster3D(self, event):
  1824. """Add 3D raster map to the current layer tree"""
  1825. self.GetLayerTree().AddLayer("raster_3d")
  1826. def OnAddRasterRGB(self, event):
  1827. """Add RGB raster map to the current layer tree"""
  1828. self.GetLayerTree().AddLayer("rgb")
  1829. def OnAddRasterHIS(self, event):
  1830. """Add HIS raster map to the current layer tree"""
  1831. self.GetLayerTree().AddLayer("his")
  1832. def OnAddRasterShaded(self, event):
  1833. """Add shaded relief raster map to the current layer tree"""
  1834. self.GetLayerTree().AddLayer("shaded")
  1835. def OnAddRasterArrow(self, event):
  1836. """Add flow arrows raster map to the current layer tree"""
  1837. # here it seems that it should be retrieved from the mapwindow
  1838. mapdisplay = self.GetMapDisplay()
  1839. resolution = mapdisplay.mapWindowProperties.resolution
  1840. if not resolution:
  1841. dlg = self.MsgDisplayResolution()
  1842. if dlg.ShowModal() == wx.ID_YES:
  1843. mapdisplay.mapWindowProperties.resolution = True
  1844. dlg.Destroy()
  1845. self.GetLayerTree().AddLayer("rastarrow")
  1846. def OnAddRasterNum(self, event):
  1847. """Add cell number raster map to the current layer tree"""
  1848. mapdisplay = self.GetMapDisplay()
  1849. resolution = mapdisplay.mapWindowProperties.resolution
  1850. if not resolution:
  1851. limitText = _(
  1852. "Note that cell values can only be displayed for "
  1853. "regions of less than 10,000 cells."
  1854. )
  1855. dlg = self.MsgDisplayResolution(limitText)
  1856. if dlg.ShowModal() == wx.ID_YES:
  1857. mapdisplay.mapWindowProperties.resolution = True
  1858. dlg.Destroy()
  1859. # region = tree.GetMap().GetCurrentRegion()
  1860. # if region['cells'] > 10000:
  1861. # GMessage(message = "Cell values can only be displayed
  1862. # for regions of < 10,000 cells.", parent = self)
  1863. self.GetLayerTree().AddLayer("rastnum")
  1864. def OnAddCommand(self, event):
  1865. """Add command line map layer to the current layer tree"""
  1866. # start new map display if no display is available
  1867. if not self.currentPage:
  1868. self.NewDisplay(show=True)
  1869. self.GetLayerTree().AddLayer("command")
  1870. def OnAddGroup(self, event):
  1871. """Add layer group"""
  1872. # start new map display if no display is available
  1873. if not self.currentPage:
  1874. self.NewDisplay(show=True)
  1875. self.GetLayerTree().AddLayer("group")
  1876. def OnAddGrid(self, event):
  1877. """Add grid map layer to the current layer tree"""
  1878. self.GetLayerTree().AddLayer("grid")
  1879. def OnAddGeodesic(self, event):
  1880. """Add geodesic line map layer to the current layer tree"""
  1881. self.GetLayerTree().AddLayer("geodesic")
  1882. def OnAddRhumb(self, event):
  1883. """Add rhumb map layer to the current layer tree"""
  1884. self.GetLayerTree().AddLayer("rhumb")
  1885. def OnAddLabels(self, event):
  1886. """Add vector labels map layer to the current layer tree"""
  1887. # start new map display if no display is available
  1888. if not self.currentPage:
  1889. self.NewDisplay(show=True)
  1890. self.GetLayerTree().AddLayer("labels")
  1891. def OnShowRegionExtent(self, event):
  1892. """Add vector labels map layer to the current layer tree"""
  1893. # start new map display if no display is available
  1894. if not self.currentPage:
  1895. self.NewDisplay(show=True)
  1896. # get current map display
  1897. mapdisp = self.GetMapDisplay()
  1898. # change the property
  1899. mapdisp.mapWindowProperties.showRegion = True
  1900. # show map display (user said show so make sure it is visible)
  1901. mapdisp.Show()
  1902. # redraw map if auto-rendering is enabled
  1903. # seems little too low level for this place
  1904. # no redraw when Render is unchecked
  1905. if mapdisp.IsAutoRendered():
  1906. mapdisp.GetMapWindow().UpdateMap(render=False)
  1907. def OnDeleteLayer(self, event):
  1908. """Remove selected map layer from the current layer Tree"""
  1909. if not self.currentPage or not self.GetLayerTree().layer_selected:
  1910. self.MsgNoLayerSelected()
  1911. return
  1912. if UserSettings.Get(group="manager", key="askOnRemoveLayer", subkey="enabled"):
  1913. layerName = ""
  1914. for item in self.GetLayerTree().GetSelections():
  1915. name = self.GetLayerTree().GetItemText(item)
  1916. idx = name.find("(" + _("opacity:"))
  1917. if idx > -1:
  1918. layerName += "<" + name[:idx].strip(" ") + ">,\n"
  1919. else:
  1920. layerName += "<" + name + ">,\n"
  1921. layerName = layerName.rstrip(",\n")
  1922. if len(layerName) > 2: # <>
  1923. message = (
  1924. _("Do you want to remove map layer(s)\n%s\n" "from layer tree?")
  1925. % layerName
  1926. )
  1927. else:
  1928. message = _(
  1929. "Do you want to remove selected map layer(s) " "from layer tree?"
  1930. )
  1931. dlg = wx.MessageDialog(
  1932. parent=self,
  1933. message=message,
  1934. caption=_("Remove map layer"),
  1935. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION,
  1936. )
  1937. if dlg.ShowModal() != wx.ID_YES:
  1938. dlg.Destroy()
  1939. return
  1940. dlg.Destroy()
  1941. for layer in self.GetLayerTree().GetSelections():
  1942. if self.GetLayerTree().GetLayerInfo(layer, key="type") == "group":
  1943. self.GetLayerTree().DeleteChildren(layer)
  1944. # nested children group layer in the parent group layer (both selected)
  1945. try:
  1946. self.GetLayerTree().Delete(layer)
  1947. except ValueError:
  1948. pass
  1949. def OnKeyDown(self, event):
  1950. """Key pressed"""
  1951. kc = event.GetKeyCode()
  1952. try:
  1953. kc = chr(kc)
  1954. except ValueError:
  1955. event.Skip()
  1956. return
  1957. if event.CtrlDown():
  1958. if kc == "R":
  1959. self.OnAddRaster(None)
  1960. elif kc == "V":
  1961. self.OnAddVector(None)
  1962. event.Skip()
  1963. def OnCloseWindow(self, event):
  1964. """Cleanup when wxGUI is quitted"""
  1965. self._closeWindow(event)
  1966. def OnCloseWindowOrExit(self, event):
  1967. """Cleanup when wxGUI is quitted
  1968. Ask user also to quit GRASS including terminal
  1969. """
  1970. dlg = QuitDialog(self)
  1971. ret = dlg.ShowModal()
  1972. dlg.Destroy()
  1973. if ret != wx.ID_CANCEL:
  1974. self._closeWindow(event)
  1975. if ret == wx.ID_YES:
  1976. self._quitGRASS()
  1977. def _closeWindow(self, event):
  1978. """Close wxGUI"""
  1979. # save command protocol if actived
  1980. if self.goutput.btnCmdProtocol.GetValue():
  1981. self.goutput.CmdProtocolSave()
  1982. if not self.currentPage:
  1983. self._auimgr.UnInit()
  1984. self.Destroy()
  1985. return
  1986. if not self.workspace_manager.CanClosePage(caption=_("Quit GRASS GUI")):
  1987. # when called from menu, it gets CommandEvent and not
  1988. # CloseEvent
  1989. if hasattr(event, "Veto"):
  1990. event.Veto()
  1991. return
  1992. self.DisplayCloseAll()
  1993. self._auimgr.UnInit()
  1994. self.Destroy()
  1995. def _quitGRASS(self):
  1996. """Quit GRASS terminal"""
  1997. shellPid = get_shell_pid()
  1998. if shellPid is None:
  1999. return
  2000. Debug.msg(1, "Exiting shell with pid={0}".format(shellPid))
  2001. import signal
  2002. os.kill(shellPid, signal.SIGTERM)
  2003. def MsgNoLayerSelected(self):
  2004. """Show dialog message 'No layer selected'"""
  2005. wx.MessageBox(
  2006. parent=self,
  2007. message=_("No map layer selected. Operation canceled."),
  2008. caption=_("Message"),
  2009. style=wx.OK | wx.ICON_INFORMATION | wx.CENTRE,
  2010. )
  2011. def MsgDisplayResolution(self, limitText=None):
  2012. """Returns dialog for d.rast.num, d.rast.arrow
  2013. when display resolution is not constrained
  2014. :param limitText: adds a note about cell limit
  2015. """
  2016. message = _(
  2017. "Display resolution is currently not constrained to "
  2018. "computational settings. "
  2019. "It's suggested to constrain map to region geometry. "
  2020. "Do you want to constrain "
  2021. "the resolution?"
  2022. )
  2023. if limitText:
  2024. message += "\n\n%s" % _(limitText)
  2025. dlg = wx.MessageDialog(
  2026. parent=self,
  2027. message=message,
  2028. caption=_("Constrain map to region geometry?"),
  2029. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION | wx.CENTRE,
  2030. )
  2031. return dlg
  2032. def OnMapNotebookClose(self, event):
  2033. """Page of map notebook is being closed"""
  2034. display = self.GetMapDisplay(onlyCurrent=True)
  2035. display.OnCloseWindow(event=None, askIfSaveWorkspace=True)
  2036. event.Veto()