TwoClocks

I find myself in a need of regular breaks during my study times, hence I created TwoClocks. TwoClocks accepts two times via CLI: one for the study duration, one for the break duration.

The aim was to use write the project in pure C with as few dependencies as possible, however I had to use objc to run audio (casting objc code to pure C is doable via objc_sendMsg, however it is un-maintainable, and super buggy).

Supported Platforms

MacOS only due to the fact I use objc to play audio, and also _NSGetExecutablePath to construct full absolute paths for binary and assets loading (other than that I believe the code is portable).

Naming Conventions

It might not be optimal but I love to have some standardization in naming:

format	usage
gVarName	global variables
varName	normal variables
FULL_CAPITAL	macros
FunctionName	function
some_type_t	my own structs
some_file.c/h	file names

Requirements

1. Ninja build System
2. CMake 3.18+
3. C99

---

Build instructions

git clone https://github.com/Haiderahandali/TwoClocks.git
cd TwoClocks
git submodule init
git submodule update
cmake -G "Ninja Multi-Config" -B build .
cmake --build build/ --config Debug  # or --config Release
./bin/Debug/TwoClocks 15 30

Notes

The projects started to be 100 percent from scratch, however, due to the fact objc is being deprecated, I used SDL to encapsulate getting a window and flipping the buffers of the screen. and in audio.m I felt SDL code is a bit too long to just play a sound, so I wrote a C wrapper. There is no license, use it, distribute it however you want, but there is no warranty as well.

circle.c and circle.h are not required, in the early version of the app, the text rendered was inside a circle, then It was replaced by bmp files; however, I enjoyed writing them, so I keep them for my own reference.

TODO

1. Extend the alarm for more than 1 hour
2. Added OS keybindings to run it in a more convenient manner
3. Remove ojbc code completely and replace it with nice pure C code.
4. Add customizibility, such as font's color, background, etc.
5. If I am lucky enough, I would add it to a bundle and a full gui interface