GSoC 2020: Create and display initial tree model #6174

krkartikay · 2020-06-07T05:22:39Z

Adds tree hierarchy virtual functions treeParent(), treeChild(int idx), and treeChildCount() to descendants of ScoreElement. Also adds a ScoreItemModel (based on QAbstractItemModel) and an iterator to ScoreElement class to iterate over the child elements.

[Edit:]

Latest Blog for this PR: https://musescore.org/en/user/1743616/blog/2020/06/22/gsoc-2020-tree-model-week-3-finished-my-first-pr

Jojo-Schmitz · 2020-06-07T12:39:22Z

See https://travis-ci.org/github/musescore/MuseScore/jobs/695630221#L4559-L4591, there's a SIGSEGV

krkartikay · 2020-06-07T13:25:40Z

See https://travis-ci.org/github/musescore/MuseScore/jobs/695630221#L4559-L4591, there's a SIGSEGV

Yep, working on debugging it! :-)

shoogle

Looks good! Please make requested changes and squash into 3 commits:

Create score tree model
- Add libmscore/scoretree.cpp and modify all relevent .h files.
Create ScoreItemModel
- Add my code in mscore/scoreitemmodel(.h|.cpp)
- We will make me the author of this commit
Display score model in Tree View
- Add mscore/scoretreemodel(.h|.cpp)
- Make all necessary changes to other files (e.g. mscore/scoreitemmodel(.h|.cpp)).

Feel free to add more commits for anything that doesn't logically fit in one of those commits.

libmscore/scoreElement.cpp

libmscore/scoreElement.h

libmscore/element.cpp

mscore/musescore.cpp

libmscore/ambitus.h

shoogle

Please make requested changes. Git's --fixup and --autosquash options make it easy to amend historic commits. See article here.

libmscore/chordrest.h

mscore/scoreitemmodel.h

mscore/scoretreeview.h

mscore/scoreview.cpp

mscore/scoretreeview.h

mscore/scoreview.cpp

mscore/scoreitemmodel.cpp

mscore/scoretreewidget.h

shoogle

Nearly there. Please squash these latest changes into the last of the original 3 commits.

mscore/scoretreeview.cpp

mscore/scoretreeview.h

mscore/scoretreewidget.h

mscore/scoretreeview.h

mscore/scoretreeview.cpp

mscore/scoreitemmodel.h

shoogle

Ok, I think these will be the final set of changes. You should probably also run the changed C++ files through uncrustify. There is a script in tools/codestyle/uncrustify_run_file.sh. Do an interactive rebase and mark all commits as e for edit, then amend each one in turn. You might find you have fewer merge conflicts if you do them in reverse order:

Amend commit 3 (the last commit).
Amend commit 2 (the middle commit) and then 3 again.
Amend commit 1 (the first commit), then 2, then 3.

mscore/scoretreewidget.cpp

mscore/scoretreewidget.h

mscore/scoreitemmodel.h

libmscore/scoretree.cpp

mscore/scoretreeview.cpp

ecstrema · 2020-06-18T16:32:57Z

Do an interactive rebase and mark all commits as e for edit, then amend each one in turn. You might find you have fewer merge conflicts if you do them in reverse order:

Why not mark them as s for squash so it will do the amending automatically?

shoogle · 2020-06-18T16:41:54Z

@Marr11317, the idea was not to squash the commits but to tidy (or "uncrustify") the code within them. Every commit should do only "one thing" to the code, so I expect this PR to have at least 3 commits:

Create tree model (in libmscore)
Create item model (in mscore)
Display model in tree view

If a commit title has the word "and" then you should probably use 2 commits.

krkartikay · 2020-06-18T19:16:31Z

Added another commit to add spanner elements to the model. Spanners can be attached to either Measures, Segments, Chords or Notes. Their parent is the start element they are attached to, and their children are the SpannerSegments (one for each system the spanner appears in).

(@shoogle )

shoogle

@Kartikay26, the Spanner code looks good! Good job working out what SpannerSegment is for. I've spotted a few more changes that need to be made in addition to those mentioned in my previous review.

libmscore/spanner.cpp

mscore/musescore.cpp

mscore/scoretreeview.cpp

mscore/scoreitemmodel.cpp

shoogle

Great work! Just needs these two tiny changes and then I think it is done.

mscore/musescore.cpp

mscore/scoretreewidget.cpp

shoogle

Great job, @Kartikay26! I think we should merge this and move on to another PR.

libmscore/bsymbol.h

igorkorsukov · 2020-06-20T10:56:47Z

libmscore/scoretree.cpp

