Implement "title_format" #1747

Airblader · 2015-06-10T17:20:36Z

I verified that not using a pango font doesn't mistakenly escape the window title. I do strongly suggest we get at least someone else (@acrisci, @ambihelical being canonical candidates) to play around with this first.

One open question for me is if we need to handle other characters when escaping pango markup. The glib implementation seems to do something (see my comment in #1723 where I pasted their implementation), but I don't really understand what's happening there, so input is much appreciated.

Here are some quick screenshots:

fixes #1723

Airblader · 2015-06-10T17:42:08Z

I completely forgot the documentation. Will add that, of course. :)

acrisci · 2015-06-10T21:21:54Z

I think you should just use the glib implementation.

Airblader · 2015-06-11T03:42:09Z

You mean just blindly use their logic? I'm not so much a fan of committing code I don't understand.

acrisci · 2015-06-11T03:46:51Z

I think you just made the case against using any libraries at all.

The truth is that nobody understands how computers work.

Airblader · 2015-06-11T03:48:04Z

But this isn't a library, this is own code that we need to maintain, so we should understand it. Or did you mean pulling in glib as a dependency?

acrisci · 2015-06-11T03:50:43Z

We get glib for free with pango.

Airblader · 2015-06-11T03:52:59Z

Oh okay. Then it's definitely better than reimplementing this. I'll change it.

Airblader · 2015-06-11T05:02:01Z

The documentation for g_markup_escape_text contains the explanation, by the way:

Note also that this function will produce character references in
the range of � ... � for all control sequences
except for tabstop, newline and carriage return. The character
references in this range are not valid XML 1.0, but they are
valid XML 1.1 and will be accepted by the GMarkup parser.

Airblader · 2015-06-11T05:26:24Z

OK, I've switched to the glib implementation and added the documentation.

ambihelical · 2015-06-11T16:11:56Z

Nice! I'll try to give it a go this weekend. I still think having some kind of left/right/center region would be useful, and the size balancing not as hard to handle as you have implied. Having the ability to change the appearance of the mark as shown on your window would be one benefit.

Airblader · 2015-06-11T16:17:54Z

Yeah, I did come around and think alignment options are a superior solution, though we should still define clear behavior about the balancing part upfront. This PR is just the first version of this feature (iterative process), see #1750 for the followup.

teto · 2015-06-11T17:23:05Z

First of all thanks for working on this and for all the rest of your work. I've tried the examples given in your doc and I succeed in adding a prefix in front of my title with your binding.
But when doing this:
for_window [class="(?i)firefox"] title_format "<span foreground='red'>%title</span>", "%title" is replaced but the is not interpreted and is printed as is. So the firefox title becomes:
"My tab title"
I believe this is a fantastic feature and I am looking forward to the hacks it will create thanks to the IPC, like rainbow tabs :D

Airblader · 2015-06-11T17:42:48Z

Thanks for the feedback!

but the <span> is not interpreted and is printed as is.

Could you maybe take a screenshot? It works fine for me. Also, can you upload your config somewhere? Finally, please post your reply in the issue, it probably shouldn't be in the PR. Thanks!

like rainbow tabs

I already found myself wanting to play with animations ;)

ambihelical · 2015-06-14T05:47:36Z

Feedback; it seems to be working pretty well for me. I tried @teto's example as well and could not reproduce the issue he was having.

One issue I found, with large fonts (size='xx-large') and stacked windows, the text is drawn partially outside of the window title area onto the title area of the window above.

Airblader · 2015-06-14T07:19:27Z

Thanks for the feedback. I think the issue you mentioned is not something we can reasonably fix.

teto · 2015-06-14T13:05:33Z

I was surprised by the 4.8 so I rechecked the PR and my git log on the pulled PR is:

634bdcf Added documentation for "title_format".
f177929 Parse the title_format and display the customized window title if a format was set. The format string set with "title_format" 
249af33 Implemented a helper function to escape a string for pango markup.
08d7f23 Added a helper function to decide whether the currently saved font is a pango font.
68cf77d Added command directive 'title_format'. This directive will be used to customize the window title.
1d4b586 Merge pull request #1737 from Airblader/feature-xdotool-on-travis
f262445 Install xdotool to run tests requiring it on Travis.
7b8745f Merge pull request #1735 from shdown/strdup
fe006f0 i3bar: fix freeing static strings
6b505d8 Merge pull request #1733 from Airblader/feature-1732

