From: Eli Zaretskii <eliz@gnu.org>
To: "Mattias Engdegård" <mattiase@acm.org>
Cc: pipcet@gmail.com, emacs-devel@gnu.org
Subject: Re: master 64e25cd: More robust NS hex colour string parsing
Date: Sat, 13 Jun 2020 21:40:13 +0300 [thread overview]
Message-ID: <83r1ui3j3m.fsf@gnu.org> (raw)
In-Reply-To: <CFBDECB2-E8CD-4CF2-A770-0B60738B1365@acm.org> (message from Mattias Engdegård on Sat, 13 Jun 2020 19:56:02 +0200)
> From: Mattias Engdegård <mattiase@acm.org>
> Date: Sat, 13 Jun 2020 19:56:02 +0200
> Cc: pipcet@gmail.com, emacs-devel@gnu.org
>
> > But it isn't rejected by the current code. Which was my point all
> > along.
>
> Since "#12345" is malformed it should be rejected, and will be.
That is definitely a change in behavior, isn't it? For some reason,
you don't regard this point I'm making seriously. Why not?
> Use a single parser of colour strings in the #RGB, rgb:R/G/B and
^^^^^^
> rgbi:R/G/B formats, replacing four existing ones. Previously,
> error-checking was spotty, handling of the rgbi: format not always
> present, and normalisation of the result was sometimes incorrect.
^^^^^^^^^^^^^
Our convention is to use the US English spelling.
> +/* Parse fractional hex digits at S ending right before E.
> + Set *DST to the value normalised to 65535 and return true on success,
> + false otherwise. */ ^^^^^^^^^^
Likewise here.
Please also describe in more detail the value put in *DST, I don't
think it's clear enough.
> +/* Parse floating-point number at S ending right before E.
> + Return the number if in the range [0,1]; otherwise -1. */
> +static double
> +parse_float_comp (const char *s, const char *e)
The commentary doesn't explain what is the "comp" part of the name
about.
> +/* Parse S as a numeric colour specification and set *R, *G and *B.
^^^^^^
Spelling again.
> + The result is normalised to a maximum value of 65535 per component. */
^^^^^^^^^^
And here.
> +DEFUN ("color-values-from-color-spec",
> + Fcolor_values_from_color_spec, Scolor_values_from_color_spec,
> + 1, 1, 0,
> + doc: /* Parse STRING as a numeric colour and return (R G B).
^^^^^^
> +Recognised formats are:
^^^^^^^^^^
> + #RGB, where R, G and B are hex strings of equal length, 1-4 digits each
> + rgb:R/G/B, where R, G, and B are hex strings, 1-4 digits each
> + rgbi:R/G/B, where R, G and B are numbers in [0,1].
> +
> +The result is normalised to a maximum value of 65535 per component.
^^^^^^^^^^
> +If STRING is not in one of the above forms, return nil. */)
Spelling.
I think this doc string is too terse. I would rephrase the beginning
as follows:
Convert a color SPEC into a list of standard RGB values.
Value is a list of the form (R G B), where R, G, and B are the
integer values, the intensities of the primary colors.
The argument SPEC should be a string in one of the following formats:
In the "rgbi" description, I think we should mention explicitly that
the components are floating-point numbers.
> + return (parse_color_spec (SSDATA (string), &r, &g, &b)
> + ? list3i (r, g, b)
> + : Qnil);
What happens if the argument is not a string? What should happen?
Finally, the Lisp primitive needs a NEWS entry and perhaps also a
place in the ELisp manual.
Thanks.
next prev parent reply other threads:[~2020-06-13 18:40 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20200608120746.30163.87810@vcs0.savannah.gnu.org>
[not found] ` <20200608120747.80E8E20A2E@vcs0.savannah.gnu.org>
2020-06-08 12:26 ` master 64e25cd: More robust NS hex colour string parsing Pip Cet
2020-06-08 16:15 ` Mattias Engdegård
2020-06-12 16:59 ` Mattias Engdegård
2020-06-12 17:33 ` Eli Zaretskii
2020-06-12 19:00 ` Mattias Engdegård
2020-06-12 19:11 ` Eli Zaretskii
2020-06-12 19:25 ` Eli Zaretskii
2020-06-13 10:17 ` Mattias Engdegård
2020-06-13 11:59 ` Eli Zaretskii
2020-06-13 15:39 ` Mattias Engdegård
2020-06-13 15:58 ` Eli Zaretskii
2020-06-13 16:44 ` Mattias Engdegård
2020-06-13 17:09 ` Eli Zaretskii
2020-06-13 17:29 ` Mattias Engdegård
2020-06-13 17:35 ` Eli Zaretskii
2020-06-13 17:56 ` Mattias Engdegård
2020-06-13 18:40 ` Eli Zaretskii [this message]
2020-06-15 8:31 ` Mattias Engdegård
2020-06-21 7:48 ` Mattias Engdegård
2020-06-21 14:59 ` Eli Zaretskii
2020-06-21 19:23 ` Mattias Engdegård
2020-06-13 19:15 ` Basil L. Contovounesios
2020-06-12 19:15 ` Pip Cet
2020-06-13 10:40 ` Mattias Engdegård
2020-06-12 18:33 ` Basil L. Contovounesios
2020-06-13 17:52 ` Mattias Engdegård
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83r1ui3j3m.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=mattiase@acm.org \
--cc=pipcet@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.