JejdZddlZddlmZddlmZmZddlm Z m Z m Z m Z m Z ddlmZddlmZddZdZGd d e ZGd d eZGd deZGddeZddZy)a This module contains utility functions/classes for Spyder's Editor. Adapted from pyqode/core/api/utils.py of the `PyQode project `_. Original file: N)QTimerQt)QColorQTextBlockUserData QTextCursor QTextBlock QTextDocument)to_text_string)encodingct|}|jdkDr|j|S|tdk(rttd|dzS|j |dzS)a1 Return color that is lighter or darker than the base color. If base_color.lightness is higher than 128, the returned color is darker otherwise is is lighter. :param base_color: The base color to drift from ;:param factor: drift factor (%) :return A lighter or darker color. z#000000z#101010 )r lightnessdarker drift_colorlighter) base_colorfactors D/usr/lib/python3/dist-packages/spyder/plugins/editor/utils/editor.pyrr!sh #J#  ((  * *vi0&2+> >%%frk2 2cb|jxrt|jtS)a4 Check if the block is safe to work with. A BlockUserData must have been set on the block while it was known to be safe. If an editor is cleared by editor.clear() or editor.set_text() for example, all old blocks will continue to report block.isValid() == True, but will raise a segmentation fault on almost all methods. One way to check if a block is valid is that the userData is reset to None or QTextBlockUserData. So if a block is known to have setUserData to BlockUserData, this fact can be used to check the block. )isValid isinstanceuserData BlockUserData)blocks r is_block_safer6s# ==? Jz%..*:MJJrceZdZ ddZdZy)rNctj|||_d|_d|_g|_g|_d|_||_d|_ d|_ ||_ ||_ y)NF) r__init__editor breakpointbreakpoint_condition bookmarks code_analysistodocoloroedataimport_statementselection_start selection_end)selfr#r)r,r-s rr"zBlockUserData.__init__Isb##D) $(!   $.*rc6|j |jy|jj}|jj }|j |jd}|j |j|jtj|jtj|jd|j |jd}|j |jtj|jtjtj|jtj|jdtjt|S)zt Function to compute the selection. This is slow to call so it is only called when needed. Nline character)n)mode)r2r3) r,r-r#document textCursorfindBlockByNumber setPositionposition movePositionr StartOfBlock NextCharacter KeepAnchor)r.r4cursorrblock2s r _selectionzBlockUserData._selectionXsO    '4+=+=+E;;'')'')**4+?+?+GH5>>+,K445  % %)=)=k)J  L++   v &(6??,k.D.DE  $ $;+A+A  C  % %););K)H''  )6""r)NNN)__name__ __module__ __qualname__r"r?rrrrHs;?# +#rrc*eZdZdZddZdZdZdZy)DelayJobRunneraY Utility class for running job after a certain delay. If a new request is made during this delay, the previous request is dropped and the timer is restarted for the new request. We use this to implement a cooldown effect that prevents jobs from being executed while the IDE is not idle. A job is a simple callable. ct|_||_|jjj |j g|_i|_d|_y)z :param delay: Delay to wait before running the job. This delay applies to all requests and cannot be changed afterwards. cyNrC)xs rz)DelayJobRunner.__init__..srN) r_timerdelaytimeoutconnect_exec_requested_job_args_kwargs_job)r.rLs rr"zDelayJobRunner.__init__}sG h   ##D$<$<=  " rc|j||_||_||_|jj |j y)a] Request a job execution. The job will be executed after the delay specified in the DelayJobRunner contructor elapsed if no other job is requested until then. :param job: job. :type job: callable :param args: job's position arguments :param kwargs: job's keyworded arguments N)cancel_requestsrRrPrQrKstartrL)r.jobargskwargss r request_jobzDelayJobRunner.request_jobs;     $**%rcb|jjd|_d|_d|_y)zCancels pending requests.N)rKstoprRrPrQr.s rrTzDelayJobRunner.cancel_requestss'    rc|jj |j|ji|jy#t $rYywxYw)z6Execute the requested job after the timer has timeout.N)rKr[rRrPrQKeyErrorr\s rrOz"DelayJobRunner._exec_requested_jobsF   DIItzz 2T\\ 2   s&A AAN)i)r@rArB__doc__r"rYrTrOrCrrrErErs  #&& rrEceZdZdZedZdZddZdZdZ ddZ d Z d Z d Z d Zd ZdZdZdZdZdZdZddZdZdZdZddZdZddZy) TextHelperz Text helper helps you manipulate the content of CodeEditor and extends the Qt text api for an easier usage. FIXME: Some of this methods are already implemented in CodeEditor, move and unify redundant methods. cZ |jS#t$r|jcYSwxYwrH) _editor_ref TypeErrorr\s r_editorzTextHelper._editors1 $##% % $## # $s **cf tj||_y#t$r ||_YywxYw)z%:param editor: The editor to work on.N)weakrefrefrcrd)r.r#s rr"zTextHelper.__init__s/ &&{{62D  &%D  &s 00ct||j}|j|}|r'|j|j|j ||r'|j|j|j ||r|j}|j||jj||jjr|jjn9|jjj|jj|rNt!|t!|j#vr*|jj%|t&j(|S)a Moves the text cursor to the specified position. :param line: Number of the line to go to (0 based) :param column: Optional column number. Default is 0 (start of line). :param move: True to move the cursor. False will return the cursor without setting it on the editor. :param word: Highlight the word, when moving to the line. :return: The new text cursor :rtype: QtGui.QTextCursor )min line_count_move_cursor_tor9Right MoveAnchorr<runfold_if_colapsedre setTextCursor isVisible centerCursorfocus_inrNcenter_cursor_on_next_focusr textfindr FindCaseSensitively)r.r0column end_columnmoveword text_cursorrs r goto_linezTextHelper.goto_lines4*+**40   $ $[%6%6 8N8N%+ -   $ $[%6%6 8N8N%/ 1 %%'E  # #K 0 LL & &{ 3||%%' ))+ %%--LL<<>t,uzz|0LL !!$ (I(IJrc|j} |jjjd}|j ry|j }t t|j|}|j}t|dkDrZ|D]U}|j}|jjj|}||vs=||}|sE|j|W|jj||jj r|jj!yy#t"$rYywxYw)zfUnfold parent fold trigger if the block is collapsed. :param block: Block to unfold. FoldingPanelNr)rrepanelsgetrq blockNumbersortedlist current_treefolding_statuslenbeginr4r6toggle_fold_triggerrprrr^) r.r=r folding_panelfold_start_lineenclosing_regionsrregion fold_statuss rrozTextHelper.unfold_if_colapseds2   , LL//33NCM #//1O!'t**?;(=!> +99N$%)/EF&,llO LL113EE')E&.8&4_&E &)==eDE LL & &v .||%%' ))+(1   s%D>> E  E cR|jjjS)zReturns the selected text.)rer5 selectedTextr\s r selected_textzTextHelper.selected_text s||&&(5577rNc|j}|s|j}|j}|jx}}|j s|j |j |jd |jd}|j}|j}||vr |dk7r|dk7s|jrn3 |j}|j||j s|r|j||js|j |j|jd|jd}|j}||vr |dk7r|dk7s|jrn2|j}|j||js|j||j||j|S#t$rYwxYw)a3 Gets the word under cursor using the separators defined by :attr:`spyder.plugins.editor.widgets.codeeditor.CodeEditor.word_separators`. FIXME: This is not working because CodeEditor have no attribute word_separators .. note: Instead of returning the word string, this function returns a QTextCursor, that way you may get more information than just the string. To get the word, just call ``selectedText`` on the returned value. :param select_whole_word: If set to true the whole word is selected, else the selection stops at the cursor position. :param text_cursor: Optional custom text cursor (e.g. from a QTextDocument clone) :returns: The QTextCursor that contains the selected word. rr2t)rer5word_separatorsr8atStartr9Leftr<risspace IndexErrorr7atEndrm) r.select_whole_wordr|r#rend_pos start_poschar selected_txts rword_under_cursorzTextHelper.word_under_cursors& ++-K 00)2244)%%'  $ $  +"8"8! = "//1!4"("8"8*779  O3%,1D '$,,.I  # #I .%%'   # #G ,!'')(():):)4)?)?D"//1!4*779  O3%,1D %..0''0"'')  *)?)?@+  s5A G## G/.G/cx|j}|j|j}|jd|}|S)z Selects the word under the **mouse** cursor. :return: A QTextCursor with the word under mouse cursor selected. T)recursorForPosition_last_mouse_posrr.r#r|s rword_under_mouse_cursorz"TextHelper.word_under_mouse_cursorIs; ..v/E/EF ,,T;? rc|jjj|jjjfS)z Returns the QTextCursor position. The position is a tuple made up of the line number (0 based) and the column number (0 based). :return: tuple(line, column) )rer5r columnNumberr\s rcursor_positionzTextHelper.cursor_positionTs@ '')557 '')668: :rc(|jdS)zV Returns the text cursor's line number. :return: Line number rrr\s rcurrent_line_nbrzTextHelper.current_line_nbr^ ##%a((rc(|jdS)zZ Returns the text cursor's column number. :return: Column number rrr\s rcurrent_column_nbrzTextHelper.current_column_nbrfrrcR|jjjS)zt Returns the line count of the specified editor. :return: number of lines in the document. )rer4 blockCountr\s rrkzTextHelper.line_countns ||$$&1133rcx|jj}|j|}|jS)z Gets the text of the specified line. :param line_nbr: The line number of the text to get :return: Entire line's text :rtype: str )rer4r6ru)r.line_nbrdocrs r line_textzTextHelper.line_textvs2ll##%%%h/zz|rch|jr"|j|jdz Sy)z} Gets the previous line text (relative to the current cursor pos). :return: previous line text (str) rr!)rrr\s rprevious_line_textzTextHelper.previous_line_texts0  ">>$"7"7"9A"=> >rc@|j|jS)zb Returns the text of the current line. :return: Text of the current line )rrr\s rcurrent_line_textzTextHelper.current_line_texts ~~d33566rc|j}|j|}|j|j|j ||j |y)z Replace an entire line with ``new_text``. :param line_nbr: line number of the line to change. :param new_text: The replacement text. N)rerlselectLineUnderCursor insertTextrp)r.rnew_textr#r|s r set_line_textzTextHelper.set_line_textsM**84 ;667x([)rc |j}|j}|j|j|j|j |j |j|j|j|y)z&Removes the last line of the document.N) rer5r9EndrnrrremoveSelectedTextdeletePreviousCharrprs rremove_last_linezTextHelper.remove_last_linesm'')   +2H2HI;667&&(&&([)rc|jj}|jjj|dz }|j |j |S)Nr)rer5r4r6r7r8)r.r0r=rs rrlzTextHelper._move_cursor_tosO((* %%'99$q&A5>>+, rc|j}|dk(r|jdz }|dkrd}|j|}||kDrQ|j|j|j ||z |j|j |j n||krw|j|j |j|j|j|j ||z |j|j|j n&|j|j |j |r|j||S)a Selects entire lines between start and end line numbers. This functions apply the selection and returns the text cursor that contains the selection. Optionally it is possible to prevent the selection from being applied on the code editor widget by setting ``apply_selection`` to False. :param start: Start line number (0 based) :param end: End line number (0 based). Use -1 to select up to the end of the document :param apply_selection: True to apply the selection before returning the QTextCursor. :returns: A QTextCursor that holds the requested selection rr) rerkrlr9Downr< EndOfLinernUp StartOfLinerp)r.rUendapply_selectionr#r|s r select_lineszTextHelper.select_liness." "9//#a'C 19E**51 ;  $ $[%5%5%0%;%;S5[ J  $ $[%:%:%0%;%; = 5[  $ $[%:%:%0%;%; =  $ $[^^%0%;%;US[ J  $ $[%<%<%0%;%; =  $ $[%:%:%0%;%; =    -rc|j}|jj|}|jrEt |j |j |jjS|dkryt |j |jj |jjS)a Computes line position on Y-Axis (at the center of the line) from line number. :param line_number: The line number for which we want to know the position in pixels. :return: The center position of the line. r) rer4r6rintblockBoundingGeometry translated contentOffsettoppreviousbottom)r. line_numberr#rs rline_pos_from_numberzTextHelper.line_pos_from_numbers!33K@ ==?v33E:EE$$&((+/ / ! v33 "",*V-A-A-C"DVVXO Orc|j}|jj}|jD]\}}}||cxkr ||zks|cSy)z Returns the line number from the y_pos. :param y_pos: Y pos in the editor :return: Line number (0 based), -1 if out of range r)re fontMetricsheightvisible_blocks)r.y_posr#rrr0rs rline_nbr_from_positionz!TextHelper.line_nbr_from_positions`##%,,. & 5 5  Cue+sV|+ , rc|jj}|j|j|jj j |j |jy)zU Marks the whole document as dirty to force a full refresh. **SLOW** N)rer5rDocumentr4markContentsDirtyselectionStart selectionEnd)r.r|s rmark_whole_doc_dirtyzTextHelper.mark_whole_doc_dirtys]ll--/ ;//0 11+2L2L2N2=2J2J2L Nrc2|jj}|r |j}|j}|j ||r-|j |j |j |jj|y)a  Inserts text at the cursor position. :param text: text to insert :param keep_position: Flag that specifies if the cursor position must be kept. Pass False for a regular insert (the cursor will be at the end of the inserted text). N)rer5rrrr7r<rp)r.ru keep_positionr|ses r insert_textzTextHelper.insert_texts|ll--/ **,A((*At$   # #A &  # #A{'='= > "";/rcd}|jj}g}d}|j|d|}|} |js||| r t |}|j |j |jf|j|jdz|j|||}|js||fS)a- Searches a text in a text document. :param text_cursor: Current text cursor :param search_txt: Text to search :param search_flags: QTextDocument.FindFlags :returns: the list of occurrences, the current occurrence index :rtype: tuple([], int) c|j|jk\xr!|j|jkS)z Compares two QTextCursor. :param cursor_a: cursor a :param cursor_b: cursor b :returns; True if both cursor are identical (same position, same selection) )rr)cursor_acursor_bs rcompare_cursorsz/TextHelper.search_text..compare_cursors&sD++-1H1H1JJG))+x/D/D/FF Hrrrr) rer4rvisNullrappendrrr7r8) r.r| search_txt search_flagsr text_document occurrencesindexr=original_cursors r search_textzTextHelper.search_texts H --/  ##J<@%--/v7K(    5 5 7 & 3 3 5 7 8   v014 5"'' FLIF --/E!!rc|gd}d}d}t|tr-t|jdz }|j }nQt|t rA|j }|j|jz }|j }||j}|jj}|r|jj}|D]} | j|cxkr| j| jzks0n3|D]K} | jj!| jj"k(} || | jk(sG| sJyy)a/ Checks if a block/cursor is a string or a comment. :param cursor_or_block: QTextCursor or QTextBlock :param formats: the list of color scheme formats to consider. By default, it will consider the following keys: 'comment', 'string', 'docstring'. N)commentstring docstringrrTF)rrrrulayoutrrr8additionalFormatsresyntax_highlighter color_schemeformatsrUlengthformat objectType UserObject) r.cursor_or_blockrrposbadditional_formatssh ref_formatsrfmt_type is_user_objs ris_comment_or_stringzTextHelper.is_comment_or_stringAs6 ?8G oz 2o**,-1C$++-F  5%%'A!**,qzz|;CXXZF  !'!9!9!; 00B oo55 +,Aww#<188);<(/,H+,88+>+>+@+,88+>+>,?K +H 5 A$/'+ ,,r)rrTr!)FN)rrT)TrH)r@rArBr_propertyrer"r}rorrrrrrrkrrrrrrlrrrrrrr rCrrraras$$ & D!,F89v :))4 7 ** )VO( N0&$"L rraceZdZdZedZedZedZedZedZ edZ edZ y ) TextBlockHelperax Helps retrieving the various part of the user state bitmask. This helper should be used to replace calls to ``QTextBlock.setUserState``/``QTextBlock.getUserState`` as well as ``QSyntaxHighlighter.setCurrentBlockState``/ ``QSyntaxHighlighter.currentBlockState`` and ``QSyntaxHighlighter.previousBlockState``. The bitmask is made up of the following fields: - bit0 -> bit26: User state (for syntax highlighting) - bit26: fold trigger state - bit27-bit29: fold level (8 level max) - bit30: fold trigger flag - bit0 -> bit15: 16 bits for syntax highlighter user state ( for syntax highlighting) - bit16-bit25: 10 bits for the fold level (1024 levels) - bit26: 1 bit for the fold trigger flag (trigger or not trigger) - bit27: 1 bit for the fold trigger state (expanded/collapsed) c@|y|j}|dk(r|S|dzS)z Gets the user state, generally used for syntax highlighting. :param block: block to access :return: The block state r userStaterstates r get_statezTextBlockHelper.get_state|s/ =! B;Lz!!rcx|y|j}|dk(rd}|dz}|dz}||z}|j|y)z Sets the user state, generally used for syntax highlighting. :param block: block to modify :param state: new state value. :return: Nrrirr setUserState)rr user_state higher_parts r set_statezTextBlockHelper.set_statesQ = __&  J :-    5!rcF|y|j}|dk(rd}|dzdz S)z{ Gets the block fold level. :param block: block to access. :returns: The block fold level rrirrs r get_fold_lvlzTextBlockHelper.get_fold_lvls4 =! B;E "r))rc|y|j}|dk(rd}|dk\rd}|dz}||dzz}|j|y)z Sets the block fold level. :param block: block to modify :param val: The new fold level [0-7] Nrrii|rrrvalrs r set_fold_lvlzTextBlockHelper.set_fold_lvlsV = ! B;E %<C   5!rcR|y|j}|dk(rd}t|dzS)z Checks if the block is a fold trigger. :param block: block to check :return: True if the block is a fold trigger (represented as a node in the fold panel) Frri)rboolrs ris_fold_triggerzTextBlockHelper.is_fold_triggers4 =! B;EEJ&''rc|y|j}|dk(rd}|dz}|t|dzz}|j|y)z Set the block fold trigger flag (True means the block is a fold trigger). :param block: block to set :param val: value to set Nrri{rrrr"s rset_fold_triggerz TextBlockHelper.set_fold_triggersN = ! B;E  SR 5!rc|y|j}|dk(rd}|dz}|t|dzz}|j|y)z Sets the fold trigger state (collapsed or expanded). :param block: The block to modify :param val: The new trigger state (True=collapsed, False=expanded) Nrriwr*r"s r set_collapsedzTextBlockHelper.set_collapsedsN = ! B;E  SR 5!rN) r@rArBr_ staticmethodrrr r$r'r+r.rCrrrrds. " """$ * *""$ ( ("""""rrc*tj|d}|jdr|dd}|}|s`|tj|\}}|j D]3}|j s|jdr |dd}d|vs/d}2|S|S)zGet file language from filenamer.Nz#!python)ospsplitext startswithr read splitlinesstrip)filenameruextlanguage_encr0shebangs rget_file_languager?s ,,x  #C ~~c!"gH  <!x0JD$OO% D::<t$qr(w&'H O  Or)nrH)r_rgos.pathpathr4 qtpy.QtCorerr qtpy.QtGuirrrrr spyder.py3compatr spyder.utilsr rrrobjectrErarr?rCrrrHsr#'',!3*K$'#&'#T:V:zrrj M"fM"`r