pgrondek/polybar-dwm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
4ded401aab
polybar-dwm/CHANGELOG.md
Filip Banák 4ded401aab
Add initial support for an escape character (#2361) 
Add a config parser method which, for now, deals only with escaping the
literal backslash character and logs an error message to inform the user
of the coming change.

The error message includes a properly escaped value for the user.

As a result of introducing an escape character('\'):

  - Warn the user of any unescaped backslashes, as they will not be
    treated as a literal character in the future

  - For now, still treat a single backslash as a literal character

  - Treat two consecutive backslashes as a single properly escaped
    literal backslash

Also:
  - Add documentation about the escape character to polybar(5) manpage
  - Add info about the escape character to changelog
  - Add testcases for ParseLineKeyTest
  - Add new test ParseEscapedValueTest

Resolves: First step in #2354

Improve value parsing

 - Take value arg in as an rvalue reference and move parsed value back
 - Remove unnecessary if statement
 - Rename function
 - Improve error message
 - Improve function description
 - Format

Add escape character documentation to manpages

Add information about the escape character to the polybar(5) manpage.

Add info about the esacape character to changelog

Add test cases for ParseLineKeyTest

Fix ParseLineKeyTest test cases

Also make config parser method parse_escaped_value private.

Add tests for escaped_value_parser method

Also remove unsued include statement

Simplify parse_escaped_value in config_parser

Remove unnecessary escaped value generation, so we do not have to keep
track of index differences.

Fix ParseEscapedValueTest test cases

Fix parse_escaped_value

Add more test cases for ParseLineKeyTest

Update CHANGELOG.md

Co-authored-by: Patrick Ziegler <p.ziegler96@gmail.com>

Adress review

 - Adjust documentation
 - Small code changes

Improve parse_escaped_value

Add initial support for an escape character

Add a config parser method which, for now, deals only with escaping the
literal backslash character and logs an error message to inform the user
of the coming change.

The error message includes a properly escaped value for the user.

As a result of introducing an escape character('\'):

 - Warn the user of any unescaped backslashes, as they will not be
   treated as a literal character in the future

 - For now, still treat a single backslash as a literal character

 - Treat two consecutive backslashes as a single properly escaped
   literal backslash

Resolves: First step in #2354

Improve value parsing

 - Take value arg in as an rvalue reference and move parsed value back
 - Remove unnecessary if statement
 - Rename function
 - Improve error message
 - Improve function description
 - Format

Add info about the esacape character to changelog

Add test cases for ParseLineKeyTest

Fix ParseLineKeyTest test cases

Also make config parser method parse_escaped_value private.

Add tests for escaped_value_parser method

Also remove unsued include statement

Simplify parse_escaped_value in config_parser

Remove unnecessary escaped value generation, so we do not have to keep
track of index differences.

Fix ParseEscapedValueTest test cases

Add more test cases for ParseLineKeyTest

Adress review

 - Adjust documentation
 - Small code changes

Remove duplicate testcase from ParseLineKeyTest

Add initial support for an escape character

Add a config parser method which, for now, deals only with escaping the
literal backslash character and logs an error message to inform the user
of the coming change.

The error message includes a properly escaped value for the user.

As a result of introducing an escape character('\'):

 - Warn the user of any unescaped backslashes, as they will not be
   treated as a literal character in the future

 - For now, still treat a single backslash as a literal character

 - Treat two consecutive backslashes as a single properly escaped
   literal backslash

Resolves: First step in #2354

Improve value parsing

 - Take value arg in as an rvalue reference and move parsed value back
 - Remove unnecessary if statement
 - Rename function
 - Improve error message
 - Improve function description
 - Format

Fix ParseLineKeyTest test cases

Also make config parser method parse_escaped_value private.

Remove duplicate testcase from ParseLineKeyTest
2021-01-26 19:16:29 +01:00

6.1 KiB
Raw Blame History

Changelog

All notable changes to this project will be documented in this file. Each release should have the following subsections, if entries exist, in the given order: Breaking, Build, Deprecated, Removed, Added, Changed, Fixed, Security.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Breaking

  • We added the backslash escape character (\) for configuration values. This means that the literal backslash character now has special meaning in configuration files, therefore if you want to use it in a value as a literal backslash, you need to escape it with the backslash escape character. The parser logs an error if any unescaped backslashes are found in a value. This affects you only if you are using two consecutive backslashes in a value, which will now be interpreted as a single literal backslash. #2354
  • We rewrote our tag parser. This shouldn't break anything, if you experience any problems, please let us know. The new parser now gives errors for certain invalid tags where the old parser would just silently ignore them. Adding extra text to the end of a valid tag now produces an error. For example, tags like %{T-a}, %{T2abc}, %{rfoo}, and others will now start producing errors. This does not affect you unless you are producing your own formatting tags (for example in a script) and you are using one of these invalid tags.

Build

  • Bump the minimum cmake version to 3.5
  • The BUILD_IPC_MSG option has been renamed to BUILD_POLYBAR_MSG
  • Building the documentation is now enabled by default and not just when sphinx-build is found.
  • Users can control exactly which targets should be available with the following cmake options (together with their default value):
    • BUILD_POLYBAR=ON - Builds the polybar executable
    • BUILD_POLYBAR_MSG=ON - Builds the polybar-msg executable
    • BUILD_TESTS=OFF - Builds the test suite
    • BUILD_DOC=ON - Builds the documentation
    • BUILD_DOC_HTML=BUILD_DOC - Builds the html documentation (depends on BUILD_DOC)
    • BUILD_DOC_MAN=BUILD_DOC - Builds the manpages (depends on BUILD_DOC)
    • BUILD_CONFIG=ON - Generates sample config
    • BUILD_SHELL=ON - Generates shell completion files
    • DISABLE_ALL=OFF - Disables all above targets by default. Individual targets can still be enabled explicitly.
  • The documentation can no longer be built by directly configuring the doc directory.
  • The sample config file is now placed in the generated-sources folder inside whatever folder you invoked cmake from instead of in the root folder of the repository.

Added

  • The backslash escape character (\). #2354
  • Warn states for the cpu, memory, fs, and battery modules. (#570, #956, #1871, #2141)
    • internal/battery: format-low, label-low, animation-low, low-at = 10.
    • internal/cpu: format-warn, label-warn, warn-percentage = 80
    • internal/fs: format-warn, label-warn, warn-percentage = 90
    • internal/memory: format-warn, label-warn, warn-percentage = 90
  • Per-corner corner radius with radius-{bottom,top}-{left,right} (#2294)
  • internal/network: speed-unit = B/s can be used to customize how network speeds are displayed.
  • internal/xkeyboard: %variant% can be used to parse the layout variant (#316)
  • Added .ini extension check to the default config search. (#2323)
  • IPC commands to change visibility of modules (hide.<name>, show.<name>, and toggle.<name>) (#2108)
  • Config option to hide a certain module (hidden = false) (#2108)
  • internal/xworkspaces: Make the urgent hint persistent (#1081)
  • internal/network: interface-type may be used in place of interface to automatically select a network interface (#2025)
  • internal/xworkspaces: %nwin% can be used to display the number of open windows per workspace (#604)

Changed

  • Slight changes to the value ranges the different ramp levels are responsible for in the cpu, memory, fs, and battery modules. The first and last level are only used for everything at or below and at and above the edges of the value range, respectively. The other levels are evenly distributed over the value range as before.
  • custom/script: interval now defaults to 0 if tail = true as per the documentation.
  • internal/network:
    • Increased precision for upload and download speeds: 0 decimal places for KB/s (as before), 1 for MB/s and 2 for GB/s.

Fixed

  • Trailing space after the layout label when indicators are empty and made sure right amount of spacing is added between the indicator labels, in the xkeyboard module. (#2292)
  • Parser error if click command contained } (#2040)

3.5.4 - 2021-01-07

Fixed

  • Wrong text displayed if module text ends with } (#2331)

3.5.3 - 2020-12-23

Build

  • Don't use git when building documentation (#2309)

Fixed

  • Empty color values are no longer treated as invalid and no longer produce an error.