Change code viewer from RichText to Scintilla

[shashClp]

Using Scintilla wxWidgets widget, I changed the code viewer from parsing code and setting up a RichText widget, to letting Scintilla parse it and format it. The advantages are:

1. "Better" parser, easily tweakable
2. Line numbers (in the margin)
3. Per line timings in the margin
4. Less code :)

What could be improved:

1. Line numbers are always active. Could be an option

[CyberShadow]

Awesome! This was on my list for a while.

Could you please update the build instructions?

Is keywords.txt still needed? I'd think a syntax highlighter would have its own keyword list.

[shashClp]

Hey :)

The build instructions remain unchanged, it's using the same wxWidgets version detailed there.

The keywords.txt is still needed, the parser needs a list (or several, if you want) of keywords. The sample provided in wxWidgets uses an inline list for it's example, maybe it would be more interesting to use that, I can check it out if you want to :)

[CyberShadow]

Hmm, I thought Scintilla was an additional build dependency. All the better then.

[CyberShadow]

Could you please rebase to squash whitespace and merge commits?

Sleepy's codebase is inconsistent with whitespace, but newer additions have used tabs, so I added an .editorconfig file to indicate that.

A few more nits:

• StringList::StringList is almost identical to StringSet::StringSet, DRY potential. Could be refactored to use one class with a template or flag, or subclasses.
• When clicking on a function or call stack item, the respective line ought to be selected (or somehow otherwise highlighted).
• Would be nice to select the lexer based on the extension. You can use Very Sleepy with any compiled language that emits debugging info in supported formats (e.g. D and probably Go and Rust).

Let me know if you want to handle these, or we can merge and I'll fix these myself.

[CyberShadow]

When clicking on a function or call stack item, the respective line ought to be selected (or somehow otherwise highlighted).

Actually never mind, the old version behaves the same. Would be nice to have though.

[shashClp]

I'll rebase, once I find how (I'm very new to git). About the rest:

1. I know, I'll think of a cleaner way to handle it, it's a bit crappy as it is
2. Easy to do, in theory
3. I'll refactor the code a bit more to make it easier to do, but won't add other languages support for now, as I can't test it easily :/

[CyberShadow]

Sounds good to me.

One way to squash everything into one commit is to do an interactive rebase (git rebase -i origin/master), and then replacing all but the first "pick" with "fixup".

[shashClp]

I'm currently using SourceTree, so I'll check how to do it there, and do the changes we discussed. But that'll be tomorrow :)

[shashClp]

About #2, there's a problem. Scintilla only highlights current line if the window has focus (once it loses focus, the highlight is lost). I don't really like windows stealing focus for the sake of it, not to mention that in this case it makes impossible to navigate the function list with the cursors. So I don't think it's a good idea :/

[CyberShadow]

OK, I'll think about it.

[shashClp]

Ok, everything done, only the rebase missing, which I'm battling atm

[CyberShadow]

There's some inconsistent whitespace, BTW. If you use a recent version of VS, you can get an extension which will configure the editor according to .editorconfig.

[CyberShadow]

SourceTree should make rebasing very simple:

http://blogs.atlassian.com/2014/06/interactive-rebase-sourcetree/

See squashing (you want to squash all commits into one).

[shashClp]

Yeah, I found that post yesterday, but messed up the squash a few minutes ago and had to restart. I'll check the editorconfig extension (or change the spaces to tabs, as I work with spaces).

[shashClp]

I think I'm having problems because there's a merge from master in the middle of the stream.

