Coverage for src/robotide/ui/fileexplorerplugin.py: 70%

1# Copyright 2020- Robot Framework Foundation 

2# 

3# Licensed under the Apache License, Version 2.0 (the "License"); 

4# you may not use this file except in compliance with the License. 

5# You may obtain a copy of the License at 

6# 

7# http://www.apache.org/licenses/LICENSE-2.0 

8# 

9# Unless required by applicable law or agreed to in writing, software 

10# distributed under the License is distributed on an "AS IS" BASIS, 

11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 

12# See the License for the specific language governing permissions and 

13# limitations under the License. 

14 

15import builtins 2 ctx1ab

16import wx 2 ctx1ab

17from wx.lib.agw import customtreectrl 2 ctx1ab

18from wx.lib.agw.aui import GetManager 2 ctx1ab

19 

20from ..controller.project import Project 2 ctx1ab

21from ..pluginapi import Plugin 2 ctx1ab

22from ..pluginapi.plugin import ActionInfo 2 ctx1ab

23 

24_ = wx.GetTranslation # To keep linter/code analyser happy 2 ctx1ab

25builtins.__dict__['_'] = wx.GetTranslation 2 ctx1ab

26 

27 

28class FileExplorerPlugin(Plugin): 2 ctx1ab

29 __doc__ = _("""Provides a tree view for Files and Folders. Opens selected item with mouse right-click.""") 2 ctx1ab

30 

31 datafile = property(lambda self: self.get_selected_datafile()) 2 ctx1ab

32 defaults = {"opened": True, 2 ctx1ab

33 "docked": True, 

34 "own colors": False 

35 } 

36 

37 def __init__(self, application, controller=None): 2 ctx1ab

38 Plugin.__init__(self, application, default_settings=self.defaults) (empty)

39 self._app = application (empty)

40 self.settings = self._app.settings.config_obj['Plugins']['File Explorer'] (empty)

41 self._parent = wx.App.Get().GetTopWindow() (empty)

42 self._filemgr = self.filemgr (empty)

43 self._filemgr.SetThemeEnabled(True) (empty)

44 self._mgr = GetManager(self._filemgr) (empty)

45 self._controller = controller (empty)

46 self._pane = None (empty)

47 self._filetreectrl = None (empty)

48 self.opened = self.settings['opened'] (empty)

49 self.font = self._filemgr.GetFont() (empty)

50 

51 def register_frame(self, parent=None): 2 ctx1ab

52 if parent: 

53 self._parent = parent 

54 

55 if self._mgr.GetPane("file_manager") in self._mgr._panes: 

56 register = self._mgr.InsertPane 

57 else: 

58 register = self._mgr.AddPane 

59 

60 register(self._filemgr, wx.lib.agw.aui.AuiPaneInfo().Name("file_manager"). 

61 Caption(_("Files")).LeftDockable(True).CloseButton(False)) 

62 

63 self._mgr.Update() 

64 

65 def enable(self): 2 ctx1ab

66 self.register_action(ActionInfo(_('View'), _('View File Explorer'), self.toggle_view, (empty)

67 shortcut='F11', 

68 doc=_('Show File Explorer panel'), 

69 position=1)) 

70 self.show_file_explorer() (empty)

71 if not self.opened: 71 ↛ exitline 71 didn't return from function 'enable' because the condition on line 71 was always true(empty)

72 self.close_tree() (empty)

73 

74 def close_tree(self): 2 ctx1ab

75 # self.save_setting('opened', False) 

76 self.opened = False (empty)

77 self._mgr.DetachPane(self._filemgr) (empty)

78 self._filemgr.Hide() (empty)

79 self._mgr.Update() (empty)

80 

81 def is_focused(self): 2 ctx1ab

82 return self._filemgr.HasFocus() 

83 

84 def toggle_view(self, event): 2 ctx1ab

85 __ = event 

86 self.save_setting('opened', not self.opened) 

87 if not self.opened: 

88 self.opened = True 

89 self.show_file_explorer() 

90 else: 

91 self.close_tree() 

92 

