feat: add stopwatch by hitanshu-mehta · Pull Request #1009 · cpeditor/cpeditor

hitanshu-mehta · 2021-11-10T10:32:26Z

Description

Added Stopwatch class using QElapsedTimer which emits a time signal every second. It also emits a StateChanged signal whenever the state of the stopwatch is changed.
These signals are connected with appropriate slots using which StopwatchWidget is updated.
Two new options are added in Preferences/Actions/Stopwatch.
- Display Stopwatch
- Automatically start/stop stopwatch on tab switch

Related Issues / Pull Requests

fixes #1005

Motivation and Context

The stopwatch will be useful to someone who wishes to keep track of the time taken to solve the problem.

How Has This Been Tested?

ManjaroLinux - 21.1.6

Screenshots (if appropriate)

It looks something like this.

Checklist

If the key of a setting is changed, the old attribute is updated or it is resolved in SettingsUpdater.
If there are changes of the text displayed in the UI, they are wrapped in tr() or QCoreApplication::translate().
If needed, I have opened a pull request or an issue to update the documentation.
If these changes are notable, they are documented in CHANGELOG.md.

Additional text

Translations need to be updated.

Signed-off-by: Hitanshu Mehta <[email protected]>

hitanshu-mehta · 2021-11-10T11:07:48Z

MacOs build failure seems unrelated 🤔

coder3101 · 2021-11-10T12:38:34Z

MacOs build failure seems unrelated 🤔

Clang tidy reported some suggestions that you should either fix or if its false alarm, Suppress it with an inline comment.

Former is preferred always.

ouuan · 2021-11-10T14:37:14Z

macOS uses the latest version of clang-tidy, so it's broken now, which is unrelated to this PR.

See #999 (comment). CP Editor is in slow development now, so I planned to wait for Arch Linux's clang 13 and resolve it at local.

ouuan · 2021-11-10T14:42:18Z

However, anyone is welcome to fix the clang-tidy issue, while I'm waiting for clang 13 on Arch. It should be fixed in a separate pull request.

Signed-off-by: Hitanshu Mehta <[email protected]>

hitanshu-mehta · 2021-11-11T11:30:10Z

PR is ready for review :)

src/mainwindow.hpp

src/mainwindow.cpp

src/Core/Stopwatch.hpp

src/mainwindow.hpp

ouuan · 2021-11-11T12:37:56Z

And I prefer making Stopwatch a widget instead of just an object.

src/Core/Stopwatch.hpp

src/mainwindow.hpp

Signed-off-by: Hitanshu Mehta <[email protected]>

hitanshu-mehta · 2021-11-16T05:09:47Z

And I prefer making Stopwatch a widget instead of just an object.

@ouuan Stopwatch is now the widget. MainWindow doesn't have the responsibility of updating the UI of the stopwatch now.

src/Widgets/Stopwatch.hpp

src/mainwindow.cpp

src/Widgets/Stopwatch.cpp

ouuan · 2021-11-26T09:46:25Z

Any progress?

hitanshu-mehta · 2021-11-26T15:22:58Z

Sorry, I'm taking time 😅 . I was busy with some other stuff. I will start working on the feature this weekend.

- Removes `Granularity` enum. - Removes `mainLayout` from the member variable of the `Stopwatch` class and declares it as local variable in constructor. - Removes some unnecessary code and does some minor changes. Signed-off-by: Hitanshu Mehta <[email protected]>

- Uses sigleshot timer with interval of `granularity + 10 - accumulator % granularity`. - This timer is trigger on every update if stopwatch is in `Running` state. Signed-off-by: Hitanshu Mehta <[email protected]>

hitanshu-mehta · 2021-11-26T18:48:39Z

@ouuan I have started using the SingleShot timer with an interval of granularity + 10 - accumulator % granularity. Here are a few things I observed.

UI updates are not happening smoothly due to different interval values each time we pause.
I also experimented with different values of the interval with the previous implementation (i.e. with a regular timer), values between 300ms to 400ms seem good enough to me.

Please try out this change and let me know your thoughts :)

src/Settings/settings.json

src/Widgets/Stopwatch.cpp

Signed-off-by: Hitanshu Mehta <[email protected]>

ouuan

LGTM, thanks for your contribution!

ouuan · 2021-11-27T05:45:11Z