and
i3 version 4.10.2-193-g634bdcf (2015-06-11, branch "feature-1723") © 2009 Michael Stapelberg and contributors
Are those ok ? because I still have the same problem. If it works for you two I guess it's on my side. In worst case I will wait for a merge but I would be curious to know what's wrong.

Airblader · 2015-06-14T13:08:28Z

@teto I just checked your config. You're not using a pango font, but rather xft. Of course pango markup cannot work in this case. :)

teto · 2015-06-14T13:43:57Z

Thanks !! I had no idea what a pango font was (even though you speak of it in yourt first post, shame on me). Now it works as intended ! Once again thanks for your many contributions on i3.

Airblader · 2015-06-14T13:45:20Z

Great. Thanks for testing this and the feedback.
@stapelberg I think we have enough feedback now.

acrisci · 2015-06-15T02:48:12Z

docs/userguide

+=== Window title format
+
+By default, i3 will simply print the window's title. Using +title_format+, this can be customized
+by setting the format to the desired output. This directive supports pango markup and the following


This should link to pango markup.

Airblader · 2015-06-15T04:54:05Z

@acrisci Done

stapelberg · 2015-06-18T07:28:15Z

src/x.c

+    int buffer_len = strlen(format) + 1;
+    for (char *walk = format; *walk != '\0'; walk++) {
+        if (STARTS_WITH(walk, "%title")) {
+            buffer_len += strlen(escaped_title);


I think this should be buffer_len = buffer_len - strlen("%title") + strlen(escaped_title), shouldn’t it?

stapelberg · 2015-06-18T07:31:47Z

Can you please squash the two commits that deal with the escaping function? I.e., I don’t like to have the commit in the history which adds code that is never used and replaced a commit later :).

Airblader · 2015-06-18T17:41:12Z

I forgot one comment…

Airblader · 2015-06-18T17:43:44Z

@stapelberg Adressed the last comment now, too.

stapelberg · 2015-06-29T06:57:46Z

docs/userguide

+bindsym $mod+p title_format "Important | %title"
+
+# print all window titles bold
+for_window [class="^.*"] title_format "<b>%title</b>"


nit: the shortest way to match all windows is for_window [class="."], but I can see how .* might be more familiar, i.e. people might more easily recognize that as a regular expression. The current form of ^.* I don’t quite understand — why the anchoring in the beginning? It doesn’t seem to have any purpose, so please remove it.

stapelberg · 2015-06-29T07:00:59Z

docs/userguide

@@ -2048,6 +2050,35 @@ Alternatively, if you do not want to mess with +i3-input+, you could create
 seperate bindings for a specific set of labels and then only use those labels.
 ///////////////////////////////////////////////////////////////////

+=== Window title format
+
+By default, i3 will simply print the window's title. Using +title_format+, this can be customized


I think it might be good to mention that the application defines the title. In the criteria section of the userguide, we use this terminology:

title
Compares the X11 window title (_NET_WM_NAME or WM_NAME as fallback).

So, I think changing “window's title” to “X11 window title” here would be good for consistency.

This directive will be used to customize the window title.

…ormat was set. The format string set with "title_format" can contain the placeholder "%title" which will be replaced with the actual window title. By not overwriting window->name itself, we make sure that assignment matching still works as expected. fixes i3#1723

Airblader · 2015-06-29T07:13:51Z

@stapelberg Done.

stapelberg · 2015-06-29T07:16:49Z

docs/userguide

+and the following placeholders which will be replaced:
+
+%title+::
+    The X11 window title.


This should read “The X11 window title (_NET_WM_NAME or WM_NAME as fallback).”.

Airblader · 2015-06-29T07:20:28Z

@stapelberg But now, hopefully. :)

Implement "title_format"

Airblader force-pushed the feature-1723 branch from 37ef19f to f177929 Compare June 11, 2015 05:10

Airblader force-pushed the feature-1723 branch from 034cd73 to 634bdcf Compare June 11, 2015 05:29

acrisci reviewed Jun 15, 2015
View reviewed changes

Airblader force-pushed the feature-1723 branch from 634bdcf to da0bada Compare June 15, 2015 04:53

stapelberg reviewed Jun 18, 2015
View reviewed changes

stapelberg added the waiting Waiting for feedback/changes from the author of the issue/PR. Make sure to notify us with a comment. label Jun 18, 2015

Airblader force-pushed the feature-1723 branch from da0bada to bf920d1 Compare June 18, 2015 15:09

Airblader added the waiting Waiting for feedback/changes from the author of the issue/PR. Make sure to notify us with a comment. label Jun 18, 2015

Airblader force-pushed the feature-1723 branch from 9f53ca8 to 61b7077 Compare June 18, 2015 17:43