+
+ScoreElement* Score::treeParent() const
+{
+    return nullptr;  // Score is root node


Maybe for Score parent is the MasterScore, and the MasterScore should be the root?

There is still some confusion about what Score and MasterScore actually mean, so my vote is to leave it how it is for now and then wait to see if it causes problems.

It seems like for now Score and MasterScore actually point to the same object.

igorkorsukov · 2020-06-23T07:04:25Z

@Kartikay26 Tests do not compile, could you fix it?

This commit adds virtual functions treeChild, treeParent and treeChildCount to ScoreElement and implements them in most non-leaf-node classes. An iterator is also added to ScoreElement class to iterate over the children of any element. In this model, Spanners, Beams and Ties are given a single parent, which is the starting element of the spanner, beam or tie. Also, to ensure consistency in the model, spanners, beams, and ties appear in the children list only for their starting element. Children of spanner elements are SpannerSegments, one for each system the spanner appears in.

Created a ScoreItemModel using the score tree functions. It is a QAbstractItemModel which can be used with a QTreeView or QAbstractItemView.

Added a ScoreTreeView that displays the score tree in a QTreeView, and also created a QDockWidget called ScoreTreeWidget which is enabled in the debug builds to inspect the score tree model.

krkartikay · 2020-06-23T07:57:08Z

@igorkorsukov fixed the test and squashed the bug fix into previous commits. I don't know why AppVeyor isn't working though...

AntonioBL · 2020-06-23T08:59:15Z

I think maybe because ${PROJECT_SOURCE_DIR}/mtest/cmake.inc was added twice in mtest/libmscore/all_elements/CMakeLists.txt

Jojo-Schmitz · 2020-06-23T10:14:44Z

in https://github.com/musescore/MuseScore/pull/6174/files#diff-2aae82cf22077059502c3ce263a71d7eR19

mtest/libmscore/all_elements/tst_tree_model.cpp

mtest/libmscore/all_elements/CMakeLists.txt

Renamed the layout_elements folder to all_elements, for tests that need to check every element and don't need reference files. Added tst_tree_model to all_elements directory. The test checks that for every element el, `el->treeChild(i)->parent` should be `el`.

krkartikay marked this pull request as draft June 7, 2020 05:22

krkartikay force-pushed the gsoc-2020-Tree-Model-base branch from da15c59 to 2fbe631 Compare June 7, 2020 18:45

shoogle requested changes Jun 15, 2020

View reviewed changes

krkartikay force-pushed the gsoc-2020-Tree-Model-base branch 2 times, most recently from 5cc0a2e to 70472ea Compare June 16, 2020 10:34

krkartikay marked this pull request as ready for review June 16, 2020 10:36

shoogle requested changes Jun 16, 2020

View reviewed changes

shoogle reviewed Jun 16, 2020

View reviewed changes

mscore/scoreitemmodel.cpp Outdated Show resolved Hide resolved

krkartikay force-pushed the gsoc-2020-Tree-Model-base branch 3 times, most recently from a6a5f90 to 01e6174 Compare June 17, 2020 08:47

shoogle requested changes Jun 17, 2020

View reviewed changes

mscore/scoretreewidget.h Outdated Show resolved Hide resolved

mscore/scoretreewidget.h Outdated Show resolved Hide resolved

mscore/scoretreewidget.h Outdated Show resolved Hide resolved

shoogle requested changes Jun 17, 2020

View reviewed changes

krkartikay force-pushed the gsoc-2020-Tree-Model-base branch 3 times, most recently from 6c43906 to 1c20a31 Compare June 18, 2020 11:33

shoogle requested changes Jun 18, 2020

View reviewed changes

shoogle requested changes Jun 19, 2020

View reviewed changes

shoogle reviewed Jun 19, 2020

View reviewed changes

mscore/scoreitemmodel.cpp Show resolved Hide resolved

krkartikay force-pushed the gsoc-2020-Tree-Model-base branch from c3480c3 to d5519d8 Compare June 19, 2020 19:20

shoogle approved these changes Jun 19, 2020

View reviewed changes

mscore/musescore.cpp Outdated Show resolved Hide resolved

mscore/scoretreewidget.cpp Outdated Show resolved Hide resolved

krkartikay force-pushed the gsoc-2020-Tree-Model-base branch from d5519d8 to 8d24c50 Compare June 20, 2020 04:56

krkartikay changed the title ~~[WIP] GSoC 2020: Add tree hierarchy functions to ScoreElements.~~ GSoC 2020: Create and display initial tree model Jun 20, 2020

krkartikay force-pushed the gsoc-2020-Tree-Model-base branch from 8d24c50 to f155855 Compare June 20, 2020 07:58

shoogle approved these changes Jun 20, 2020

View reviewed changes

igorkorsukov reviewed Jun 20, 2020

View reviewed changes

libmscore/bsymbol.h Outdated Show resolved Hide resolved

igorkorsukov reviewed Jun 20, 2020

View reviewed changes

igorkorsukov approved these changes Jun 20, 2020

View reviewed changes

krkartikay force-pushed the gsoc-2020-Tree-Model-base branch 3 times, most recently from 62b06e5 to 0990831 Compare June 22, 2020 12:31

krkartikay force-pushed the gsoc-2020-Tree-Model-base branch from 0990831 to cf52ae3 Compare June 23, 2020 07:06

krkartikay and others added 3 commits June 23, 2020 12:44

Create ScoreItemModel

acf4a3c

Created a ScoreItemModel using the score tree functions. It is a QAbstractItemModel which can be used with a QTreeView or QAbstractItemView.

Display ScoreItemModel in a Tree View

28bfe82

Added a ScoreTreeView that displays the score tree in a QTreeView, and also created a QDockWidget called ScoreTreeWidget which is enabled in the debug builds to inspect the score tree model.

krkartikay force-pushed the gsoc-2020-Tree-Model-base branch from cf52ae3 to 5994493 Compare June 23, 2020 07:16

shoogle requested changes Jun 23, 2020

View reviewed changes

krkartikay force-pushed the gsoc-2020-Tree-Model-base branch from 5994493 to 320abc1 Compare June 23, 2020 16:27

shoogle approved these changes Jun 23, 2020

View reviewed changes

krkartikay force-pushed the gsoc-2020-Tree-Model-base branch from 320abc1 to e514768 Compare June 24, 2020 06:32

krkartikay mentioned this pull request Jun 29, 2020

GSoC 2020: scanElements refactoring based on tree model [vtests] #6274

Merged

igorkorsukov merged commit 461674e into musescore:master Jun 29, 2020

Jojo-Schmitz mentioned this pull request Jun 30, 2020

Fix Compiler warnings #6276

Merged

krkartikay mentioned this pull request Aug 17, 2020

[MU4] GSoC 2020: Change ScoreView to QAbstractItemView (Also adds tooltips) #6464

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GSoC 2020: Create and display initial tree model #6174

GSoC 2020: Create and display initial tree model #6174

krkartikay commented Jun 7, 2020 •

edited

Loading

Jojo-Schmitz commented Jun 7, 2020

krkartikay commented Jun 7, 2020

shoogle left a comment •

edited

Loading

shoogle left a comment

shoogle left a comment

shoogle left a comment

ecstrema commented Jun 18, 2020

shoogle commented Jun 18, 2020

krkartikay commented Jun 18, 2020

shoogle left a comment

shoogle left a comment

shoogle left a comment

igorkorsukov Jun 20, 2020

shoogle Jun 20, 2020

krkartikay Jun 21, 2020

igorkorsukov commented Jun 23, 2020

krkartikay commented Jun 23, 2020

AntonioBL commented Jun 23, 2020

Jojo-Schmitz commented Jun 23, 2020

GSoC 2020: Create and display initial tree model #6174

GSoC 2020: Create and display initial tree model #6174

Conversation

krkartikay commented Jun 7, 2020 • edited Loading

Jojo-Schmitz commented Jun 7, 2020

krkartikay commented Jun 7, 2020

shoogle left a comment • edited Loading

Choose a reason for hiding this comment

shoogle left a comment

Choose a reason for hiding this comment

shoogle left a comment

Choose a reason for hiding this comment

shoogle left a comment

Choose a reason for hiding this comment

ecstrema commented Jun 18, 2020

shoogle commented Jun 18, 2020

krkartikay commented Jun 18, 2020

shoogle left a comment

Choose a reason for hiding this comment

shoogle left a comment

Choose a reason for hiding this comment

shoogle left a comment

Choose a reason for hiding this comment

igorkorsukov Jun 20, 2020

Choose a reason for hiding this comment

shoogle Jun 20, 2020

Choose a reason for hiding this comment

krkartikay Jun 21, 2020

Choose a reason for hiding this comment

igorkorsukov commented Jun 23, 2020

krkartikay commented Jun 23, 2020

AntonioBL commented Jun 23, 2020

Jojo-Schmitz commented Jun 23, 2020

krkartikay commented Jun 7, 2020 •

edited

Loading

shoogle left a comment •

edited

Loading