bug#36664: 27.0.50; definition of string-trim causes warning

bug#36664: 27.0.50; definition of string-trim causes warning

[Andreas Röhler]

Hi,

concerns subr-x.el

When byte-compiling a file with def of trim-string inside, get a 
warning: Lexical argument shadows the dynamic variable
     string

Changing the argument from "string" into "strg" for example should 
silence that.

Thanks,

Andreas

In GNU Emacs 27.0.50 (build 1, i686-pc-linux-gnu, GTK+ Version 3.14.5)
  of 2019-06-04

bug#36664: 27.0.50; definition of string-trim causes warning

[Lars Ingebrigtsen]

Andreas Röhler <andreas.roehler@easy-emacs.de> writes:

> concerns subr-x.el
>
> When byte-compiling a file with def of trim-string inside, get a
> warning: Lexical argument shadows the dynamic variable
>     string

I'm not sure I follow.  Do you mean if you have a function that calls
string-trim (not define trim-string?) in a file, and you compile that
file, you get that warning?

If that's what you mean, I'm unable to reproduce the error.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#36664: 27.0.50; definition of string-trim causes warning

[Andreas Röhler]

On 15.07.19 14:24, Lars Ingebrigtsen wrote:
> Andreas Röhler <andreas.roehler@easy-emacs.de> writes:
>
>> concerns subr-x.el
>>
>> When byte-compiling a file with def of trim-string inside, get a
>> warning: Lexical argument shadows the dynamic variable
>>      string
> I'm not sure I follow.  Do you mean if you have a function that calls
> string-trim (not define trim-string?) in a file, and you compile that
> file, you get that warning?
>
> If that's what you mean, I'm unable to reproduce the error.
>

Have that in python-mode.el --as older Emacsen might miss the function--:

;; subr-x.el might not exist yet
(unless (functionp 'string-trim)
   (defsubst string-trim (string &optional trim-left trim-right)
     "Trim STRING of leading and trailing strings matching TRIM-LEFT and 
TRIM-RIGHT.

TRIM-LEFT and TRIM-RIGHT default to \"[ \\t\\n\\r]+\"."
     (string-trim-left (string-trim-right string trim-right) trim-left))

[...]

bug#36664: 27.0.50; definition of string-trim causes warning

[Andreas Röhler]

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


On 15.07.19 16:24, Andreas Röhler wrote:
>
> On 15.07.19 14:24, Lars Ingebrigtsen wrote:
>> Andreas Röhler <andreas.roehler@easy-emacs.de> writes:
>>
>>> concerns subr-x.el
>>>
>>> When byte-compiling a file with def of trim-string inside, get a
>>> warning: Lexical argument shadows the dynamic variable
>>>      string
>> I'm not sure I follow.  Do you mean if you have a function that calls
>> string-trim (not define trim-string?) in a file, and you compile that
>> file, you get that warning?
>>
>> If that's what you mean, I'm unable to reproduce the error.
>>
>
> Have that in python-mode.el --as older Emacsen might miss the function--:
>
> ;; subr-x.el might not exist yet
> (unless (functionp 'string-trim)
>   (defsubst string-trim (string &optional trim-left trim-right)
>     "Trim STRING of leading and trailing strings matching TRIM-LEFT 
> and TRIM-RIGHT.
>
> TRIM-LEFT and TRIM-RIGHT default to \"[ \\t\\n\\r]+\"."
>     (string-trim-left (string-trim-right string trim-right) trim-left))
>
> [...]
>
>

Hmm, also can't reproduce with emacs -Q, only from my config - see 
attachment.

Beside of this IMO the warning is reasonable - commonly used symbols 
should not appear as plain argument names.


>
>

[-- Attachment #2: warning.png --]
[-- Type: image/png, Size: 163068 bytes --]

bug#36664: 27.0.50; definition of string-trim causes warning

[Noam Postavsky]

Andreas Röhler <andreas.roehler@easy-emacs.de> writes:

>>>> When byte-compiling a file with def of trim-string inside, get a
>>>> warning: Lexical argument shadows the dynamic variable
>>>>      string

> Hmm, also can't reproduce with emacs -Q, only from my config - see
> attachment.
>
> Beside of this IMO the warning is reasonable - commonly used symbols
> should not appear as plain argument names.

I think the bug is somewhere in your config, there is something like

    (defvar string "foo")

Which makes 'string' into a global special variable.

bug#36664: 27.0.50; definition of string-trim causes warning

[Lars Ingebrigtsen]

Andreas Röhler <andreas.roehler@easy-emacs.de> writes:

> Have that in python-mode.el --as older Emacsen might miss the function--:
>
> ;; subr-x.el might not exist yet
> (unless (functionp 'string-trim)
>   (defsubst string-trim (string &optional trim-left trim-right)
>     "Trim STRING of leading and trailing strings matching TRIM-LEFT
> and TRIM-RIGHT.
>
> TRIM-LEFT and TRIM-RIGHT default to \"[ \\t\\n\\r]+\"."
>     (string-trim-left (string-trim-right string trim-right) trim-left))

I put the following in /tmp/a.el and said `M-x byte-compile-file', and I
got no warning...

(unless (functionp 'string-trim)
 (defsubst string-trim (string &optional trim-left trim-right)
   "Trim STRING of leading and trailing strings matching TRIM-LEFT
and TRIM-RIGHT.

TRIM-LEFT and TRIM-RIGHT default to \"[ \\t\\n\\r]+\"."
   (string-trim-left (string-trim-right string trim-right) trim-left)))

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#36664: 27.0.50; definition of string-trim causes warning

[Lars Ingebrigtsen]

Well, I got the warning about the other two functions, but that's
natural:

\f
Compiling file /tmp/a.el at Mon Jul 15 17:18:07 2019

In end of data:
a.el:12:1:Warning: the following functions are not known to be defined:
    string-trim-left, string-trim-right


-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no