Airblader removed the waiting Waiting for feedback/changes from the author of the issue/PR. Make sure to notify us with a comment. label Jun 18, 2015

stapelberg reviewed Jun 29, 2015
View reviewed changes

Airblader force-pushed the feature-1723 branch from 61b7077 to f692a6f Compare June 29, 2015 07:00

stapelberg reviewed Jun 29, 2015
View reviewed changes

stapelberg added the waiting Waiting for feedback/changes from the author of the issue/PR. Make sure to notify us with a comment. label Jun 29, 2015

Airblader added 2 commits June 29, 2015 09:13

Added command directive 'title_format'.

55e8d06

This directive will be used to customize the window title.

Airblader force-pushed the feature-1723 branch from f692a6f to 03a2d40 Compare June 29, 2015 07:13

Airblader removed the waiting Waiting for feedback/changes from the author of the issue/PR. Make sure to notify us with a comment. label Jun 29, 2015

stapelberg reviewed Jun 29, 2015
View reviewed changes

stapelberg added the waiting Waiting for feedback/changes from the author of the issue/PR. Make sure to notify us with a comment. label Jun 29, 2015

Added documentation for "title_format".

cf11fb5

Airblader force-pushed the feature-1723 branch from 03a2d40 to cf11fb5 Compare June 29, 2015 07:19

Airblader removed the waiting Waiting for feedback/changes from the author of the issue/PR. Make sure to notify us with a comment. label Jun 29, 2015

stapelberg added a commit that referenced this pull request Jun 29, 2015

Merge pull request #1747 from Airblader/feature-1723

8df7e4e

Implement "title_format"

stapelberg merged commit 8df7e4e into i3:next Jun 29, 2015

Airblader added the merged-before-4.13 label Nov 13, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement "title_format" #1747

Implement "title_format" #1747

Airblader commented Jun 10, 2015

Airblader commented Jun 10, 2015

acrisci commented Jun 10, 2015

Airblader commented Jun 11, 2015

acrisci commented Jun 11, 2015

Airblader commented Jun 11, 2015

acrisci commented Jun 11, 2015

Airblader commented Jun 11, 2015

Airblader commented Jun 11, 2015

Airblader commented Jun 11, 2015

ambihelical commented Jun 11, 2015

Airblader commented Jun 11, 2015

teto commented Jun 11, 2015

Airblader commented Jun 11, 2015

ambihelical commented Jun 14, 2015

Airblader commented Jun 14, 2015

teto commented Jun 14, 2015

Airblader commented Jun 14, 2015

teto commented Jun 14, 2015

Airblader commented Jun 14, 2015

acrisci Jun 15, 2015

Airblader commented Jun 15, 2015

stapelberg Jun 18, 2015

stapelberg commented Jun 18, 2015

Airblader commented Jun 18, 2015

Airblader commented Jun 18, 2015

stapelberg Jun 29, 2015

stapelberg Jun 29, 2015

Airblader commented Jun 29, 2015

stapelberg Jun 29, 2015

Airblader commented Jun 29, 2015

Implement "title_format" #1747

Implement "title_format" #1747

Conversation

Airblader commented Jun 10, 2015

Airblader commented Jun 10, 2015

acrisci commented Jun 10, 2015

Airblader commented Jun 11, 2015

acrisci commented Jun 11, 2015

Airblader commented Jun 11, 2015

acrisci commented Jun 11, 2015

Airblader commented Jun 11, 2015

Airblader commented Jun 11, 2015

Airblader commented Jun 11, 2015

ambihelical commented Jun 11, 2015

Airblader commented Jun 11, 2015

teto commented Jun 11, 2015

Airblader commented Jun 11, 2015

ambihelical commented Jun 14, 2015

Airblader commented Jun 14, 2015

teto commented Jun 14, 2015

Airblader commented Jun 14, 2015

teto commented Jun 14, 2015

Airblader commented Jun 14, 2015

acrisci Jun 15, 2015

Choose a reason for hiding this comment

Airblader commented Jun 15, 2015

stapelberg Jun 18, 2015

Choose a reason for hiding this comment

stapelberg commented Jun 18, 2015

Airblader commented Jun 18, 2015

Airblader commented Jun 18, 2015

stapelberg Jun 29, 2015

Choose a reason for hiding this comment

stapelberg Jun 29, 2015

Choose a reason for hiding this comment

Airblader commented Jun 29, 2015

stapelberg Jun 29, 2015

Choose a reason for hiding this comment

Airblader commented Jun 29, 2015