[bug#37465] add xftwidth displayed textwidth calculator package

[bug#37465] add xftwidth displayed textwidth calculator package

[Kyle Andrews]

[-- Attachment #1: Type: text/plain, Size: 178 bytes --]

Hello,

I'd like to provide a package definition for the xftwidth calculator
utility so that it may be included into guix. Please see the attached
patch. 

Regards,

Kyle Andrews

[-- Attachment #2: 0001-gnu-Add-xftwidth.patch --]
[-- Type: text/x-patch, Size: 2248 bytes --]

From 60deaa526b4a6ca5a66f3b67ba77aa353409d542 Mon Sep 17 00:00:00 2001
From: Kyle Andrews <kyle.c.andrews@gmail.com>
Date: Thu, 19 Sep 2019 20:16:28 -0400
Subject: [PATCH] gnu: Add xftwidth.

* gnu/packages/wm.scm: added xftwidth package.
---
 gnu/packages/wm.scm | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/gnu/packages/wm.scm b/gnu/packages/wm.scm
index e19c6c1438..3e321eeb1c 100644
--- a/gnu/packages/wm.scm
+++ b/gnu/packages/wm.scm
@@ -209,6 +209,45 @@ or musca).
     (home-page "https://herbstluftwm.org")
     (license license:bsd-2)))
 
+(define-public xftwidth
+  (package
+    (name "xftwidth")
+    (version "20170402")
+    (source
+     (origin
+       (method git-fetch)
+       (uri (git-reference
+	     (url "https://github.com/vixus0/xftwidth")
+	     (commit "35ff963908d41a8a6a7101c434c88255728025ee")))
+       (sha256
+	(base32
+	 "1jwl25785li24kbp0m1wxfwk4dgxkliynn03nsj813cjr34kq16h"))
+       (file-name (string-append name "-" version "-checkout"))))
+    (build-system gnu-build-system)
+    (inputs `(("freetype"    ,freetype)
+              ("libx11"      ,libx11)
+              ("fontconfig"  ,fontconfig)
+              ("libxft"      ,libxft)))
+    (native-inputs
+     `(("pkg-config" ,pkg-config)))
+    (arguments
+     '(#:phases
+       (modify-phases %standard-phases
+         (add-after 'unpack 'fix-makefile ; /usr/bin doesn't show up in PATH
+           (lambda _ (substitute* "Makefile" (("usr/") "")) #t))
+         (delete 'check) ; no check included in Makefile
+         (delete 'configure))
+       #:make-flags
+       (let ((out (assoc-ref %outputs "out")))
+         (list (string-append "DESTDIR=" out)))))
+    (synopsis "Calculator for determining displayed text widths using Xft fonts.")
+    (description "A small C program to calculate pixel widths for displayed
+text using Xft fonts (given a specific font name and size). It is ideal for
+scripts including text into the custom (e.g. dzen and xmobar based) panels
+often used in conjunction with minimalistic window managers.")
+    (home-page "http://github.com/vixus0/xftwidth")
+    (license license:expat)))
+
 (define-public i3status
   (package
     (name "i3status")
-- 
2.23.0

[bug#37465] add xftwidth displayed textwidth calculator package

[Ludovic Courtès]

Hello Kyle,

Kyle Andrews <kyle.c.andrews@gmail.com> skribis:

> From 60deaa526b4a6ca5a66f3b67ba77aa353409d542 Mon Sep 17 00:00:00 2001
> From: Kyle Andrews <kyle.c.andrews@gmail.com>
> Date: Thu, 19 Sep 2019 20:16:28 -0400
> Subject: [PATCH] gnu: Add xftwidth.
>
> * gnu/packages/wm.scm: added xftwidth package.

I think this should rather go to xdisorg.scm, WDYT?

> +    (build-system gnu-build-system)
> +    (inputs `(("freetype"    ,freetype)
> +              ("libx11"      ,libx11)
> +              ("fontconfig"  ,fontconfig)
> +              ("libxft"      ,libxft)))

Nitpicking: we don’t usually align input tuples like that.  :-)

> +    (synopsis "Calculator for determining displayed text widths using Xft fonts.")
> +    (description "A small C program to calculate pixel widths for displayed
> +text using Xft fonts (given a specific font name and size). It is ideal for
> +scripts including text into the custom (e.g. dzen and xmobar based) panels
> +often used in conjunction with minimalistic window managers.")

Could you address the warnings reported by ‘guix lint’ here?  Also, make
sure to write full sentences in the description:

  https://guix.gnu.org/manual/en/html_node/Synopses-and-Descriptions.html

The rest LGTM!  Could you send an updated patch?

Thanks,
Ludo’.

[bug#37465] add xftwidth displayed textwidth calculator package

[Kyle Andrews]

[-- Attachment #1: Type: text/plain, Size: 1925 bytes --]

Hi Ludo,

On Wed, 2019-09-25 at 15:32 +0200, Ludovic Courtès wrote:
> Hello Kyle,
> 
> Kyle Andrews <kyle.c.andrews@gmail.com> skribis:
> 
> > From 60deaa526b4a6ca5a66f3b67ba77aa353409d542 Mon Sep 17 00:00:00
> > 2001
> > From: Kyle Andrews <kyle.c.andrews@gmail.com>
> > Date: Thu, 19 Sep 2019 20:16:28 -0400
> > Subject: [PATCH] gnu: Add xftwidth.
> > 
> > * gnu/packages/wm.scm: added xftwidth package.
> 
> I think this should rather go to xdisorg.scm, WDYT?

That makes sense to me. I have added fontutils as an additional module
dependency in xdisorg.scm to satisfy the inputs.

> > +    (build-system gnu-build-system)
> > +    (inputs `(("freetype"    ,freetype)
> > +              ("libx11"      ,libx11)
> > +              ("fontconfig"  ,fontconfig)
> > +              ("libxft"      ,libxft)))
> 
> Nitpicking: we don’t usually align input tuples like that.  :-)
> 

Okay. I've removed the alignment. However, note that the dzen package
in xdisorg.scm uses this same aligned format for it's inputs.

> > +    (synopsis "Calculator for determining displayed text widths
> > using Xft fonts.")
> > +    (description "A small C program to calculate pixel widths for
> > displayed
> > +text using Xft fonts (given a specific font name and size). It is
> > ideal for
> > +scripts including text into the custom (e.g. dzen and xmobar
> > based) panels
> > +often used in conjunction with minimalistic window managers.")
> 
> Could you address the warnings reported by ‘guix lint’ here?  Also,
> make
> sure to write full sentences in the description:
> 
>   https://guix.gnu.org/manual/en/html_node/Synopses-and-Descriptions.
> html
> The rest LGTM!  Could you send an updated patch?
> 
> Thanks,
> Ludo’.

I've fixed the notes I saw from guix lint:

1. https -> http for github urls
2. Removed period from synopsis
3. Rewrote the description using full sentences

Please see the attached patch.

Regards,
Kyle

[-- Attachment #2: 0001-gnu-Add-xftwidth.patch --]
[-- Type: text/x-patch, Size: 2983 bytes --]

From 1c23edb9bdd7a7678636c97ad256995dc31c22d2 Mon Sep 17 00:00:00 2001
From: Kyle Andrews <kyle.c.andrews@gmail.com>
Date: Sun, 29 Sep 2019 10:06:49 -0400
Subject: [PATCH] gnu: Add xftwidth.

* gnu/packages/xdisorg.scm: added xftwidth package.
---
 gnu/packages/xdisorg.scm | 42 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/gnu/packages/xdisorg.scm b/gnu/packages/xdisorg.scm
index 0b40ca6909..79e0f617fd 100644
--- a/gnu/packages/xdisorg.scm
+++ b/gnu/packages/xdisorg.scm
@@ -26,6 +26,7 @@
 ;;; Copyright © 2018, 2019 Pierre Neidhardt <mail@ambrevar.xyz>
 ;;; Copyright © 2018 Nam Nguyen <namn@berkeley.edu>
 ;;; Copyright © 2019 Wiktor Żelazny <wzelazny@vurv.cz>
+;;; Copyright © 2019 Kyle Andrews <kyle.c.andrews@gmail.com>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -83,6 +84,7 @@
   #:use-module (gnu packages xml)
   #:use-module (gnu packages gtk)
   #:use-module (gnu packages xorg)
+  #:use-module (gnu packages fontutils)
   #:use-module (gnu packages bison)
   #:use-module (ice-9 match))
 
@@ -1322,6 +1324,46 @@ program for X11.  It was designed to be fast, tiny and scriptable in any languag
      (home-page "https://github.com/robm/dzen")
      (license license:expat))))
 
+(define-public xftwidth
+  (package
+    (name "xftwidth")
+    (version "20170402")
+    (source
+     (origin
+       (method git-fetch)
+       (uri (git-reference
+	     (url "http://github.com/vixus0/xftwidth")
+	     (commit "35ff963908d41a8a6a7101c434c88255728025ee")))
+       (sha256
+	(base32
+	 "1jwl25785li24kbp0m1wxfwk4dgxkliynn03nsj813cjr34kq16h"))
+       (file-name (string-append name "-" version "-checkout"))))
+    (build-system gnu-build-system)
+    (inputs `(("freetype" ,freetype)
+              ("libx11" ,libx11)
+              ("fontconfig" ,fontconfig)
+              ("libxft" ,libxft)))
+    (native-inputs
+     `(("pkg-config" ,pkg-config)))
+    (arguments
+     '(#:phases
+       (modify-phases %standard-phases
+         (add-after 'unpack 'fix-makefile ; /usr/bin doesn't show up in PATH
+           (lambda _ (substitute* "Makefile" (("usr/") "")) #t))
+         (delete 'check) ; no check included in Makefile
+         (delete 'configure))
+       #:make-flags
+       (let ((out (assoc-ref %outputs "out")))
+         (list (string-append "DESTDIR=" out)))))
+    (synopsis "Calculator for determining pixel widths of displayed text using Xft fonts")
+    (description "xftwidth is a small C program for calculating the pixel
+widths of displayed text using Xft fonts. It is especially useful in scripts
+for displaying text in graphical panels, menus, popups, and notification
+windows generated using dzen. These scripts are often used in conjunction with
+minimalistic tiling window managers such as herbstluftwm and bspwm.")
+    (home-page "http://github.com/vixus0/xftwidth")
+    (license license:expat)))
+
 (define-public xcb-util-xrm
   (package
     (name "xcb-util-xrm")
-- 
2.23.0

[bug#37465] add xftwidth displayed textwidth calculator package

[Tobias Geerinckx-Rice via Guix-patches via]

[-- Attachment #1: Type: text/plain, Size: 845 bytes --]

Kyle,

Thanks for the patch.

Kyle Andrews 写道：
> I've fixed the notes I saw from guix lint:
>
> 1. https -> http for github urls

I thought this was just a typo, but the patch agrees.  Our linter 
doesn't recommend HTTP over HTTPS for GitHub (or indeed any) URLs. 
In fact, it should now warn about a

  gnu/packages/xftwidth@20170402: permanent redirect from
  http://github.com/vixus0/xftwidth to
  https://github.com/vixus0/xftwidth

Also, the GNU/Guix style is to…
- never use tabs for indentation, only spaces.
- use two spaces between prose sentences: ‘…Xft fonts.  It is…’.
                                                      ^^
The linter should have warned you about both of these, too.

It sounds like yours is behaving quite strangely.  What, exactly, 
did it say?

Kind regards,

T G-R

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

bug#37465: add xftwidth displayed textwidth calculator package

[Ludovic Courtès]

Hi Kyle,

Kyle Andrews <kyle.c.andrews@gmail.com> skribis:

> I've fixed the notes I saw from guix lint:
>
> 1. https -> http for github urls
> 2. Removed period from synopsis
> 3. Rewrote the description using full sentences

I fixed a these additional warnings reported by ‘guix lint’ and
committed:

--8<---------------cut here---------------start------------->8---
gnu/packages/xdisorg.scm:1359:17: xftwidth@20170402: sentences in description should be followed by two spaces; possible infractions at 96, 234
/home/ludo/src/guix/gnu/packages/xdisorg.scm:1335:0: xftwidth@20170402: tabulation on line 1335, column 0
/home/ludo/src/guix/gnu/packages/xdisorg.scm:1336:0: xftwidth@20170402: tabulation on line 1336, column 0
/home/ludo/src/guix/gnu/packages/xdisorg.scm:1338:0: xftwidth@20170402: tabulation on line 1338, column 0
/home/ludo/src/guix/gnu/packages/xdisorg.scm:1339:0: xftwidth@20170402: tabulation on line 1339, column 0
gnu/packages/xdisorg.scm:1364:15: xftwidth@20170402: permanent redirect from http://github.com/vixus0/xftwidth to https://github.com/vixus0/xftwidth
--8<---------------cut here---------------end--------------->8---

Thanks!

Ludo’.