93 def show_file_explorer(self): 2 ctx1ab

94 if not self._parent: 94 ↛ 95line 94 didn't jump to line 95 because the condition on line 94 was never true(empty)

95 self._parent = wx.App.Get().GetWindow() # self.frame 

96 if not self._filemgr: # This is not needed because file explorer is always created 96 ↛ 97line 96 didn't jump to line 97 because the condition on line 96 was never true(empty)

97 self._filemgr = FileExplorer(self._parent, self._controller) 

98 

99 self._pane = self._mgr.GetPane(self._filemgr) (empty)

100 global_settings = self._app.settings.config_obj['General'] (empty)

101 apply_global = global_settings['apply to panels'] (empty)

102 use_own = self.settings['own colors'] (empty)

103 if apply_global or not use_own: 103 ↛ 107line 103 didn't jump to line 107 because the condition on line 103 was always true(empty)

104 html_background = self.settings.get('background help', (240, 242, 80)) (empty)

105 html_foreground = self.settings.get('foreground text', (7, 0, 70)) (empty)

106 else: 

107 html_background = self.settings.get('background', (240, 242, 80)) 

108 html_foreground = self.settings.get('foreground', (7, 0, 70)) 

109 html_font_face = self.settings.get('font face', '') (empty)

110 html_font_size = self.settings.get('font size', 11) (empty)

111 self._filetreectrl = self._filemgr.GetTreeCtrl() (empty)

112 self._filemgr.Show(True) (empty)

113 self._filemgr.SetMinSize(wx.Size(200, 225)) (empty)

114 self._mgr.DetachPane(self._filemgr) (empty)

115 self._mgr.AddPane(self.filemgr, (empty)

116 wx.lib.agw.aui.AuiPaneInfo().Name("file_manager"). 

117 Caption(_("Files")).LeftDockable(True). 

118 CloseButton(False)) 

119 self._filemgr.SetBackgroundStyle(wx.BG_STYLE_SYSTEM) (empty)

120 self._filemgr.SetBackgroundColour(html_background) (empty)

121 self._filemgr.SetForegroundColour(html_foreground) (empty)

122 self.font = self._filemgr.GetFont() (empty)

123 self.font.SetFaceName(html_font_face) (empty)

124 self.font.SetPointSize(html_font_size) (empty)

125 self._filemgr.SetFont(self.font) (empty)

126 self._filemgr.Refresh() (empty)

127 self._filetreectrl.SetBackgroundColour(html_background) (empty)

128 self._filetreectrl.SetForegroundColour(html_foreground) (empty)

129 self._filetreectrl.SetFont(self.font) (empty)

130 self._filetreectrl.Refresh() (empty)

131 self._filemgr.Raise() (empty)

132 self._mgr.Update() (empty)

133 self.update_tree() (empty)

134 

135 def update_tree(self): 2 ctx1ab

136 if not self._filemgr: 136 ↛ 137line 136 didn't jump to line 137 because the condition on line 136 was never true(empty)

137 return 

138 self._filemgr.update_tree() (empty)

139 

140 

141class FileExplorer(wx.GenericDirCtrl): 2 ctx1ab

142 

143 def __init__(self, parent, controller=None): 2 ctx1ab

144 wx.GenericDirCtrl.__init__(self, parent, id=-1, size=(200, 225), style=wx.DIRCTRL_3D_INTERNAL) (empty)

145 self._controller = controller (empty)

146 self.SetThemeEnabled(True) (empty)

147 self.Refresh() (empty)

148 

149 def update_tree(self): 2 ctx1ab

150 if isinstance(self._controller, Project): 150 ↛ exitline 150 didn't return from function 'update_tree' because the condition on line 150 was always true(empty)

151 if self._controller.data and len(self._controller.data.directory) > 1: 151 ↛ 152line 151 didn't jump to line 152 because the condition on line 151 was never true(empty)

152 self.SelectPath(self._controller.data.source) 

153 try: 

154 self.ExpandPath(self._controller.data.source) 

155 except Exception: 

156 pass 

157 self.Refresh() 

158 self.Update()