Coverage for src/robotide/editor/clipboard.py: 80%

1# Copyright 2008-2015 Nokia Networks 

2# Copyright 2016- Robot Framework Foundation 

3# 

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

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

6# You may obtain a copy of the License at 

7# 

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

9# 

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

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

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

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

14# limitations under the License. 

15 

16import os 2 ctx1ef

17 

18import wx 2 ctx1ef

19 

20from ..context import IS_WINDOWS, IS_MAC 2 ctx1ef

21 

22 

23class _ClipboardHandler(object): 2 ctx1ef

24 

25 def __init__(self, grid): 2 ctx1ef

26 self._grid = grid (empty)

27 self._clipboard = _GridClipboard() (empty)

28 

29 def clipboard_content(self): 2 ctx1ef

30 return self._clipboard.get_contents() 7 ctx1ghiabcd

31 

32 def clear(self): 2 ctx1ef

33 """Clears the content of clipboard. 

34 """ 

35 self._clipboard.set_contents('') 13 ctx1ghijklmabcdno

36 

37 def copy(self): 2 ctx1ef

38 """Copy the contents of the selected cell(s). This does a normal copy 

39 action if the user is editing a cell, otherwise it places the selected 

40 range of cells on the data. 

41 """ 

42 # print(f"DEBUG: Clipboard copy() got called \ncells={self._grid.cells}") 

43 if not self._edit_control_shown(): 43 ↛ exitline 43 didn't return from function 'copy' because the condition on line 43 was always true7 ctx1ghiabcd

44 self._add_selected_data_to_clipboard() 7 ctx1ghiabcd

45 

46 def cut(self): 2 ctx1ef

47 """Cuts the contents of the selected cell(s). This does a normal cut 

48 action if the user is editing a cell, otherwise it places the selected 

49 range of cells on the clipboard. 

50 """ 

51 self._add_selected_data_to_clipboard() 6 ctx1jklmno

52 

53 def _add_selected_data_to_clipboard(self): 2 ctx1ef

54 content = self._grid.get_selected_content() 13 ctx1ghijklmabcdno

55 # print(f"DEBUG: Clipboard _add_selected_data_to_clipboard content={content}\n") 

56 self._clipboard.set_contents(content) 13 ctx1ghijklmabcdno

57 

58 def paste(self): 2 ctx1ef

59 """Paste the contents of the clipboard. If a cell is being edited just 

60 do a normal paste. If a cell is not being edited, paste whole rows. 

61 """ 

62 if not self._edit_control_shown(): 62 ↛ exitline 62 didn't return from function 'paste' because the condition on line 62 was always true4 ctx1abcd

63 self._paste_to_grid() 4 ctx1abcd

64 

65 def _paste_to_cell_editor(self): 2 ctx1ef

66 clipboard = self._clipboard.get_contents() 

67 if isinstance(clipboard, list): 

68 cells_as_text = ' '.join([' '.join(row) for row in clipboard]) 

69 self._get_edit_control().WriteText(cells_as_text) 

70 

71 def _paste_to_grid(self): 2 ctx1ef

72 clipboard = self._clipboard.get_contents() 4 ctx1abcd

73 if not clipboard: 73 ↛ 74line 73 didn't jump to line 74 because the condition on line 73 was never true4 ctx1abcd

74 return 

75 cell = self._get_starting_cell() 4 ctx1abcd

76 if not isinstance(clipboard, list): 76 ↛ 77line 76 didn't jump to line 77 because the condition on line 76 was never true4 ctx1abcd

77 self._write_cell(cell.row, cell.col, clipboard) 

78 else: 

79 row = cell.row 4 ctx1abcd

80 for datarow in clipboard: 4 ctx1abcd

81 col = cell.col 4 ctx1abcd

82 for value in datarow: 4 ctx1abcd

83 self._write_cell(row, col, value) 4 ctx1abcd

84 col += 1 4 ctx1abcd

85 row += 1 4 ctx1abcd

86 

87 def _get_starting_cell(self): 2 ctx1ef

88 return self._grid.selection.topleft 4 ctx1abcd

89 

90 def _write_cell(self, row, col, value): 2 ctx1ef

91 self._grid.write_cell(row, col, value, update_history=False) 4 ctx1abcd

92 

93 def _get_edit_control(self): 2 ctx1ef

