Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PR: Add code folding to the Editor #3833

Merged
merged 22 commits into from
Jan 31, 2017
Merged

PR: Add code folding to the Editor #3833

merged 22 commits into from
Jan 31, 2017

Conversation

rlaverde
Copy link
Member

@rlaverde rlaverde commented Dec 13, 2016 •
edited
Loading

Fixes #706

Progress:

  • Add pyqode code decoration.py folding.py utils.py codefolding.py managers/decoration.py
  • Register FoldingPanel to codeeditor (at the moment It's displayed as an empty panel)

TODO:

  • Reconnect Signals
  • Fix comment out editor.add.menu()
  • Delete inner lines if folding line is deleted
  • Implement pyqode SyntaxHighlighter.highlightBlock functionality that call FoldDetector.process_block, in each block
  • Fix error with Syntax higtlighter and multiple line comments
  • Fix error with mouse event (mouse position is a little wrong)
  • Change docstrings to make reference to spyder classes
  • Rebase it after PR: Add Panels and PanelsManager, and use it to add LineNumberArea to editor #3778
  • Add pyqode copyright and license and links to source files
  • Reword, reorder and squash some commits
  • Test that everything is working

Somethings that I'm not sure if should be do it:
- Remove decoration.py and implement It's functionality in CodeEditor I think is ok to leave it
- Remove utils.py and use CodeEditor functionality (and implement missing functionalities) I think is ok to leave it too

Things that I'll address in other PRs

  • Move some codeeditor functions to TextHelper, and delete redundant functions
  • Inners foldings should be preserved when folding unfolding their parent
  • Add shortcuts and menu for codefolding actions
  • Some style improvements (only show arrows when mouseover, different colors, only decorate selected block, use different icons for folding arrows)
  • Implement others fold detectors (apart of the indentation fold detector)

@ccordoba12
Copy link
Member

Great work @rlaverde!

Could you post a screenshot for this new feature as part of the description? Thanks!

@rlaverde
Copy link
Member Author

@ccordoba12 at the current state it's not possible, It just show an empty panel, I think that after implemented the missing part in SyntaxHighlighter, it will work :)

@ccordoba12 ccordoba12 added this to the v4.0beta1 milestone Dec 20, 2016
@rlaverde
Copy link
Member Author

There are a lot some things missing, but It's working now 😄
code_folding

@ccordoba12
Copy link
Member

This is really cool!! Thanks a lot @rlaverde!!

How folding is computed? Using regexs?

@rlaverde
Copy link
Member Author

How folding is computed? Using regexs?

Using Indentation, although It could be extended to use other methods
https://github.com/spyder-ide/spyder/pull/3833/files#diff-6ceb5fb1fd412eaffd5a62296d5c688bR138

@ccordoba12
Copy link
Member

Using Indentation, although It could be extended to use other methods

Ok, that's fine for Python, but we definitely need to add other methods for languages like C/C++ and Fortran ;-)

In any case this is a hell of a improvement!! Good job :-)

@rlaverde rlaverde force-pushed the codefolding branch 3 times, most recently from 436dbc6 to 078100a Compare December 22, 2016 14:55
@rlaverde rlaverde force-pushed the codefolding branch 3 times, most recently from f9d36b4 to f9f6b80 Compare December 24, 2016 15:33
@rlaverde
Copy link
Member Author

@goanpeca @ccordoba12 This is ready, only missing a rebase with master after #3778 merge

@rlaverde rlaverde changed the title [WIP] PR: Codefolding PR: Codefolding Dec 24, 2016
@goanpeca
Copy link
Member

goanpeca commented Dec 24, 2016 •
edited
Loading

Woot! so baby jesus is getting code folding after all 🤣

@ccordoba12
Copy link
Member

Great work @rlaverde! Really nice Christmas present for Spyder!!

I have one question: is this only applied to Python files (for now)?

@ccordoba12
Copy link
Member

One important suggestion before reviewing: please use FontAwesome icons for the folding marks, and not just the PNG's you provided. That's very important to preserve not only consistency but also our ability to render correctly in high DPI screens.

@goanpeca
Copy link
Member

One important suggestion before reviewing: please use FontAwesome icons for the folding marks, and not just the PNG's you provided. That's very important to preserve not only consistency but also our ability to render correctly in high DPI screens.

@rlaverde yes, could we use those icons better :-) ?

@ccordoba12
Copy link
Member

