editor.py 64 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673
  1. import importlib.abc
  2. import importlib.util
  3. import os
  4. import platform
  5. import re
  6. import string
  7. import sys
  8. import tokenize
  9. import traceback
  10. import webbrowser
  11. from tkinter import *
  12. from tkinter.font import Font
  13. from tkinter.ttk import Scrollbar
  14. from tkinter import simpledialog
  15. from tkinter import messagebox
  16. from idlelib.config import idleConf
  17. from idlelib import configdialog
  18. from idlelib import grep
  19. from idlelib import help
  20. from idlelib import help_about
  21. from idlelib import macosx
  22. from idlelib.multicall import MultiCallCreator
  23. from idlelib import pyparse
  24. from idlelib import query
  25. from idlelib import replace
  26. from idlelib import search
  27. from idlelib.tree import wheel_event
  28. from idlelib.util import py_extensions
  29. from idlelib import window
  30. # The default tab setting for a Text widget, in average-width characters.
  31. TK_TABWIDTH_DEFAULT = 8
  32. _py_version = ' (%s)' % platform.python_version()
  33. darwin = sys.platform == 'darwin'
  34. def _sphinx_version():
  35. "Format sys.version_info to produce the Sphinx version string used to install the chm docs"
  36. major, minor, micro, level, serial = sys.version_info
  37. release = '%s%s' % (major, minor)
  38. release += '%s' % (micro,)
  39. if level == 'candidate':
  40. release += 'rc%s' % (serial,)
  41. elif level != 'final':
  42. release += '%s%s' % (level[0], serial)
  43. return release
  44. class EditorWindow:
  45. from idlelib.percolator import Percolator
  46. from idlelib.colorizer import ColorDelegator, color_config
  47. from idlelib.undo import UndoDelegator
  48. from idlelib.iomenu import IOBinding, encoding
  49. from idlelib import mainmenu
  50. from idlelib.statusbar import MultiStatusBar
  51. from idlelib.autocomplete import AutoComplete
  52. from idlelib.autoexpand import AutoExpand
  53. from idlelib.calltip import Calltip
  54. from idlelib.codecontext import CodeContext
  55. from idlelib.sidebar import LineNumbers
  56. from idlelib.format import FormatParagraph, FormatRegion, Indents, Rstrip
  57. from idlelib.parenmatch import ParenMatch
  58. from idlelib.squeezer import Squeezer
  59. from idlelib.zoomheight import ZoomHeight
  60. filesystemencoding = sys.getfilesystemencoding() # for file names
  61. help_url = None
  62. allow_code_context = True
  63. allow_line_numbers = True
  64. def __init__(self, flist=None, filename=None, key=None, root=None):
  65. # Delay import: runscript imports pyshell imports EditorWindow.
  66. from idlelib.runscript import ScriptBinding
  67. if EditorWindow.help_url is None:
  68. dochome = os.path.join(sys.base_prefix, 'Doc', 'index.html')
  69. if sys.platform.count('linux'):
  70. # look for html docs in a couple of standard places
  71. pyver = 'python-docs-' + '%s.%s.%s' % sys.version_info[:3]
  72. if os.path.isdir('/var/www/html/python/'): # "python2" rpm
  73. dochome = '/var/www/html/python/index.html'
  74. else:
  75. basepath = '/usr/share/doc/' # standard location
  76. dochome = os.path.join(basepath, pyver,
  77. 'Doc', 'index.html')
  78. elif sys.platform[:3] == 'win':
  79. chmfile = os.path.join(sys.base_prefix, 'Doc',
  80. 'Python%s.chm' % _sphinx_version())
  81. if os.path.isfile(chmfile):
  82. dochome = chmfile
  83. elif sys.platform == 'darwin':
  84. # documentation may be stored inside a python framework
  85. dochome = os.path.join(sys.base_prefix,
  86. 'Resources/English.lproj/Documentation/index.html')
  87. dochome = os.path.normpath(dochome)
  88. if os.path.isfile(dochome):
  89. EditorWindow.help_url = dochome
  90. if sys.platform == 'darwin':
  91. # Safari requires real file:-URLs
  92. EditorWindow.help_url = 'file://' + EditorWindow.help_url
  93. else:
  94. EditorWindow.help_url = ("https://docs.python.org/%d.%d/"
  95. % sys.version_info[:2])
  96. self.flist = flist
  97. root = root or flist.root
  98. self.root = root
  99. self.menubar = Menu(root)
  100. self.top = top = window.ListedToplevel(root, menu=self.menubar)
  101. if flist:
  102. self.tkinter_vars = flist.vars
  103. #self.top.instance_dict makes flist.inversedict available to
  104. #configdialog.py so it can access all EditorWindow instances
  105. self.top.instance_dict = flist.inversedict
  106. else:
  107. self.tkinter_vars = {} # keys: Tkinter event names
  108. # values: Tkinter variable instances
  109. self.top.instance_dict = {}
  110. self.recent_files_path = idleConf.userdir and os.path.join(
  111. idleConf.userdir, 'recent-files.lst')
  112. self.prompt_last_line = '' # Override in PyShell
  113. self.text_frame = text_frame = Frame(top)
  114. self.vbar = vbar = Scrollbar(text_frame, name='vbar')
  115. width = idleConf.GetOption('main', 'EditorWindow', 'width', type='int')
  116. text_options = {
  117. 'name': 'text',
  118. 'padx': 5,
  119. 'wrap': 'none',
  120. 'highlightthickness': 0,
  121. 'width': width,
  122. 'tabstyle': 'wordprocessor', # new in 8.5
  123. 'height': idleConf.GetOption(
  124. 'main', 'EditorWindow', 'height', type='int'),
  125. }
  126. self.text = text = MultiCallCreator(Text)(text_frame, **text_options)
  127. self.top.focused_widget = self.text
  128. self.createmenubar()
  129. self.apply_bindings()
  130. self.top.protocol("WM_DELETE_WINDOW", self.close)
  131. self.top.bind("<<close-window>>", self.close_event)
  132. if macosx.isAquaTk():
  133. # Command-W on editor windows doesn't work without this.
  134. text.bind('<<close-window>>', self.close_event)
  135. # Some OS X systems have only one mouse button, so use
  136. # control-click for popup context menus there. For two
  137. # buttons, AquaTk defines <2> as the right button, not <3>.
  138. text.bind("<Control-Button-1>",self.right_menu_event)
  139. text.bind("<2>", self.right_menu_event)
  140. else:
  141. # Elsewhere, use right-click for popup menus.
  142. text.bind("<3>",self.right_menu_event)
  143. text.bind('<MouseWheel>', wheel_event)
  144. text.bind('<Button-4>', wheel_event)
  145. text.bind('<Button-5>', wheel_event)
  146. text.bind('<Configure>', self.handle_winconfig)
  147. text.bind("<<cut>>", self.cut)
  148. text.bind("<<copy>>", self.copy)
  149. text.bind("<<paste>>", self.paste)
  150. text.bind("<<center-insert>>", self.center_insert_event)
  151. text.bind("<<help>>", self.help_dialog)
  152. text.bind("<<python-docs>>", self.python_docs)
  153. text.bind("<<about-idle>>", self.about_dialog)
  154. text.bind("<<open-config-dialog>>", self.config_dialog)
  155. text.bind("<<open-module>>", self.open_module_event)
  156. text.bind("<<do-nothing>>", lambda event: "break")
  157. text.bind("<<select-all>>", self.select_all)
  158. text.bind("<<remove-selection>>", self.remove_selection)
  159. text.bind("<<find>>", self.find_event)
  160. text.bind("<<find-again>>", self.find_again_event)
  161. text.bind("<<find-in-files>>", self.find_in_files_event)
  162. text.bind("<<find-selection>>", self.find_selection_event)
  163. text.bind("<<replace>>", self.replace_event)
  164. text.bind("<<goto-line>>", self.goto_line_event)
  165. text.bind("<<smart-backspace>>",self.smart_backspace_event)
  166. text.bind("<<newline-and-indent>>",self.newline_and_indent_event)
  167. text.bind("<<smart-indent>>",self.smart_indent_event)
  168. self.fregion = fregion = self.FormatRegion(self)
  169. # self.fregion used in smart_indent_event to access indent_region.
  170. text.bind("<<indent-region>>", fregion.indent_region_event)
  171. text.bind("<<dedent-region>>", fregion.dedent_region_event)
  172. text.bind("<<comment-region>>", fregion.comment_region_event)
  173. text.bind("<<uncomment-region>>", fregion.uncomment_region_event)
  174. text.bind("<<tabify-region>>", fregion.tabify_region_event)
  175. text.bind("<<untabify-region>>", fregion.untabify_region_event)
  176. indents = self.Indents(self)
  177. text.bind("<<toggle-tabs>>", indents.toggle_tabs_event)
  178. text.bind("<<change-indentwidth>>", indents.change_indentwidth_event)
  179. text.bind("<Left>", self.move_at_edge_if_selection(0))
  180. text.bind("<Right>", self.move_at_edge_if_selection(1))
  181. text.bind("<<del-word-left>>", self.del_word_left)
  182. text.bind("<<del-word-right>>", self.del_word_right)
  183. text.bind("<<beginning-of-line>>", self.home_callback)
  184. if flist:
  185. flist.inversedict[self] = key
  186. if key:
  187. flist.dict[key] = self
  188. text.bind("<<open-new-window>>", self.new_callback)
  189. text.bind("<<close-all-windows>>", self.flist.close_all_callback)
  190. text.bind("<<open-class-browser>>", self.open_module_browser)
  191. text.bind("<<open-path-browser>>", self.open_path_browser)
  192. text.bind("<<open-turtle-demo>>", self.open_turtle_demo)
  193. self.set_status_bar()
  194. text_frame.pack(side=LEFT, fill=BOTH, expand=1)
  195. text_frame.rowconfigure(1, weight=1)
  196. text_frame.columnconfigure(1, weight=1)
  197. vbar['command'] = self.handle_yview
  198. vbar.grid(row=1, column=2, sticky=NSEW)
  199. text['yscrollcommand'] = vbar.set
  200. text['font'] = idleConf.GetFont(self.root, 'main', 'EditorWindow')
  201. text.grid(row=1, column=1, sticky=NSEW)
  202. text.focus_set()
  203. self.set_width()
  204. # usetabs true -> literal tab characters are used by indent and
  205. # dedent cmds, possibly mixed with spaces if
  206. # indentwidth is not a multiple of tabwidth,
  207. # which will cause Tabnanny to nag!
  208. # false -> tab characters are converted to spaces by indent
  209. # and dedent cmds, and ditto TAB keystrokes
  210. # Although use-spaces=0 can be configured manually in config-main.def,
  211. # configuration of tabs v. spaces is not supported in the configuration
  212. # dialog. IDLE promotes the preferred Python indentation: use spaces!
  213. usespaces = idleConf.GetOption('main', 'Indent',
  214. 'use-spaces', type='bool')
  215. self.usetabs = not usespaces
  216. # tabwidth is the display width of a literal tab character.
  217. # CAUTION: telling Tk to use anything other than its default
  218. # tab setting causes it to use an entirely different tabbing algorithm,
  219. # treating tab stops as fixed distances from the left margin.
  220. # Nobody expects this, so for now tabwidth should never be changed.
  221. self.tabwidth = 8 # must remain 8 until Tk is fixed.
  222. # indentwidth is the number of screen characters per indent level.
  223. # The recommended Python indentation is four spaces.
  224. self.indentwidth = self.tabwidth
  225. self.set_notabs_indentwidth()
  226. # Store the current value of the insertofftime now so we can restore
  227. # it if needed.
  228. if not hasattr(idleConf, 'blink_off_time'):
  229. idleConf.blink_off_time = self.text['insertofftime']
  230. self.update_cursor_blink()
  231. # When searching backwards for a reliable place to begin parsing,
  232. # first start num_context_lines[0] lines back, then
  233. # num_context_lines[1] lines back if that didn't work, and so on.
  234. # The last value should be huge (larger than the # of lines in a
  235. # conceivable file).
  236. # Making the initial values larger slows things down more often.
  237. self.num_context_lines = 50, 500, 5000000
  238. self.per = per = self.Percolator(text)
  239. self.undo = undo = self.UndoDelegator()
  240. per.insertfilter(undo)
  241. text.undo_block_start = undo.undo_block_start
  242. text.undo_block_stop = undo.undo_block_stop
  243. undo.set_saved_change_hook(self.saved_change_hook)
  244. # IOBinding implements file I/O and printing functionality
  245. self.io = io = self.IOBinding(self)
  246. io.set_filename_change_hook(self.filename_change_hook)
  247. self.good_load = False
  248. self.set_indentation_params(False)
  249. self.color = None # initialized below in self.ResetColorizer
  250. self.code_context = None # optionally initialized later below
  251. self.line_numbers = None # optionally initialized later below
  252. if filename:
  253. if os.path.exists(filename) and not os.path.isdir(filename):
  254. if io.loadfile(filename):
  255. self.good_load = True
  256. is_py_src = self.ispythonsource(filename)
  257. self.set_indentation_params(is_py_src)
  258. else:
  259. io.set_filename(filename)
  260. self.good_load = True
  261. self.ResetColorizer()
  262. self.saved_change_hook()
  263. self.update_recent_files_list()
  264. self.load_extensions()
  265. menu = self.menudict.get('window')
  266. if menu:
  267. end = menu.index("end")
  268. if end is None:
  269. end = -1
  270. if end >= 0:
  271. menu.add_separator()
  272. end = end + 1
  273. self.wmenu_end = end
  274. window.register_callback(self.postwindowsmenu)
  275. # Some abstractions so IDLE extensions are cross-IDE
  276. self.askinteger = simpledialog.askinteger
  277. self.askyesno = messagebox.askyesno
  278. self.showerror = messagebox.showerror
  279. # Add pseudoevents for former extension fixed keys.
  280. # (This probably needs to be done once in the process.)
  281. text.event_add('<<autocomplete>>', '<Key-Tab>')
  282. text.event_add('<<try-open-completions>>', '<KeyRelease-period>',
  283. '<KeyRelease-slash>', '<KeyRelease-backslash>')
  284. text.event_add('<<try-open-calltip>>', '<KeyRelease-parenleft>')
  285. text.event_add('<<refresh-calltip>>', '<KeyRelease-parenright>')
  286. text.event_add('<<paren-closed>>', '<KeyRelease-parenright>',
  287. '<KeyRelease-bracketright>', '<KeyRelease-braceright>')
  288. # Former extension bindings depends on frame.text being packed
  289. # (called from self.ResetColorizer()).
  290. autocomplete = self.AutoComplete(self)
  291. text.bind("<<autocomplete>>", autocomplete.autocomplete_event)
  292. text.bind("<<try-open-completions>>",
  293. autocomplete.try_open_completions_event)
  294. text.bind("<<force-open-completions>>",
  295. autocomplete.force_open_completions_event)
  296. text.bind("<<expand-word>>", self.AutoExpand(self).expand_word_event)
  297. text.bind("<<format-paragraph>>",
  298. self.FormatParagraph(self).format_paragraph_event)
  299. parenmatch = self.ParenMatch(self)
  300. text.bind("<<flash-paren>>", parenmatch.flash_paren_event)
  301. text.bind("<<paren-closed>>", parenmatch.paren_closed_event)
  302. scriptbinding = ScriptBinding(self)
  303. text.bind("<<check-module>>", scriptbinding.check_module_event)
  304. text.bind("<<run-module>>", scriptbinding.run_module_event)
  305. text.bind("<<run-custom>>", scriptbinding.run_custom_event)
  306. text.bind("<<do-rstrip>>", self.Rstrip(self).do_rstrip)
  307. self.ctip = ctip = self.Calltip(self)
  308. text.bind("<<try-open-calltip>>", ctip.try_open_calltip_event)
  309. #refresh-calltip must come after paren-closed to work right
  310. text.bind("<<refresh-calltip>>", ctip.refresh_calltip_event)
  311. text.bind("<<force-open-calltip>>", ctip.force_open_calltip_event)
  312. text.bind("<<zoom-height>>", self.ZoomHeight(self).zoom_height_event)
  313. if self.allow_code_context:
  314. self.code_context = self.CodeContext(self)
  315. text.bind("<<toggle-code-context>>",
  316. self.code_context.toggle_code_context_event)
  317. else:
  318. self.update_menu_state('options', '*ode*ontext', 'disabled')
  319. if self.allow_line_numbers:
  320. self.line_numbers = self.LineNumbers(self)
  321. if idleConf.GetOption('main', 'EditorWindow',
  322. 'line-numbers-default', type='bool'):
  323. self.toggle_line_numbers_event()
  324. text.bind("<<toggle-line-numbers>>", self.toggle_line_numbers_event)
  325. else:
  326. self.update_menu_state('options', '*ine*umbers', 'disabled')
  327. def handle_winconfig(self, event=None):
  328. self.set_width()
  329. def set_width(self):
  330. text = self.text
  331. inner_padding = sum(map(text.tk.getint, [text.cget('border'),
  332. text.cget('padx')]))
  333. pixel_width = text.winfo_width() - 2 * inner_padding
  334. # Divide the width of the Text widget by the font width,
  335. # which is taken to be the width of '0' (zero).
  336. # http://www.tcl.tk/man/tcl8.6/TkCmd/text.htm#M21
  337. zero_char_width = \
  338. Font(text, font=text.cget('font')).measure('0')
  339. self.width = pixel_width // zero_char_width
  340. def new_callback(self, event):
  341. dirname, basename = self.io.defaultfilename()
  342. self.flist.new(dirname)
  343. return "break"
  344. def home_callback(self, event):
  345. if (event.state & 4) != 0 and event.keysym == "Home":
  346. # state&4==Control. If <Control-Home>, use the Tk binding.
  347. return None
  348. if self.text.index("iomark") and \
  349. self.text.compare("iomark", "<=", "insert lineend") and \
  350. self.text.compare("insert linestart", "<=", "iomark"):
  351. # In Shell on input line, go to just after prompt
  352. insertpt = int(self.text.index("iomark").split(".")[1])
  353. else:
  354. line = self.text.get("insert linestart", "insert lineend")
  355. for insertpt in range(len(line)):
  356. if line[insertpt] not in (' ','\t'):
  357. break
  358. else:
  359. insertpt=len(line)
  360. lineat = int(self.text.index("insert").split('.')[1])
  361. if insertpt == lineat:
  362. insertpt = 0
  363. dest = "insert linestart+"+str(insertpt)+"c"
  364. if (event.state&1) == 0:
  365. # shift was not pressed
  366. self.text.tag_remove("sel", "1.0", "end")
  367. else:
  368. if not self.text.index("sel.first"):
  369. # there was no previous selection
  370. self.text.mark_set("my_anchor", "insert")
  371. else:
  372. if self.text.compare(self.text.index("sel.first"), "<",
  373. self.text.index("insert")):
  374. self.text.mark_set("my_anchor", "sel.first") # extend back
  375. else:
  376. self.text.mark_set("my_anchor", "sel.last") # extend forward
  377. first = self.text.index(dest)
  378. last = self.text.index("my_anchor")
  379. if self.text.compare(first,">",last):
  380. first,last = last,first
  381. self.text.tag_remove("sel", "1.0", "end")
  382. self.text.tag_add("sel", first, last)
  383. self.text.mark_set("insert", dest)
  384. self.text.see("insert")
  385. return "break"
  386. def set_status_bar(self):
  387. self.status_bar = self.MultiStatusBar(self.top)
  388. sep = Frame(self.top, height=1, borderwidth=1, background='grey75')
  389. if sys.platform == "darwin":
  390. # Insert some padding to avoid obscuring some of the statusbar
  391. # by the resize widget.
  392. self.status_bar.set_label('_padding1', ' ', side=RIGHT)
  393. self.status_bar.set_label('column', 'Col: ?', side=RIGHT)
  394. self.status_bar.set_label('line', 'Ln: ?', side=RIGHT)
  395. self.status_bar.pack(side=BOTTOM, fill=X)
  396. sep.pack(side=BOTTOM, fill=X)
  397. self.text.bind("<<set-line-and-column>>", self.set_line_and_column)
  398. self.text.event_add("<<set-line-and-column>>",
  399. "<KeyRelease>", "<ButtonRelease>")
  400. self.text.after_idle(self.set_line_and_column)
  401. def set_line_and_column(self, event=None):
  402. line, column = self.text.index(INSERT).split('.')
  403. self.status_bar.set_label('column', 'Col: %s' % column)
  404. self.status_bar.set_label('line', 'Ln: %s' % line)
  405. menu_specs = [
  406. ("file", "_File"),
  407. ("edit", "_Edit"),
  408. ("format", "F_ormat"),
  409. ("run", "_Run"),
  410. ("options", "_Options"),
  411. ("window", "_Window"),
  412. ("help", "_Help"),
  413. ]
  414. def createmenubar(self):
  415. mbar = self.menubar
  416. self.menudict = menudict = {}
  417. for name, label in self.menu_specs:
  418. underline, label = prepstr(label)
  419. postcommand = getattr(self, f'{name}_menu_postcommand', None)
  420. menudict[name] = menu = Menu(mbar, name=name, tearoff=0,
  421. postcommand=postcommand)
  422. mbar.add_cascade(label=label, menu=menu, underline=underline)
  423. if macosx.isCarbonTk():
  424. # Insert the application menu
  425. menudict['application'] = menu = Menu(mbar, name='apple',
  426. tearoff=0)
  427. mbar.add_cascade(label='IDLE', menu=menu)
  428. self.fill_menus()
  429. self.recent_files_menu = Menu(self.menubar, tearoff=0)
  430. self.menudict['file'].insert_cascade(3, label='Recent Files',
  431. underline=0,
  432. menu=self.recent_files_menu)
  433. self.base_helpmenu_length = self.menudict['help'].index(END)
  434. self.reset_help_menu_entries()
  435. def postwindowsmenu(self):
  436. # Only called when Window menu exists
  437. menu = self.menudict['window']
  438. end = menu.index("end")
  439. if end is None:
  440. end = -1
  441. if end > self.wmenu_end:
  442. menu.delete(self.wmenu_end+1, end)
  443. window.add_windows_to_menu(menu)
  444. def update_menu_label(self, menu, index, label):
  445. "Update label for menu item at index."
  446. menuitem = self.menudict[menu]
  447. menuitem.entryconfig(index, label=label)
  448. def update_menu_state(self, menu, index, state):
  449. "Update state for menu item at index."
  450. menuitem = self.menudict[menu]
  451. menuitem.entryconfig(index, state=state)
  452. def handle_yview(self, event, *args):
  453. "Handle scrollbar."
  454. if event == 'moveto':
  455. fraction = float(args[0])
  456. lines = (round(self.getlineno('end') * fraction) -
  457. self.getlineno('@0,0'))
  458. event = 'scroll'
  459. args = (lines, 'units')
  460. self.text.yview(event, *args)
  461. return 'break'
  462. rmenu = None
  463. def right_menu_event(self, event):
  464. text = self.text
  465. newdex = text.index(f'@{event.x},{event.y}')
  466. try:
  467. in_selection = (text.compare('sel.first', '<=', newdex) and
  468. text.compare(newdex, '<=', 'sel.last'))
  469. except TclError:
  470. in_selection = False
  471. if not in_selection:
  472. text.tag_remove("sel", "1.0", "end")
  473. text.mark_set("insert", newdex)
  474. if not self.rmenu:
  475. self.make_rmenu()
  476. rmenu = self.rmenu
  477. self.event = event
  478. iswin = sys.platform[:3] == 'win'
  479. if iswin:
  480. text.config(cursor="arrow")
  481. for item in self.rmenu_specs:
  482. try:
  483. label, eventname, verify_state = item
  484. except ValueError: # see issue1207589
  485. continue
  486. if verify_state is None:
  487. continue
  488. state = getattr(self, verify_state)()
  489. rmenu.entryconfigure(label, state=state)
  490. rmenu.tk_popup(event.x_root, event.y_root)
  491. if iswin:
  492. self.text.config(cursor="ibeam")
  493. return "break"
  494. rmenu_specs = [
  495. # ("Label", "<<virtual-event>>", "statefuncname"), ...
  496. ("Close", "<<close-window>>", None), # Example
  497. ]
  498. def make_rmenu(self):
  499. rmenu = Menu(self.text, tearoff=0)
  500. for item in self.rmenu_specs:
  501. label, eventname = item[0], item[1]
  502. if label is not None:
  503. def command(text=self.text, eventname=eventname):
  504. text.event_generate(eventname)
  505. rmenu.add_command(label=label, command=command)
  506. else:
  507. rmenu.add_separator()
  508. self.rmenu = rmenu
  509. def rmenu_check_cut(self):
  510. return self.rmenu_check_copy()
  511. def rmenu_check_copy(self):
  512. try:
  513. indx = self.text.index('sel.first')
  514. except TclError:
  515. return 'disabled'
  516. else:
  517. return 'normal' if indx else 'disabled'
  518. def rmenu_check_paste(self):
  519. try:
  520. self.text.tk.call('tk::GetSelection', self.text, 'CLIPBOARD')
  521. except TclError:
  522. return 'disabled'
  523. else:
  524. return 'normal'
  525. def about_dialog(self, event=None):
  526. "Handle Help 'About IDLE' event."
  527. # Synchronize with macosx.overrideRootMenu.about_dialog.
  528. help_about.AboutDialog(self.top)
  529. return "break"
  530. def config_dialog(self, event=None):
  531. "Handle Options 'Configure IDLE' event."
  532. # Synchronize with macosx.overrideRootMenu.config_dialog.
  533. configdialog.ConfigDialog(self.top,'Settings')
  534. return "break"
  535. def help_dialog(self, event=None):
  536. "Handle Help 'IDLE Help' event."
  537. # Synchronize with macosx.overrideRootMenu.help_dialog.
  538. if self.root:
  539. parent = self.root
  540. else:
  541. parent = self.top
  542. help.show_idlehelp(parent)
  543. return "break"
  544. def python_docs(self, event=None):
  545. if sys.platform[:3] == 'win':
  546. try:
  547. os.startfile(self.help_url)
  548. except OSError as why:
  549. messagebox.showerror(title='Document Start Failure',
  550. message=str(why), parent=self.text)
  551. else:
  552. webbrowser.open(self.help_url)
  553. return "break"
  554. def cut(self,event):
  555. self.text.event_generate("<<Cut>>")
  556. return "break"
  557. def copy(self,event):
  558. if not self.text.tag_ranges("sel"):
  559. # There is no selection, so do nothing and maybe interrupt.
  560. return None
  561. self.text.event_generate("<<Copy>>")
  562. return "break"
  563. def paste(self,event):
  564. self.text.event_generate("<<Paste>>")
  565. self.text.see("insert")
  566. return "break"
  567. def select_all(self, event=None):
  568. self.text.tag_add("sel", "1.0", "end-1c")
  569. self.text.mark_set("insert", "1.0")
  570. self.text.see("insert")
  571. return "break"
  572. def remove_selection(self, event=None):
  573. self.text.tag_remove("sel", "1.0", "end")
  574. self.text.see("insert")
  575. return "break"
  576. def move_at_edge_if_selection(self, edge_index):
  577. """Cursor move begins at start or end of selection
  578. When a left/right cursor key is pressed create and return to Tkinter a
  579. function which causes a cursor move from the associated edge of the
  580. selection.
  581. """
  582. self_text_index = self.text.index
  583. self_text_mark_set = self.text.mark_set
  584. edges_table = ("sel.first+1c", "sel.last-1c")
  585. def move_at_edge(event):
  586. if (event.state & 5) == 0: # no shift(==1) or control(==4) pressed
  587. try:
  588. self_text_index("sel.first")
  589. self_text_mark_set("insert", edges_table[edge_index])
  590. except TclError:
  591. pass
  592. return move_at_edge
  593. def del_word_left(self, event):
  594. self.text.event_generate('<Meta-Delete>')
  595. return "break"
  596. def del_word_right(self, event):
  597. self.text.event_generate('<Meta-d>')
  598. return "break"
  599. def find_event(self, event):
  600. search.find(self.text)
  601. return "break"
  602. def find_again_event(self, event):
  603. search.find_again(self.text)
  604. return "break"
  605. def find_selection_event(self, event):
  606. search.find_selection(self.text)
  607. return "break"
  608. def find_in_files_event(self, event):
  609. grep.grep(self.text, self.io, self.flist)
  610. return "break"
  611. def replace_event(self, event):
  612. replace.replace(self.text)
  613. return "break"
  614. def goto_line_event(self, event):
  615. text = self.text
  616. lineno = query.Goto(
  617. text, "Go To Line",
  618. "Enter a positive integer\n"
  619. "('big' = end of file):"
  620. ).result
  621. if lineno is not None:
  622. text.tag_remove("sel", "1.0", "end")
  623. text.mark_set("insert", f'{lineno}.0')
  624. text.see("insert")
  625. self.set_line_and_column()
  626. return "break"
  627. def open_module(self):
  628. """Get module name from user and open it.
  629. Return module path or None for calls by open_module_browser
  630. when latter is not invoked in named editor window.
  631. """
  632. # XXX This, open_module_browser, and open_path_browser
  633. # would fit better in iomenu.IOBinding.
  634. try:
  635. name = self.text.get("sel.first", "sel.last").strip()
  636. except TclError:
  637. name = ''
  638. file_path = query.ModuleName(
  639. self.text, "Open Module",
  640. "Enter the name of a Python module\n"
  641. "to search on sys.path and open:",
  642. name).result
  643. if file_path is not None:
  644. if self.flist:
  645. self.flist.open(file_path)
  646. else:
  647. self.io.loadfile(file_path)
  648. return file_path
  649. def open_module_event(self, event):
  650. self.open_module()
  651. return "break"
  652. def open_module_browser(self, event=None):
  653. filename = self.io.filename
  654. if not (self.__class__.__name__ == 'PyShellEditorWindow'
  655. and filename):
  656. filename = self.open_module()
  657. if filename is None:
  658. return "break"
  659. from idlelib import browser
  660. browser.ModuleBrowser(self.root, filename)
  661. return "break"
  662. def open_path_browser(self, event=None):
  663. from idlelib import pathbrowser
  664. pathbrowser.PathBrowser(self.root)
  665. return "break"
  666. def open_turtle_demo(self, event = None):
  667. import subprocess
  668. cmd = [sys.executable,
  669. '-c',
  670. 'from turtledemo.__main__ import main; main()']
  671. subprocess.Popen(cmd, shell=False)
  672. return "break"
  673. def gotoline(self, lineno):
  674. if lineno is not None and lineno > 0:
  675. self.text.mark_set("insert", "%d.0" % lineno)
  676. self.text.tag_remove("sel", "1.0", "end")
  677. self.text.tag_add("sel", "insert", "insert +1l")
  678. self.center()
  679. def ispythonsource(self, filename):
  680. if not filename or os.path.isdir(filename):
  681. return True
  682. base, ext = os.path.splitext(os.path.basename(filename))
  683. if os.path.normcase(ext) in py_extensions:
  684. return True
  685. line = self.text.get('1.0', '1.0 lineend')
  686. return line.startswith('#!') and 'python' in line
  687. def close_hook(self):
  688. if self.flist:
  689. self.flist.unregister_maybe_terminate(self)
  690. self.flist = None
  691. def set_close_hook(self, close_hook):
  692. self.close_hook = close_hook
  693. def filename_change_hook(self):
  694. if self.flist:
  695. self.flist.filename_changed_edit(self)
  696. self.saved_change_hook()
  697. self.top.update_windowlist_registry(self)
  698. self.ResetColorizer()
  699. def _addcolorizer(self):
  700. if self.color:
  701. return
  702. if self.ispythonsource(self.io.filename):
  703. self.color = self.ColorDelegator()
  704. # can add more colorizers here...
  705. if self.color:
  706. self.per.removefilter(self.undo)
  707. self.per.insertfilter(self.color)
  708. self.per.insertfilter(self.undo)
  709. def _rmcolorizer(self):
  710. if not self.color:
  711. return
  712. self.color.removecolors()
  713. self.per.removefilter(self.color)
  714. self.color = None
  715. def ResetColorizer(self):
  716. "Update the color theme"
  717. # Called from self.filename_change_hook and from configdialog.py
  718. self._rmcolorizer()
  719. self._addcolorizer()
  720. EditorWindow.color_config(self.text)
  721. if self.code_context is not None:
  722. self.code_context.update_highlight_colors()
  723. if self.line_numbers is not None:
  724. self.line_numbers.update_colors()
  725. IDENTCHARS = string.ascii_letters + string.digits + "_"
  726. def colorize_syntax_error(self, text, pos):
  727. text.tag_add("ERROR", pos)
  728. char = text.get(pos)
  729. if char and char in self.IDENTCHARS:
  730. text.tag_add("ERROR", pos + " wordstart", pos)
  731. if '\n' == text.get(pos): # error at line end
  732. text.mark_set("insert", pos)
  733. else:
  734. text.mark_set("insert", pos + "+1c")
  735. text.see(pos)
  736. def update_cursor_blink(self):
  737. "Update the cursor blink configuration."
  738. cursorblink = idleConf.GetOption(
  739. 'main', 'EditorWindow', 'cursor-blink', type='bool')
  740. if not cursorblink:
  741. self.text['insertofftime'] = 0
  742. else:
  743. # Restore the original value
  744. self.text['insertofftime'] = idleConf.blink_off_time
  745. def ResetFont(self):
  746. "Update the text widgets' font if it is changed"
  747. # Called from configdialog.py
  748. # Update the code context widget first, since its height affects
  749. # the height of the text widget. This avoids double re-rendering.
  750. if self.code_context is not None:
  751. self.code_context.update_font()
  752. # Next, update the line numbers widget, since its width affects
  753. # the width of the text widget.
  754. if self.line_numbers is not None:
  755. self.line_numbers.update_font()
  756. # Finally, update the main text widget.
  757. new_font = idleConf.GetFont(self.root, 'main', 'EditorWindow')
  758. self.text['font'] = new_font
  759. self.set_width()
  760. def RemoveKeybindings(self):
  761. "Remove the keybindings before they are changed."
  762. # Called from configdialog.py
  763. self.mainmenu.default_keydefs = keydefs = idleConf.GetCurrentKeySet()
  764. for event, keylist in keydefs.items():
  765. self.text.event_delete(event, *keylist)
  766. for extensionName in self.get_standard_extension_names():
  767. xkeydefs = idleConf.GetExtensionBindings(extensionName)
  768. if xkeydefs:
  769. for event, keylist in xkeydefs.items():
  770. self.text.event_delete(event, *keylist)
  771. def ApplyKeybindings(self):
  772. "Update the keybindings after they are changed"
  773. # Called from configdialog.py
  774. self.mainmenu.default_keydefs = keydefs = idleConf.GetCurrentKeySet()
  775. self.apply_bindings()
  776. for extensionName in self.get_standard_extension_names():
  777. xkeydefs = idleConf.GetExtensionBindings(extensionName)
  778. if xkeydefs:
  779. self.apply_bindings(xkeydefs)
  780. #update menu accelerators
  781. menuEventDict = {}
  782. for menu in self.mainmenu.menudefs:
  783. menuEventDict[menu[0]] = {}
  784. for item in menu[1]:
  785. if item:
  786. menuEventDict[menu[0]][prepstr(item[0])[1]] = item[1]
  787. for menubarItem in self.menudict:
  788. menu = self.menudict[menubarItem]
  789. end = menu.index(END)
  790. if end is None:
  791. # Skip empty menus
  792. continue
  793. end += 1
  794. for index in range(0, end):
  795. if menu.type(index) == 'command':
  796. accel = menu.entrycget(index, 'accelerator')
  797. if accel:
  798. itemName = menu.entrycget(index, 'label')
  799. event = ''
  800. if menubarItem in menuEventDict:
  801. if itemName in menuEventDict[menubarItem]:
  802. event = menuEventDict[menubarItem][itemName]
  803. if event:
  804. accel = get_accelerator(keydefs, event)
  805. menu.entryconfig(index, accelerator=accel)
  806. def set_notabs_indentwidth(self):
  807. "Update the indentwidth if changed and not using tabs in this window"
  808. # Called from configdialog.py
  809. if not self.usetabs:
  810. self.indentwidth = idleConf.GetOption('main', 'Indent','num-spaces',
  811. type='int')
  812. def reset_help_menu_entries(self):
  813. "Update the additional help entries on the Help menu"
  814. help_list = idleConf.GetAllExtraHelpSourcesList()
  815. helpmenu = self.menudict['help']
  816. # first delete the extra help entries, if any
  817. helpmenu_length = helpmenu.index(END)
  818. if helpmenu_length > self.base_helpmenu_length:
  819. helpmenu.delete((self.base_helpmenu_length + 1), helpmenu_length)
  820. # then rebuild them
  821. if help_list:
  822. helpmenu.add_separator()
  823. for entry in help_list:
  824. cmd = self.__extra_help_callback(entry[1])
  825. helpmenu.add_command(label=entry[0], command=cmd)
  826. # and update the menu dictionary
  827. self.menudict['help'] = helpmenu
  828. def __extra_help_callback(self, helpfile):
  829. "Create a callback with the helpfile value frozen at definition time"
  830. def display_extra_help(helpfile=helpfile):
  831. if not helpfile.startswith(('www', 'http')):
  832. helpfile = os.path.normpath(helpfile)
  833. if sys.platform[:3] == 'win':
  834. try:
  835. os.startfile(helpfile)
  836. except OSError as why:
  837. messagebox.showerror(title='Document Start Failure',
  838. message=str(why), parent=self.text)
  839. else:
  840. webbrowser.open(helpfile)
  841. return display_extra_help
  842. def update_recent_files_list(self, new_file=None):
  843. "Load and update the recent files list and menus"
  844. # TODO: move to iomenu.
  845. rf_list = []
  846. file_path = self.recent_files_path
  847. if file_path and os.path.exists(file_path):
  848. with open(file_path, 'r',
  849. encoding='utf_8', errors='replace') as rf_list_file:
  850. rf_list = rf_list_file.readlines()
  851. if new_file:
  852. new_file = os.path.abspath(new_file) + '\n'
  853. if new_file in rf_list:
  854. rf_list.remove(new_file) # move to top
  855. rf_list.insert(0, new_file)
  856. # clean and save the recent files list
  857. bad_paths = []
  858. for path in rf_list:
  859. if '\0' in path or not os.path.exists(path[0:-1]):
  860. bad_paths.append(path)
  861. rf_list = [path for path in rf_list if path not in bad_paths]
  862. ulchars = "1234567890ABCDEFGHIJK"
  863. rf_list = rf_list[0:len(ulchars)]
  864. if file_path:
  865. try:
  866. with open(file_path, 'w',
  867. encoding='utf_8', errors='replace') as rf_file:
  868. rf_file.writelines(rf_list)
  869. except OSError as err:
  870. if not getattr(self.root, "recentfiles_message", False):
  871. self.root.recentfiles_message = True
  872. messagebox.showwarning(title='IDLE Warning',
  873. message="Cannot save Recent Files list to disk.\n"
  874. f" {err}\n"
  875. "Select OK to continue.",
  876. parent=self.text)
  877. # for each edit window instance, construct the recent files menu
  878. for instance in self.top.instance_dict:
  879. menu = instance.recent_files_menu
  880. menu.delete(0, END) # clear, and rebuild:
  881. for i, file_name in enumerate(rf_list):
  882. file_name = file_name.rstrip() # zap \n
  883. callback = instance.__recent_file_callback(file_name)
  884. menu.add_command(label=ulchars[i] + " " + file_name,
  885. command=callback,
  886. underline=0)
  887. def __recent_file_callback(self, file_name):
  888. def open_recent_file(fn_closure=file_name):
  889. self.io.open(editFile=fn_closure)
  890. return open_recent_file
  891. def saved_change_hook(self):
  892. short = self.short_title()
  893. long = self.long_title()
  894. if short and long:
  895. title = short + " - " + long + _py_version
  896. elif short:
  897. title = short
  898. elif long:
  899. title = long
  900. else:
  901. title = "untitled"
  902. icon = short or long or title
  903. if not self.get_saved():
  904. title = "*%s*" % title
  905. icon = "*%s" % icon
  906. self.top.wm_title(title)
  907. self.top.wm_iconname(icon)
  908. def get_saved(self):
  909. return self.undo.get_saved()
  910. def set_saved(self, flag):
  911. self.undo.set_saved(flag)
  912. def reset_undo(self):
  913. self.undo.reset_undo()
  914. def short_title(self):
  915. filename = self.io.filename
  916. return os.path.basename(filename) if filename else "untitled"
  917. def long_title(self):
  918. return self.io.filename or ""
  919. def center_insert_event(self, event):
  920. self.center()
  921. return "break"
  922. def center(self, mark="insert"):
  923. text = self.text
  924. top, bot = self.getwindowlines()
  925. lineno = self.getlineno(mark)
  926. height = bot - top
  927. newtop = max(1, lineno - height//2)
  928. text.yview(float(newtop))
  929. def getwindowlines(self):
  930. text = self.text
  931. top = self.getlineno("@0,0")
  932. bot = self.getlineno("@0,65535")
  933. if top == bot and text.winfo_height() == 1:
  934. # Geometry manager hasn't run yet
  935. height = int(text['height'])
  936. bot = top + height - 1
  937. return top, bot
  938. def getlineno(self, mark="insert"):
  939. text = self.text
  940. return int(float(text.index(mark)))
  941. def get_geometry(self):
  942. "Return (width, height, x, y)"
  943. geom = self.top.wm_geometry()
  944. m = re.match(r"(\d+)x(\d+)\+(-?\d+)\+(-?\d+)", geom)
  945. return list(map(int, m.groups()))
  946. def close_event(self, event):
  947. self.close()
  948. return "break"
  949. def maybesave(self):
  950. if self.io:
  951. if not self.get_saved():
  952. if self.top.state()!='normal':
  953. self.top.deiconify()
  954. self.top.lower()
  955. self.top.lift()
  956. return self.io.maybesave()
  957. def close(self):
  958. try:
  959. reply = self.maybesave()
  960. if str(reply) != "cancel":
  961. self._close()
  962. return reply
  963. except AttributeError: # bpo-35379: close called twice
  964. pass
  965. def _close(self):
  966. if self.io.filename:
  967. self.update_recent_files_list(new_file=self.io.filename)
  968. window.unregister_callback(self.postwindowsmenu)
  969. self.unload_extensions()
  970. self.io.close()
  971. self.io = None
  972. self.undo = None
  973. if self.color:
  974. self.color.close()
  975. self.color = None
  976. self.text = None
  977. self.tkinter_vars = None
  978. self.per.close()
  979. self.per = None
  980. self.top.destroy()
  981. if self.close_hook:
  982. # unless override: unregister from flist, terminate if last window
  983. self.close_hook()
  984. def load_extensions(self):
  985. self.extensions = {}
  986. self.load_standard_extensions()
  987. def unload_extensions(self):
  988. for ins in list(self.extensions.values()):
  989. if hasattr(ins, "close"):
  990. ins.close()
  991. self.extensions = {}
  992. def load_standard_extensions(self):
  993. for name in self.get_standard_extension_names():
  994. try:
  995. self.load_extension(name)
  996. except:
  997. print("Failed to load extension", repr(name))
  998. traceback.print_exc()
  999. def get_standard_extension_names(self):
  1000. return idleConf.GetExtensions(editor_only=True)
  1001. extfiles = { # Map built-in config-extension section names to file names.
  1002. 'ZzDummy': 'zzdummy',
  1003. }
  1004. def load_extension(self, name):
  1005. fname = self.extfiles.get(name, name)
  1006. try:
  1007. try:
  1008. mod = importlib.import_module('.' + fname, package=__package__)
  1009. except (ImportError, TypeError):
  1010. mod = importlib.import_module(fname)
  1011. except ImportError:
  1012. print("\nFailed to import extension: ", name)
  1013. raise
  1014. cls = getattr(mod, name)
  1015. keydefs = idleConf.GetExtensionBindings(name)
  1016. if hasattr(cls, "menudefs"):
  1017. self.fill_menus(cls.menudefs, keydefs)
  1018. ins = cls(self)
  1019. self.extensions[name] = ins
  1020. if keydefs:
  1021. self.apply_bindings(keydefs)
  1022. for vevent in keydefs:
  1023. methodname = vevent.replace("-", "_")
  1024. while methodname[:1] == '<':
  1025. methodname = methodname[1:]
  1026. while methodname[-1:] == '>':
  1027. methodname = methodname[:-1]
  1028. methodname = methodname + "_event"
  1029. if hasattr(ins, methodname):
  1030. self.text.bind(vevent, getattr(ins, methodname))
  1031. def apply_bindings(self, keydefs=None):
  1032. if keydefs is None:
  1033. keydefs = self.mainmenu.default_keydefs
  1034. text = self.text
  1035. text.keydefs = keydefs
  1036. for event, keylist in keydefs.items():
  1037. if keylist:
  1038. text.event_add(event, *keylist)
  1039. def fill_menus(self, menudefs=None, keydefs=None):
  1040. """Add appropriate entries to the menus and submenus
  1041. Menus that are absent or None in self.menudict are ignored.
  1042. """
  1043. if menudefs is None:
  1044. menudefs = self.mainmenu.menudefs
  1045. if keydefs is None:
  1046. keydefs = self.mainmenu.default_keydefs
  1047. menudict = self.menudict
  1048. text = self.text
  1049. for mname, entrylist in menudefs:
  1050. menu = menudict.get(mname)
  1051. if not menu:
  1052. continue
  1053. for entry in entrylist:
  1054. if not entry:
  1055. menu.add_separator()
  1056. else:
  1057. label, eventname = entry
  1058. checkbutton = (label[:1] == '!')
  1059. if checkbutton:
  1060. label = label[1:]
  1061. underline, label = prepstr(label)
  1062. accelerator = get_accelerator(keydefs, eventname)
  1063. def command(text=text, eventname=eventname):
  1064. text.event_generate(eventname)
  1065. if checkbutton:
  1066. var = self.get_var_obj(eventname, BooleanVar)
  1067. menu.add_checkbutton(label=label, underline=underline,
  1068. command=command, accelerator=accelerator,
  1069. variable=var)
  1070. else:
  1071. menu.add_command(label=label, underline=underline,
  1072. command=command,
  1073. accelerator=accelerator)
  1074. def getvar(self, name):
  1075. var = self.get_var_obj(name)
  1076. if var:
  1077. value = var.get()
  1078. return value
  1079. else:
  1080. raise NameError(name)
  1081. def setvar(self, name, value, vartype=None):
  1082. var = self.get_var_obj(name, vartype)
  1083. if var:
  1084. var.set(value)
  1085. else:
  1086. raise NameError(name)
  1087. def get_var_obj(self, name, vartype=None):
  1088. var = self.tkinter_vars.get(name)
  1089. if not var and vartype:
  1090. # create a Tkinter variable object with self.text as master:
  1091. self.tkinter_vars[name] = var = vartype(self.text)
  1092. return var
  1093. # Tk implementations of "virtual text methods" -- each platform
  1094. # reusing IDLE's support code needs to define these for its GUI's
  1095. # flavor of widget.
  1096. # Is character at text_index in a Python string? Return 0 for
  1097. # "guaranteed no", true for anything else. This info is expensive
  1098. # to compute ab initio, but is probably already known by the
  1099. # platform's colorizer.
  1100. def is_char_in_string(self, text_index):
  1101. if self.color:
  1102. # Return true iff colorizer hasn't (re)gotten this far
  1103. # yet, or the character is tagged as being in a string
  1104. return self.text.tag_prevrange("TODO", text_index) or \
  1105. "STRING" in self.text.tag_names(text_index)
  1106. else:
  1107. # The colorizer is missing: assume the worst
  1108. return 1
  1109. # If a selection is defined in the text widget, return (start,
  1110. # end) as Tkinter text indices, otherwise return (None, None)
  1111. def get_selection_indices(self):
  1112. try:
  1113. first = self.text.index("sel.first")
  1114. last = self.text.index("sel.last")
  1115. return first, last
  1116. except TclError:
  1117. return None, None
  1118. # Return the text widget's current view of what a tab stop means
  1119. # (equivalent width in spaces).
  1120. def get_tk_tabwidth(self):
  1121. current = self.text['tabs'] or TK_TABWIDTH_DEFAULT
  1122. return int(current)
  1123. # Set the text widget's current view of what a tab stop means.
  1124. def set_tk_tabwidth(self, newtabwidth):
  1125. text = self.text
  1126. if self.get_tk_tabwidth() != newtabwidth:
  1127. # Set text widget tab width
  1128. pixels = text.tk.call("font", "measure", text["font"],
  1129. "-displayof", text.master,
  1130. "n" * newtabwidth)
  1131. text.configure(tabs=pixels)
  1132. ### begin autoindent code ### (configuration was moved to beginning of class)
  1133. def set_indentation_params(self, is_py_src, guess=True):
  1134. if is_py_src and guess:
  1135. i = self.guess_indent()
  1136. if 2 <= i <= 8:
  1137. self.indentwidth = i
  1138. if self.indentwidth != self.tabwidth:
  1139. self.usetabs = False
  1140. self.set_tk_tabwidth(self.tabwidth)
  1141. def smart_backspace_event(self, event):
  1142. text = self.text
  1143. first, last = self.get_selection_indices()
  1144. if first and last:
  1145. text.delete(first, last)
  1146. text.mark_set("insert", first)
  1147. return "break"
  1148. # Delete whitespace left, until hitting a real char or closest
  1149. # preceding virtual tab stop.
  1150. chars = text.get("insert linestart", "insert")
  1151. if chars == '':
  1152. if text.compare("insert", ">", "1.0"):
  1153. # easy: delete preceding newline
  1154. text.delete("insert-1c")
  1155. else:
  1156. text.bell() # at start of buffer
  1157. return "break"
  1158. if chars[-1] not in " \t":
  1159. # easy: delete preceding real char
  1160. text.delete("insert-1c")
  1161. return "break"
  1162. # Ick. It may require *inserting* spaces if we back up over a
  1163. # tab character! This is written to be clear, not fast.
  1164. tabwidth = self.tabwidth
  1165. have = len(chars.expandtabs(tabwidth))
  1166. assert have > 0
  1167. want = ((have - 1) // self.indentwidth) * self.indentwidth
  1168. # Debug prompt is multilined....
  1169. ncharsdeleted = 0
  1170. while 1:
  1171. if chars == self.prompt_last_line: # '' unless PyShell
  1172. break
  1173. chars = chars[:-1]
  1174. ncharsdeleted = ncharsdeleted + 1
  1175. have = len(chars.expandtabs(tabwidth))
  1176. if have <= want or chars[-1] not in " \t":
  1177. break
  1178. text.undo_block_start()
  1179. text.delete("insert-%dc" % ncharsdeleted, "insert")
  1180. if have < want:
  1181. text.insert("insert", ' ' * (want - have))
  1182. text.undo_block_stop()
  1183. return "break"
  1184. def smart_indent_event(self, event):
  1185. # if intraline selection:
  1186. # delete it
  1187. # elif multiline selection:
  1188. # do indent-region
  1189. # else:
  1190. # indent one level
  1191. text = self.text
  1192. first, last = self.get_selection_indices()
  1193. text.undo_block_start()
  1194. try:
  1195. if first and last:
  1196. if index2line(first) != index2line(last):
  1197. return self.fregion.indent_region_event(event)
  1198. text.delete(first, last)
  1199. text.mark_set("insert", first)
  1200. prefix = text.get("insert linestart", "insert")
  1201. raw, effective = get_line_indent(prefix, self.tabwidth)
  1202. if raw == len(prefix):
  1203. # only whitespace to the left
  1204. self.reindent_to(effective + self.indentwidth)
  1205. else:
  1206. # tab to the next 'stop' within or to right of line's text:
  1207. if self.usetabs:
  1208. pad = '\t'
  1209. else:
  1210. effective = len(prefix.expandtabs(self.tabwidth))
  1211. n = self.indentwidth
  1212. pad = ' ' * (n - effective % n)
  1213. text.insert("insert", pad)
  1214. text.see("insert")
  1215. return "break"
  1216. finally:
  1217. text.undo_block_stop()
  1218. def newline_and_indent_event(self, event):
  1219. """Insert a newline and indentation after Enter keypress event.
  1220. Properly position the cursor on the new line based on information
  1221. from the current line. This takes into account if the current line
  1222. is a shell prompt, is empty, has selected text, contains a block
  1223. opener, contains a block closer, is a continuation line, or
  1224. is inside a string.
  1225. """
  1226. text = self.text
  1227. first, last = self.get_selection_indices()
  1228. text.undo_block_start()
  1229. try: # Close undo block and expose new line in finally clause.
  1230. if first and last:
  1231. text.delete(first, last)
  1232. text.mark_set("insert", first)
  1233. line = text.get("insert linestart", "insert")
  1234. # Count leading whitespace for indent size.
  1235. i, n = 0, len(line)
  1236. while i < n and line[i] in " \t":
  1237. i += 1
  1238. if i == n:
  1239. # The cursor is in or at leading indentation in a continuation
  1240. # line; just inject an empty line at the start.
  1241. text.insert("insert linestart", '\n')
  1242. return "break"
  1243. indent = line[:i]
  1244. # Strip whitespace before insert point unless it's in the prompt.
  1245. i = 0
  1246. while line and line[-1] in " \t" and line != self.prompt_last_line:
  1247. line = line[:-1]
  1248. i += 1
  1249. if i:
  1250. text.delete("insert - %d chars" % i, "insert")
  1251. # Strip whitespace after insert point.
  1252. while text.get("insert") in " \t":
  1253. text.delete("insert")
  1254. # Insert new line.
  1255. text.insert("insert", '\n')
  1256. # Adjust indentation for continuations and block open/close.
  1257. # First need to find the last statement.
  1258. lno = index2line(text.index('insert'))
  1259. y = pyparse.Parser(self.indentwidth, self.tabwidth)
  1260. if not self.prompt_last_line:
  1261. for context in self.num_context_lines:
  1262. startat = max(lno - context, 1)
  1263. startatindex = repr(startat) + ".0"
  1264. rawtext = text.get(startatindex, "insert")
  1265. y.set_code(rawtext)
  1266. bod = y.find_good_parse_start(
  1267. self._build_char_in_string_func(startatindex))
  1268. if bod is not None or startat == 1:
  1269. break
  1270. y.set_lo(bod or 0)
  1271. else:
  1272. r = text.tag_prevrange("console", "insert")
  1273. if r:
  1274. startatindex = r[1]
  1275. else:
  1276. startatindex = "1.0"
  1277. rawtext = text.get(startatindex, "insert")
  1278. y.set_code(rawtext)
  1279. y.set_lo(0)
  1280. c = y.get_continuation_type()
  1281. if c != pyparse.C_NONE:
  1282. # The current statement hasn't ended yet.
  1283. if c == pyparse.C_STRING_FIRST_LINE:
  1284. # After the first line of a string do not indent at all.
  1285. pass
  1286. elif c == pyparse.C_STRING_NEXT_LINES:
  1287. # Inside a string which started before this line;
  1288. # just mimic the current indent.
  1289. text.insert("insert", indent)
  1290. elif c == pyparse.C_BRACKET:
  1291. # Line up with the first (if any) element of the
  1292. # last open bracket structure; else indent one
  1293. # level beyond the indent of the line with the
  1294. # last open bracket.
  1295. self.reindent_to(y.compute_bracket_indent())
  1296. elif c == pyparse.C_BACKSLASH:
  1297. # If more than one line in this statement already, just
  1298. # mimic the current indent; else if initial line
  1299. # has a start on an assignment stmt, indent to
  1300. # beyond leftmost =; else to beyond first chunk of
  1301. # non-whitespace on initial line.
  1302. if y.get_num_lines_in_stmt() > 1:
  1303. text.insert("insert", indent)
  1304. else:
  1305. self.reindent_to(y.compute_backslash_indent())
  1306. else:
  1307. assert 0, "bogus continuation type %r" % (c,)
  1308. return "break"
  1309. # This line starts a brand new statement; indent relative to
  1310. # indentation of initial line of closest preceding
  1311. # interesting statement.
  1312. indent = y.get_base_indent_string()
  1313. text.insert("insert", indent)
  1314. if y.is_block_opener():
  1315. self.smart_indent_event(event)
  1316. elif indent and y.is_block_closer():
  1317. self.smart_backspace_event(event)
  1318. return "break"
  1319. finally:
  1320. text.see("insert")
  1321. text.undo_block_stop()
  1322. # Our editwin provides an is_char_in_string function that works
  1323. # with a Tk text index, but PyParse only knows about offsets into
  1324. # a string. This builds a function for PyParse that accepts an
  1325. # offset.
  1326. def _build_char_in_string_func(self, startindex):
  1327. def inner(offset, _startindex=startindex,
  1328. _icis=self.is_char_in_string):
  1329. return _icis(_startindex + "+%dc" % offset)
  1330. return inner
  1331. # XXX this isn't bound to anything -- see tabwidth comments
  1332. ## def change_tabwidth_event(self, event):
  1333. ## new = self._asktabwidth()
  1334. ## if new != self.tabwidth:
  1335. ## self.tabwidth = new
  1336. ## self.set_indentation_params(0, guess=0)
  1337. ## return "break"
  1338. # Make string that displays as n leading blanks.
  1339. def _make_blanks(self, n):
  1340. if self.usetabs:
  1341. ntabs, nspaces = divmod(n, self.tabwidth)
  1342. return '\t' * ntabs + ' ' * nspaces
  1343. else:
  1344. return ' ' * n
  1345. # Delete from beginning of line to insert point, then reinsert
  1346. # column logical (meaning use tabs if appropriate) spaces.
  1347. def reindent_to(self, column):
  1348. text = self.text
  1349. text.undo_block_start()
  1350. if text.compare("insert linestart", "!=", "insert"):
  1351. text.delete("insert linestart", "insert")
  1352. if column:
  1353. text.insert("insert", self._make_blanks(column))
  1354. text.undo_block_stop()
  1355. # Guess indentwidth from text content.
  1356. # Return guessed indentwidth. This should not be believed unless
  1357. # it's in a reasonable range (e.g., it will be 0 if no indented
  1358. # blocks are found).
  1359. def guess_indent(self):
  1360. opener, indented = IndentSearcher(self.text, self.tabwidth).run()
  1361. if opener and indented:
  1362. raw, indentsmall = get_line_indent(opener, self.tabwidth)
  1363. raw, indentlarge = get_line_indent(indented, self.tabwidth)
  1364. else:
  1365. indentsmall = indentlarge = 0
  1366. return indentlarge - indentsmall
  1367. def toggle_line_numbers_event(self, event=None):
  1368. if self.line_numbers is None:
  1369. return
  1370. if self.line_numbers.is_shown:
  1371. self.line_numbers.hide_sidebar()
  1372. menu_label = "Show"
  1373. else:
  1374. self.line_numbers.show_sidebar()
  1375. menu_label = "Hide"
  1376. self.update_menu_label(menu='options', index='*ine*umbers',
  1377. label=f'{menu_label} Line Numbers')
  1378. # "line.col" -> line, as an int
  1379. def index2line(index):
  1380. return int(float(index))
  1381. _line_indent_re = re.compile(r'[ \t]*')
  1382. def get_line_indent(line, tabwidth):
  1383. """Return a line's indentation as (# chars, effective # of spaces).
  1384. The effective # of spaces is the length after properly "expanding"
  1385. the tabs into spaces, as done by str.expandtabs(tabwidth).
  1386. """
  1387. m = _line_indent_re.match(line)
  1388. return m.end(), len(m.group().expandtabs(tabwidth))
  1389. class IndentSearcher:
  1390. # .run() chews over the Text widget, looking for a block opener
  1391. # and the stmt following it. Returns a pair,
  1392. # (line containing block opener, line containing stmt)
  1393. # Either or both may be None.
  1394. def __init__(self, text, tabwidth):
  1395. self.text = text
  1396. self.tabwidth = tabwidth
  1397. self.i = self.finished = 0
  1398. self.blkopenline = self.indentedline = None
  1399. def readline(self):
  1400. if self.finished:
  1401. return ""
  1402. i = self.i = self.i + 1
  1403. mark = repr(i) + ".0"
  1404. if self.text.compare(mark, ">=", "end"):
  1405. return ""
  1406. return self.text.get(mark, mark + " lineend+1c")
  1407. def tokeneater(self, type, token, start, end, line,
  1408. INDENT=tokenize.INDENT,
  1409. NAME=tokenize.NAME,
  1410. OPENERS=('class', 'def', 'for', 'if', 'try', 'while')):
  1411. if self.finished:
  1412. pass
  1413. elif type == NAME and token in OPENERS:
  1414. self.blkopenline = line
  1415. elif type == INDENT and self.blkopenline:
  1416. self.indentedline = line
  1417. self.finished = 1
  1418. def run(self):
  1419. save_tabsize = tokenize.tabsize
  1420. tokenize.tabsize = self.tabwidth
  1421. try:
  1422. try:
  1423. tokens = tokenize.generate_tokens(self.readline)
  1424. for token in tokens:
  1425. self.tokeneater(*token)
  1426. except (tokenize.TokenError, SyntaxError):
  1427. # since we cut off the tokenizer early, we can trigger
  1428. # spurious errors
  1429. pass
  1430. finally:
  1431. tokenize.tabsize = save_tabsize
  1432. return self.blkopenline, self.indentedline
  1433. ### end autoindent code ###
  1434. def prepstr(s):
  1435. # Helper to extract the underscore from a string, e.g.
  1436. # prepstr("Co_py") returns (2, "Copy").
  1437. i = s.find('_')
  1438. if i >= 0:
  1439. s = s[:i] + s[i+1:]
  1440. return i, s
  1441. keynames = {
  1442. 'bracketleft': '[',
  1443. 'bracketright': ']',
  1444. 'slash': '/',
  1445. }
  1446. def get_accelerator(keydefs, eventname):
  1447. keylist = keydefs.get(eventname)
  1448. # issue10940: temporary workaround to prevent hang with OS X Cocoa Tk 8.5
  1449. # if not keylist:
  1450. if (not keylist) or (macosx.isCocoaTk() and eventname in {
  1451. "<<open-module>>",
  1452. "<<goto-line>>",
  1453. "<<change-indentwidth>>"}):
  1454. return ""
  1455. s = keylist[0]
  1456. s = re.sub(r"-[a-z]\b", lambda m: m.group().upper(), s)
  1457. s = re.sub(r"\b\w+\b", lambda m: keynames.get(m.group(), m.group()), s)
  1458. s = re.sub("Key-", "", s)
  1459. s = re.sub("Cancel","Ctrl-Break",s) # dscherer@cmu.edu
  1460. s = re.sub("Control-", "Ctrl-", s)
  1461. s = re.sub("-", "+", s)
  1462. s = re.sub("><", " ", s)
  1463. s = re.sub("<", "", s)
  1464. s = re.sub(">", "", s)
  1465. return s
  1466. def fixwordbreaks(root):
  1467. # On Windows, tcl/tk breaks 'words' only on spaces, as in Command Prompt.
  1468. # We want Motif style everywhere. See #21474, msg218992 and followup.
  1469. tk = root.tk
  1470. tk.call('tcl_wordBreakAfter', 'a b', 0) # make sure word.tcl is loaded
  1471. tk.call('set', 'tcl_wordchars', r'\w')
  1472. tk.call('set', 'tcl_nonwordchars', r'\W')
  1473. def _editor_window(parent): # htest #
  1474. # error if close master window first - timer event, after script
  1475. root = parent
  1476. fixwordbreaks(root)
  1477. if sys.argv[1:]:
  1478. filename = sys.argv[1]
  1479. else:
  1480. filename = None
  1481. macosx.setupApp(root, None)
  1482. edit = EditorWindow(root=root, filename=filename)
  1483. text = edit.text
  1484. text['height'] = 10
  1485. for i in range(20):
  1486. text.insert('insert', ' '*i + str(i) + '\n')
  1487. # text.bind("<<close-all-windows>>", edit.close_event)
  1488. # Does not stop error, neither does following
  1489. # edit.text.bind("<<close-window>>", edit.close_event)
  1490. if __name__ == '__main__':
  1491. from unittest import main
  1492. main('idlelib.idle_test.test_editor', verbosity=2, exit=False)
  1493. from idlelib.idle_test.htest import run
  1494. run(_editor_window)