56e24992df
This is the next step to merge #1237 in stages. Currently there are barely any restrictions on how the config can be written. This causes things like config files with DOS line endings to not be parsed properly (#1366) because polybar splits by `\n` and when parsing section headers, it can't deal with the `\r` at the end of the line and thus doesn't recognize any section headers. With this PR we introduce some rules as to what characters are allowed in section names and keys. Note: When talking about spaces I refer to any character for which `isspace()` returns `true`. The rules are as follows: * A section name or a key name cannot contain any spaces as well as any of there characters:`"'=;#[](){}:.$\%` * Spaces at the beginning and end of lines are always ignored when parsing * Comment lines start with `;` or `#` and last for the whole line. The whole line will be ignored by the parser. You cannot start a comment at the end of a line. * Section headers have the following form `[HEADER_NAME]` * Key-value lines look like this: `KEY_NAME{SPACES}={SPACES}VALUE_STRING` where `{SPACES}` represents any number of spaces. `VALUE_STRING` can contain any characters. If it is *surrounded* with double quotes (`"`), those quotes will be removed, this can be used to add spaces to the beginning or end of the value * Empty lines are lines with only spaces in them * If the line has any other form, it is a syntax error This will introduce the following breaking changes because of how underdefined the config syntax was before: * `key = ""` will get treated as an empty string instead of the literal * string `""` * Any section or key name with forbidden characters will now be syntax errors. * Certain strings will be forbidden as section names: `self`, `root`, * `BAR`. Because they have a special meaning inside references and so a * section `[root]` can never be referenced. This replaces the current parser implementation with a new more robust one that will later be expanded to also check for dependency cycles and allow for values that contain references mixed with other strings. This PR also now expands the config paths given over the command line so that `--config=~/.config/polybar/config` resolves properly. Closes #1032 Closes #1694 * config_parser: Add skeleton with tests First step in the config_parser develoment. Only tests functions that are easily testable without many outside dependencies. Integration tests will follow. * config_parser: Implement parse_header * config_parser: Implement get_line_type * feat(string): Add trim functions with predicate Not only trimming based on single character matching but based on a freely specifiable predicate. Will be used to trim all spaces (based on isspace) * config_parser: Implement parse_key * config_parser: Implement parse_line for valid lines * config_parser: Throw exception on invalid lines * config_parser: Remove line_no and file_index from parse_line Cleaner to let the caller catch and fill in the line number and file path * string: Clear up misleading description of trim Before, trim would remove all characters that *didn't* match the predicate and thus the predicate isspace wouldn't work correctly. But because we used the inverse (isnospace_pred) it all worked out, but if the function was used with any other function, it wouldn't have given the desired output * config_parser: Implement parse_file * config_parser: Switch operation to config_parser This changes the way the config is invoked. Now main.cpp creates a config_parser object which then returns the singleton config object from the parse method. Subsequent calls to config::make will return the already created config object as before The config_parser does not yet have all the functionality of the old parser: `inherit` directives are not yet resolved. Other than that all the old functionality is implemented (creating sectionmap and applying include-file) Any sort of dependency detection (except for include-file) are still missing * config: Move xrm initialization to constructor config_parser handles the detection of xrdb references and passes that info to the config object. This finally allows us to delete the config::parse_file function because everything in it has been implemented (except for xrdb detection and file error handling) * refactor(config_parser): Cleanup * config_parser: Set config data after initialization Looks much cleaner this way * config_parser: Expand include-file paths * config_parser: Init xrm if the config uses %{xrdb references * config_parser: Use same type of maps as in old impl Polybar has some weird, not yet fixed, inheriting behaviour and it changes depending on the order in which the config stores its data. Using the same type of maps ensures that the behaviour stays the same. * refactor(config_parser): Clearer invalid name error message * config_parser: Don't allow reserved section names Sections with the names 'self', 'BAR', 'root' could never be referenced because those strings have a special meaning inside references * config_parser: Handle inherit directives This uses the old copy_inherited function, so this still suffers from crashes if there are cyclic dependencies. This also fixes the behaviour where any key that starts with 'inherit' would be treated as an inherit directive * config_parser: Clearer dependency cycle error message * refactor(config_parser): Handle file errors when parsing This removes the need to check if the file exists separately * fix(config): expand config file path Now paths using ~ and environment variables can be used as the config path * fix(config): Properly recognize xrdb references * config_parser: Make messages more informative * doc(config): Improve commenting Comments now describe what the config_parser actually does instead of what it will do. We also now follow the rule that single line comments inside functions should use `//` comments * refactor: Move else on same line as curly braces * fix(config_parser): Don't duplicate paths in `files` * refactor(config_parser): Use else if for clarity * fix(config): Undefined behavior in syntax_error Before the custom what() method produced undefined behavior because the returned string became invalid once the function returned. * refactor(config): descriptive name for useless lines is_valid could easily be confused as meaning syntactically invalid without it being clarified in a comment * refactor(config): Use separate strings instead of key_value Takes just as much space and is much better to read * fix(config_parser): TestCase -> TestSuite and fix macro call Ref: #1644 * config_parser: use const string& in method args * config_parser: Improve comments * config_parser: Incorporate review comments |
||
|---|---|---|
| .github/ISSUE_TEMPLATE | ||
| cmake | ||
| common | ||
| contrib | ||
| doc | ||
| include | ||
| lib | ||
| src | ||
| tests | ||
| .clang-format | ||
| .clang-tidy | ||
| .codecov.yml | ||
| .editorconfig | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| .valgrind-suppressions | ||
| .ycm_extra_conf.py | ||
| banner.png | ||
| build.sh | ||
| CMakeLists.txt | ||
| config.cmake | ||
| LICENSE | ||
| README.md | ||
| SUPPORT.md | ||
| version.txt | ||
A fast and easy-to-use tool for creating status bars.
Polybar aims to help users build beautiful and highly customizable status bars for their desktop environment, without the need of having a black belt in shell scripting. Here are a few screenshots showing you what it can look like:
You can find polybar configs for these example images (and other configs) here.
If you need help, check out the Support page.
Please report any bugs you find by creating an issue ticket here on GitHub. Make sure you include steps on how to reproduce it.
Table of Contents
Introduction
The main purpose of Polybar is to help users create awesome status bars. It has built-in functionality to display information about the most commonly used services. Some of the services included so far:
- Systray icons
- Window title
- Playback controls and status display for MPD using libmpdclient
- ALSA volume controls
- Workspace and desktop panel for bspwm and i3
- Workspace module for EWMH compliant window managers
- Keyboard layout and indicator status
- CPU and memory load indicator
- Battery display
- Network connection details
- Backlight level
- Date and time label
- Time-based shell script execution
- Command output tailing
- User-defined menu tree
- Inter-process messaging
- And more...
See the wiki for more details.
Getting Help
If you find yourself stuck, have a look at our Support page for resources where you can find help.
Getting started
Polybar was already packaged for the distros listed below. If you can't find your distro here, you will have to build from source.
If you create a package for any other distribution, please consider contributing the template.
If you are using Arch Linux, you can install the AUR package polybar-git to get the latest version, or polybar for the latest stable release.
If you are using Void Linux, you can install polybar using xbps-install -S polybar.
If you are using NixOS, polybar is available in both the stable and unstable channels and can be installed with the command nix-env -iA nixos.polybar.
If you are using Slackware, polybar is available from the SlackBuilds repository.
If you are using Source Mage GNU/Linux, polybar spell is available in test grimoire and can be installed via cast polybar.
If you are using openSUSE, polybar is available from OBS repository. Package is available for openSUSE Leap 15 and Tumbleweed.
If you are using FreeBSD, polybar can be installed using pkg install polybar. Make sure you are using the latest package branch.
If you are using Gentoo, both release and git-master versions are available in the main repository.
Dependencies
A compiler with C++14 support (clang-3.4+, gcc-5.1+), cmake 3.1+, git
cairolibxcbpython2xcb-protoxcb-util-imagexcb-util-wm
Optional dependencies:
xcb-util-cursorrequired for thecursor-clickandcursor-scrollsettingsxcb-util-xrmrequired for accessing X resources with${xrdb:...}
Optional dependencies for extended module support:
xcb-xkbrequired byinternal/xkeyboardalsa-librequired byinternal/alsalibpulserequired byinternal/pulseaudioi3-wmrequired byinternal/i3jsoncpprequired byinternal/i3libmpdclientrequired byinternal/mpdlibcurlrequired byinternal/githublibnl-genlorwireless_toolsrequired byinternal/network
Find a more complete list on the dedicated wiki page.
Building from source
Please report any problems you run into when building the project.
Download the polybar-<version>.tar for the version you want to build from the
release page, extract it with
tar xvf polybar-<version>.tar and go into the extracted folder. There, run
the following commands:
$ mkdir build
$ cd build
$ cmake ..
$ make -j$(nproc)
$ sudo make install
There's also a helper script available in the root folder:
$ ./build.sh
For more info, have a look at the Compiling wiki page.
Configuration
Details on how to setup and configure the bar and each module have been moved to the wiki.
Install the example configuration
Run the following inside the build directory:
$ make userconfig
Or you can copy the example config from /usr/share/doc/polybar/config or /usr/local/share/doc/polybar/config (depending on your install parameters)
Launch the example bar
$ polybar example
Running
See the wiki for details on how to run polybar.
Community
Want to get in touch?
- We have our own subreddit at r/polybar.
- Chat with us in the
#polybarIRC channel on thechat.freenode.netserver.
Contributors
Owner
- Michael Carlberg @jaagr
Maintainers
- @NBonaparte
- Chase Geigle @skystrife
- Patrick Ziegler @patrick96
Logo Design by
All Contributors
License
Polybar is licensed under the MIT license. See LICENSE for more information.