@allcontributors add @hitanshu-mehta as a contributor for ideas and code.

allcontributors · 2021-11-27T05:49:08Z

@ouuan

I've put up a pull request to add @hitanshu-mehta! 🎉

hitanshu-mehta added 3 commits November 4, 2021 22:25

Add stopwatch in right panel

099e8d6

Signed-off-by: Hitanshu Mehta <[email protected]>

Add display stopwatch and auto start/stop on tab switch setting

90041a7

Signed-off-by: Hitanshu Mehta <[email protected]>

fix build failures

c8981b1

Signed-off-by: Hitanshu Mehta <[email protected]>

hitanshu-mehta force-pushed the timer branch from 26ec915 to c8981b1 Compare November 10, 2021 11:00

add entry in CHANGELOG

d99a8bf

Signed-off-by: Hitanshu Mehta <[email protected]>

ouuan requested changes Nov 11, 2021

View reviewed changes

coder3101 reviewed Nov 15, 2021

View reviewed changes

src/Core/Stopwatch.hpp Outdated Show resolved Hide resolved

src/mainwindow.hpp Show resolved Hide resolved

make stopwatch QWidget

12659fa

Signed-off-by: Hitanshu Mehta <[email protected]>

ouuan requested changes Nov 16, 2021

View reviewed changes

hitanshu-mehta added 2 commits November 26, 2021 23:49

Use SingleShot timer

24f3700

- Uses sigleshot timer with interval of `granularity + 10 - accumulator % granularity`. - This timer is trigger on every update if stopwatch is in `Running` state. Signed-off-by: Hitanshu Mehta <[email protected]>

ouuan added 7 commits November 27, 2021 10:09

Fix single shot interval

ca67274

Merge branch 'master' into pr-1009

6626276

style(CMakeLists): sort src

2243308

Update text & translations

a10aa53

Refactor & Fix start/stop on tab switch

d08df01

Add tr

61598f7

Add a "Stopwatch" label

eea4111

hitanshu-mehta commented Nov 27, 2021

View reviewed changes

src/Settings/settings.json Show resolved Hide resolved

Allow more than 24 hours

4a453ea

feat: show stopwatch result only when the button is pressed

1e4baeb

ouuan reviewed Nov 27, 2021

View reviewed changes

src/Widgets/Stopwatch.cpp Outdated Show resolved Hide resolved

hitanshu-mehta and others added 4 commits November 27, 2021 10:12

Remove unnecessary call to QCoreApplication::processEvents

f022c4d

Signed-off-by: Hitanshu Mehta <[email protected]>

Remove useless includes

4dfabd5

sytle: capitalize granularity

4d8dd95

Add showButton in the comment

195f00a

ouuan approved these changes Nov 27, 2021

View reviewed changes

ouuan mentioned this pull request Nov 27, 2021

feat(preferences/actions): add stopwatch cpeditor/cpeditor.github.io#241

Merged

ouuan merged commit cb1513e into cpeditor:master Nov 27, 2021

allcontributors bot mentioned this pull request Nov 27, 2021

docs: add hitanshu-mehta as a contributor for ideas, code #1017

Merged

Uh oh!

Conversation

hitanshu-mehta commented Nov 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues / Pull Requests

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate)

Checklist

Additional text

Uh oh!

hitanshu-mehta commented Nov 10, 2021

Uh oh!

coder3101 commented Nov 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ouuan commented Nov 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ouuan commented Nov 10, 2021

Uh oh!

hitanshu-mehta commented Nov 11, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ouuan commented Nov 11, 2021

Uh oh!

Uh oh!

Uh oh!

hitanshu-mehta commented Nov 16, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ouuan commented Nov 26, 2021

Uh oh!

hitanshu-mehta commented Nov 26, 2021

Uh oh!

hitanshu-mehta commented Nov 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ouuan left a comment

Choose a reason for hiding this comment

Uh oh!

ouuan commented Nov 27, 2021

Uh oh!

allcontributors bot commented Nov 27, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hitanshu-mehta commented Nov 10, 2021 •

edited

Loading

coder3101 commented Nov 10, 2021 •

edited

Loading

ouuan commented Nov 10, 2021 •

edited

Loading

hitanshu-mehta commented Nov 26, 2021 •

edited

Loading