Path: csiph.com!goblin1!goblin.stu.neva.ru!usenet.stanford.edu!not-for-mail
From: Koichi Murase <myoga.murase@gmail.com>
Newsgroups: gnu.bash.bug
Subject: Re: Incorrect / Inconsistent behavior with nameref assignments in functions
Date: Sun, 30 Aug 2020 09:59:20 +0900
Lines: 72
Approved: bug-bash@gnu.org
Message-ID: <mailman.1746.1598749178.2469.bug-bash@gnu.org>
References: <a20e4692-69b3-9836-4861-3e822e407ef7@binarus.de> <CAFLRLk8xc4CAR7X_g-B-QMCNtvzVkv5E9kf3EUiD_JUACAfwDA@mail.gmail.com> <5f512e22-fe55-7281-7585-7cffb74299dc@binarus.de> <CAFLRLk9mfWJh5e_8=diERYAAZE7AwPu4YfF-1J-89697itYLrQ@mail.gmail.com>
NNTP-Posting-Host: lists.gnu.org
Mime-Version: 1.0
Content-Type: text/plain; charset="UTF-8"
Cc: bug-bash@gnu.org
To: Binarus <lists@binarus.de>
Envelope-to: bug-bash@gnu.org
In-Reply-To: <5f512e22-fe55-7281-7585-7cffb74299dc@binarus.de>
Received-SPF: pass client-ip=2a00:1450:4864:20::529; envelope-from=myoga.murase@gmail.com; helo=mail-ed1-x529.google.com
X-Spam_score_int: -20
X-Spam_score: -2.1
X-Spam_bar: --
X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-BeenThere: bug-bash@gnu.org
X-Mailman-Version: 2.1.23
Precedence: list
List-Id: Bug reports for the GNU Bourne Again SHell <bug-bash.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/bug-bash>, <mailto:bug-bash-request@gnu.org?subject=unsubscribe>
List-Archive: <https://lists.gnu.org/archive/html/bug-bash>
List-Post: <mailto:bug-bash@gnu.org>
List-Help: <mailto:bug-bash-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/bug-bash>, <mailto:bug-bash-request@gnu.org?subject=subscribe>
X-Mailman-Original-Message-ID: <CAFLRLk9mfWJh5e_8=diERYAAZE7AwPu4YfF-1J-89697itYLrQ@mail.gmail.com>
X-Mailman-Original-References: <a20e4692-69b3-9836-4861-3e822e407ef7@binarus.de> <CAFLRLk8xc4CAR7X_g-B-QMCNtvzVkv5E9kf3EUiD_JUACAfwDA@mail.gmail.com> <5f512e22-fe55-7281-7585-7cffb74299dc@binarus.de>
Xref: csiph.com gnu.bash.bug:16860

2020-08-29 14:46 Binarus <lists@binarus.de>:
> I am wondering when debian will include bash 5.1. It looks like
> debian testing and debian unstable are on bash 5.0, so it will
> probably take several years.

Actually the problem of the function `Dummy' will not be solved even
in bash 5.1.  There is another but similar problem with your function.
A user might specify `namerefArray' as the name of an outer array,
which results in a circular-reference error.

  $ cat testR2c.sh
  function Dummy {
    local -n namerefArray="$1"
    local -a -i myArray=("${namerefArray[@]}")
    local -p
  }
  declare -a -i namerefArray=('1' '2' '3')
  Dummy namerefArray

  $ bash-5.1-alpha testR2c.sh
  testR2c.sh: line 4: local: warning: namerefArray: circular name reference
  testR2c.sh: line 4: warning: namerefArray: circular name reference
  testR2c.sh: line 5: warning: namerefArray: circular name reference
  testR2c.sh: line 5: warning: namerefArray: circular name reference
  declare -a myArray=([0]="1" [1]="2" [2]="3")
  declare -n namerefArray="namerefArray"

If you want to work around the problem, there are several ways.

* One of the simplest ways is to use different variable names as
  already suggested by other people.  However, when the variable name
  is not under control for some reason (that, e.g., the functon is
  provided to users who may use it in an arbitrary way, or it imports
  different shell-script frameworks), the probability of the name
  collision is not 0%.

* Another way is to copy to the local array only when the name is
  different from `myArray':

  function Dummy {
    [[ $1 == myArray ]] ||
      eval "local -a myArray=(\"\${$1[@]}\")"
    declare -p myArray
  }

  When you want to add `-i' attribute to the array or to modify the
  array without affecting the original outer array, you may first save
  the value to another local array and next copy the array to the
  array that you want to edit.

  function Dummy {
    [[ $1 == inputArray ]] ||
      eval "local -a inputArray=(\"\${$1[@]}\")"
    local -ia myArray=("${inputArray[@]}")
    declare -p myArray
  }

* If you want to use namerefs to eliminate the use of `eval', maybe
  you could do like the following but I think it is more natural and
  readable to use eval:

  function Dummy {
    [[ $1 == refArray ]] || local -n refArray=$1
    [[ $1 == inputArray ]] || local -i inputArray=("${refArray[@]}")
    local -ia myArray=("${inputArray[@]}")
    declare -p myArray
  }

Best regards,

Koichi