Png's are fine for the Spyder 2 theme, but we also need to use FontAwesome icons :-)

@goanpeca
Copy link
Member

@rlaverde could you rebase now that panels are merged?

@rlaverde rlaverde force-pushed the codefolding branch 2 times, most recently from 75d3d0e to 7f22c1d Compare December 27, 2016 15:28
@rlaverde
Copy link
Member Author

rlaverde commented Dec 27, 2016 •
edited
Loading

I have one question: is this only applied to Python files (for now)?

This is applied to all files, folding are detected using indentation (with the len of indent_chars)

One important suggestion before reviewing: please use FontAwesome icons for the folding marks, and not just the PNG's you provided. That's very important to preserve not only consistency but also our ability to render correctly in high DPI screens.

Ready, I deleted old pngs and use caret font awesome icons. (I squashed the commit)

could you rebase now that panels are merged?

I just rebase it with master 😄

@goanpeca
Copy link
Member

@ccordoba12 are we planning on having pngs with Spyder 4.0?

I would say that on 4.0 we should only support ttf fonts via qtawesome?

@ccordoba12
Copy link
Member

I would say that on 4.0 we should only support ttf fonts via qtawesome?

I agree, but until we do that we're still supporting the Spyder 2 theme :-)

@goanpeca
Copy link
Member

I agree, but until we do that we're still supporting the Spyder 2 theme :-)

But this is on Master... so why should we support it on master?

@rlaverde
Change pycode imports to spyder imports.
0784037
@rlaverde
Remove old QStyleOptionViewItemV2 class.
04c0fbe 
Use QStyleOptionViewItem for PyQt4 and PyQt5.
@rlaverde
Add FoldingPanel to CodeEditor.
7bcc9ad
@rlaverde
Add key_press and new_text_set Signals.
8c5c340 
Emit this signals in corresponding methods.
@rlaverde
Delete code for add menu and shortcuts for codefolding panel.
381e10e
@rlaverde
Adapt sintaxHighlighter for code folding.
30bb969 
- Make syntaxHighlighter process blocks for folding.
- Change syntaxHiglighter calls to use TextBlockHelper.
- Add simple docstrings highlight_block methods, and fix some style issues.
@rlaverde
Change tab_length for len(indent_chars) in print_tree function.
fbae952
@rlaverde
Add arrow images for folding icons, using font-awesome icons.
b5ebca7
@rlaverde
Add decorations manager to CodeEditor.
5709fd0
@rlaverde
Fix little error with mouseEvent and block position in codefolding.
bd9abd3
@rlaverde
Add pyqode copyright and license and links to source files.
3322d4c
@rlaverde
Change docstrings to make reference to spyder classes.
69af3e9 
Fix some style issues in docstrings
@rlaverde
Delete _logger functions from files copied from pyqode.
6b7560a
@rlaverde
Use custom style in codefolding instead of native
60b3aef
@rlaverde
Move editor utils functions out of api
41a3dd9
@rlaverde
Delete unused memoized function copied from pyqode
bd8b9aa
@rlaverde
Move decorations to sourcecode editor API
d46faa7
@rlaverde
Move decorations utils out of sourcecode api.
d09e65c
@rlaverde
Move folding.py out of spyder.api to sourcecode.api and sourcecode.fo…
093757f 
…lding
@rlaverde
Fix error, change pyqode import for spyder import.
6fac0e5
@rlaverde
Create spyder.api.editor to expose some parts of sourcecode.api
b62e965
@goanpeca
Copy link
Member

@ccordoba12 unless you have more comments this is ready to be merged

@ccordoba12
Copy link
Member

Ok, let's go with it so that @rlaverde can keep enhancing it on master.

This is a huge improvement!!! Thanks @rlaverde for working on it :-)

@ccordoba12 ccordoba12 merged commit cdb55ce into spyder-ide:master Jan 31, 2017
@rlaverde rlaverde deleted the codefolding branch January 31, 2017 14:10
@rlaverde rlaverde mentioned this pull request Mar 19, 2017
Closed
This was referenced Jul 11, 2017
Closed
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ccordoba12 ccordoba12 ccordoba12 left review comments

@goanpeca goanpeca goanpeca left review comments

Assignees

@rlaverde rlaverde

Labels
None yet
Projects
None yet
Milestone
v4.0beta1
Development

Successfully merging this pull request may close these issues.
4 participants
@rlaverde @ccordoba12 @goanpeca @durack1