1. "git rebase -i origin/master" does nothing (doesn't show any commits to fixup/squash/pick)
2. I can merge until the merge from master with "git rebase -i HEAD~7"
3. Sourcetree fails to squash, from what it seems to be line conflicts

Spent +2h trying to rebase all my commits to no avail, I might try it tomorrow, or then think what I want to do with this

[CyberShadow]

1. "git rebase -i origin/master" does nothing (doesn't show any commits to fixup/squash/pick)

This works for me.

What is "origin", this repository or your fork?

Is the remote up-to-date? (git fetch origin)

[CyberShadow]

I could pick this up from here if you like, but I'll rewrite your commits on your behalf.

[shashClp]

I don't know what is origin, I just wrote that: "git rebase -i origin/master". Do I have to change 'origin' for something else? The remote seem to be up to date.

No, I would prefer to actually make it myself, but already spent 4x the time to try to squash than I actually spent writing the code, so it's getting a bit frustrating :(

[CyberShadow]

I don't know what is origin,

"origin" is the default name of the remote when you first clone a git repo. Which repo did you clone, https://github.com/VerySleepy/verysleepy or your fork at https://github.com/shashClp/verysleepy ?

[shashClp]

I cloned my fork

[CyberShadow]

OK, so you need to rebase on top of our master:

git remote add upstream https://github.com/VerySleepy/verysleepy
git fetch upstream
git rebase -i upstream/master

[shashClp]

Thanks, that did the trick, I could do the rebase after 2 merges :D. Sorry to bother you, first time using git :/

So, it's correct now?

[CyberShadow]

I don't see anything new. Did you push the new branch?

git push --force

Edit: Also, no worries.

[shashClp]

Yes I did, pushed the changes :S

[CyberShadow]

Oh, I see. It's not rebasing all commits because you've since merged your branch with master.

Here's what I suggest doing:

1. Clone your fork again to a second directory.
2. Copy over all the source files, just not the hidden .git directory.
3. Record all changes as one commit.
4. Force-push that one commit to your master branch.

[shashClp]

But I'm guessing I'd have to clone from the point I started working, because if I clone now, my head will point to the latest commit, thus no changes can be committed, neither pushed :S

If I have to resort to that, I'll probably just start over again, and:

1. Keep local copies of the 11 commits I did
2. Close this pull request
3. Delete my fork
4. Create new fork
5. Commit (again) my 11 commits
6. Rebase to squash those 11 commits to 1
7. Create new pull request

I know steps 5-6 could be avoided by just using the latest files, but I want to go through the process to learn how to do it :)

[CyberShadow]

Oh, right, because you used the master branch of your fork. (Usually people create a new branch per pull request.) You'd also want to reset your master to the main repository's master.

Here's a simpler way:

# Add the upstream repository. You might have done this already
git remote add upstream https://github.com/VerySleepy/verysleepy
git fetch upstream

# Reset HEAD and index to the upstream master, but keep working copy changes.
git reset upstream/master

# Commit
git commit -a -m "Changed source viewer to scintilla, percentages and line numbers on margin, code clean-up"

# Push
git push -f origin master

[shashClp]

Well, done.

Couldn't try my steps because your instructions seem to have crushed my historic (which I wanted to do through rebase), so I couldn't try it :/

[CyberShadow]

If you really want to, you can fish your old commits from the git reflog.

What's up with the three-space indent, though?

[shashClp]

Where? Just checked the 4 commited files, and could not see a single occurrence of that :S

[CyberShadow]

Ah, sorry about that. Had to temporarily use another browser, and Chrome treats tabs differently.

[CyberShadow]

What name should I credit you with in the changelog/about dialog?

[shashClp]

"Bernat Muñoz Garcia"

Thanks :)

[shashClp]

Btw, just rebuild it from source, and when you updated wine, dbghelpw.dll wasn't added (my guess it was been prebuilt and added before), so you might want to fix that :D

[CyberShadow]

Did you get and build the wine submodule, too?

[CyberShadow]

I suppose I need to update the build instructions...

[shashClp]

Yeah, it's a matter of building it, but it would be nice to add it to the build instructions :)

[CyberShadow]

Pushed.

[shashClp]

Amazing, thanks!

[CyberShadow]

When clicking on a function or call stack item, the respective line ought to be selected (or somehow otherwise highlighted).

a0207ed

[shashClp]

Oh, cool, it doesn't have the same problems SetCaretLineVisible has :)