94 return self._grid.get_cell_edit_control() 

95 

96 def _edit_control_shown(self): 2 ctx1ef

97 return self._grid.IsCellEditControlShown() 13 ctx1ghijklmabcdno

98 

99 

100class _WindowsClipboardHandler(_ClipboardHandler): 2 ctx1ef

101 

102 def copy(self): 2 ctx1ef

103 if self._edit_control_shown(): 103 ↛ 104line 103 didn't jump to line 104 because the condition on line 103 was never true7 ctx1ghiabcd

104 self._get_edit_control().Copy() 

105 else: 

106 _ClipboardHandler.copy(self) 7 ctx1ghiabcd

107 

108 def cut(self): 2 ctx1ef

109 if self._edit_control_shown(): 109 ↛ 110line 109 didn't jump to line 110 because the condition on line 109 was never true6 ctx1jklmno

110 self._get_edit_control().Cut() 

111 else: 

112 _ClipboardHandler.cut(self) 6 ctx1jklmno

113 

114 def _paste_to_cell_editor(self): 2 ctx1ef

115 self._get_edit_control().Paste() 

116 

117 def paste(self): 2 ctx1ef

118 if self._edit_control_shown(): 118 ↛ 119line 118 didn't jump to line 119 because the condition on line 118 was never true4 ctx1abcd

119 self._paste_to_cell_editor() 

120 else: 

121 _ClipboardHandler.paste(self) 4 ctx1abcd

122 

123 

124# for now mac clipboard handler is the same with windows 

125ClipboardHandler = _WindowsClipboardHandler if IS_WINDOWS or IS_MAC else _ClipboardHandler 2 ctx1ef

126 

127 

128class _GridClipboard(object): 2 ctx1ef

129 """Implements a "smart" clipboard.""" 

130 

131 def set_contents(self, data): 2 ctx1ef

132 """Insert `data` to the system clipboard 

133 

134 `data` may be either a string or list of lists representing rows of 

135 grid data. Other data is ignored 

136 """ 

137 data = self._format_data(data) 16 ctx1qrpghijklmabcdno

138 if not (data and wx.TheClipboard.Open()): 16 ctx1qrpghijklmabcdno

139 return 13 ctx1ghijklmabcdno

140 try: 16 ctx1qrpghijklmabcdno

141 tdo = wx.TextDataObject() 16 ctx1qrpghijklmabcdno

142 tdo.SetText(data) 16 ctx1qrpghijklmabcdno

143 wx.TheClipboard.SetData(tdo) 16 ctx1qrpghijklmabcdno

144 finally: 

145 wx.TheClipboard.Close() 16 ctx1qrpghijklmabcdno

146 

147 def _format_data(self, data): 2 ctx1ef

148 if isinstance(data, list): 16 ctx1qrpghijklmabcdno

149 return os.linesep.join('\t'.join(row) for row in data) 15 ctx1qrghijklmabcdno

150 if isinstance(data, str): 150 ↛ 152line 150 didn't jump to line 152 because the condition on line 150 was always true14 ctx1pghijklmabcdno

151 return data 14 ctx1pghijklmabcdno

152 return None 

153 

154 def get_contents(self): 2 ctx1ef

155 """Gets contents of the clipboard. 

156 

157 Returns either a string or a list of rows to be pasted into clipboard. 

158 """ 

159 return self._split_string_from_tabs_and_newlines(self._get_contents()) 10 ctx1ghijklabcd

160 

161 def _get_contents(self): 2 ctx1ef

162 if not wx.TheClipboard.Open(): 162 ↛ 163line 162 didn't jump to line 163 because the condition on line 162 was never true13 ctx1qrpghijklabcd

163 return '' 

164 try: 13 ctx1qrpghijklabcd

165 tdo = wx.TextDataObject() 13 ctx1qrpghijklabcd

166 wx.TheClipboard.GetData(tdo) 13 ctx1qrpghijklabcd

167 return tdo.GetText() or '' 13 ctx1qrpghijklabcd

168 finally: 

169 wx.TheClipboard.Close() 13 ctx1qrpghijklabcd

170 

171 def _split_string_from_tabs_and_newlines(self, string): 2 ctx1ef

172 return [line.split('\t') for line in string.splitlines()] 10 ctx1ghijklabcd