Skip to content

Latest commit

 

History

History
executable file
·
196 lines (126 loc) · 5.5 KB

HACKING.md

File metadata and controls

executable file
·
196 lines (126 loc) · 5.5 KB
Raw

Compilation

Before you start coding, you will need to install some dependencies:

# Ubuntu, Debian and derivatives:
$ sudo apt-get install git build-essential gdb cmake debhelper \
  libudev-dev libinput-dev libpugixml-dev libcairo2-dev libx11-dev libxtst-dev libxrandr-dev libxi-dev libglib2.0-dev \
  libgtk-3-dev # GTK is optional, see "Compilation flags"

# Red Hat, Fedora, CentOS and derivatives:
$ sudo dnf groupinstall "Development Tools"
$ sudo dnf install git gcc gcc-c++ gdb cmake rpm-build \
  libudev-devel libinput-devel pugixml-devel cairo-devel libX11-devel libXtst-devel libXrandr-devel libXi-devel glib2-devel \
  gtk3-devel # GTK is optional, see "Compilation flags"

Now clone the source code and compile it following the usual CMake compilation steps:

$ git clone https://github.com/JoseExposito/touchegg.git
$ cd touchegg
$ mkdir build
$ cd build
$ cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release ..
$ make -j$(nproc)

Installation

After building the source code, you can install Touchégg by running this commands:

$ cd build
$ sudo make install
$ sudo systemctl daemon-reload && sudo systemctl restart touchegg # Start the daemon
$ touchegg # Run Touchégg

In addition, you can generate a Debian package and install it: (from the cloned touchegg folder)

$ dpkg-buildpackage -rfakeroot -us -uc -tc
$ sudo apt install ../touchegg_*.deb # Install the package
$ touchegg # Run Touchégg

Or a rpm package: (from the cloned touchegg folder)

$ mkdir -p ~/rpmbuild/{BUILD,RPMS,SOURCES,SPECS,SRPMS}
$ tar -czvf ~/rpmbuild/SOURCES/touchegg.tar.gz -C .. touchegg --transform s/^touchegg/touchegg-$(git describe --tags --abbrev=0)/
$ rpmbuild -ba rpm/touchegg.spec
$ sudo dnf install ~/rpmbuild/RPMS/x86_64/touchegg-?.?.?-?.x86_64.rpm

Compilation flags

In addition to the default CMake flags, this compilation options are available:

cmake -DAUTO_COLORS=[ON|OFF]

GTK is used in to get your theme's color and use it in animations:

<settings>
  <property name="color">auto</property>
  <property name="borderColor">auto</property>
</settings>

By default this flag is set to ON, i.e., auto is available for color and borderColor.

Set it to OFF if you don't want to install GTK in your system. Have in mind that auto will not be available for color and borderColor and you will have to manually set them up.

cmake -DUSE_SYSTEMD=[ON|OFF]

Install or not systemd related files.

By default this flag is set to ON, i.e., systemd will be used.

Set it to OFF if your distribution doesn't use systemd.

Code Style

This project follows Google C++ Style Guide:

https://google.github.io/styleguide/cppguide.html

And uses clang-format, clang-tidy and cpplint.py automatically to check potential the code issues.

In order to take advantage of those tools, install the following dependencies:

# Ubuntu, Debian and derivatives:
$ sudo apt-get install clang clang-format clang-tidy python3

# Red Hat, Fedora, CentOS and derivatives:
$ sudo yum install clang clang-tools-extra python3

More information about cpplint.py:

https://google.github.io/styleguide/cppguide.html#cpplint

Development environment

You can use any text editor or IDE. But, if like me, you are using Visual Studio Code, here are some tips:

C/C++ Extension

Install this extension for language support:

https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools

CMake Tools

Install this extension for CMake integration:

https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools

EditorConfig Extension

Install this extension to override your preferences following the rules described in .editorconfig:

https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig

Code Spell Checker Extension

Install this extension to avoid typos:

https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker

Line Length

Google C++ Style Guide defines a limit of 80 characters:

https://google.github.io/styleguide/cppguide.html#Line_Length

In order to easily follow this rule, add the following configuration to your settings.json file by pressing "Control + Shift + P" and typing "Preferences: Open Settings (JSON)":

"[cpp]": {
    "editor.rulers": [
        80
    ]
}

Apply format on save

The best way to follow the code style rules is to let Visual Studio Code apply them for you. add the following configuration to your settings.json file by pressing "Control + Shift + P" and typing "Preferences: Open Settings (JSON)":

"editor.formatOnSave": true

Understanding the Code:

The entire code is documented with Doxygen. If want to see this documentation in HTML format execute the following commands:

$ cd documentation
$ doxygen doxyfile

The ./documentation/html/index.html file is a good place to start.

Touchégg makes intensive use of libinput, don't forget to check its documentation:

https://wayland.freedesktop.org/libinput/doc/latest/index.html

https://wayland.freedesktop.org/libinput/doc/latest/api/

Xlib and X11 standards are also heavily used to manipulate the user desktop and windows:

Xlib: https://tronche.com/gui/x/xlib/

ICCCM: https://www.x.org/releases/X11R7.6/doc/xorg-docs/specs/ICCCM/icccm.html

EWMH: https://specifications.freedesktop.org/wm-spec/wm-spec-1.3.html

Contact the developer:

If you want to report a bug or ask a question, you can do it in the official bug tracker:

https://github.com/JoseExposito/touchegg/issues

Happy coding!