--fix produces invalid syntax for subprograms

[Giftkekschen]

Environment
VSG version: 3.35.0
OS: Ubuntu 22.04.5 LTS

Describe the bug
When using the --fix option, vsg currently produces invalid VHDL syntax, when fixing function_020 or procedure_014 for nested subprograms. Instead of adding just the designator, <designator>;function; is added.

To Reproduce
Steps to reproduce the behavior:

1. get minimal.vhd.txt
2. get minimal.yml
3. run vsg -f minimal.vhd -c minimal.yml --fix
4. See error in "fixed" file

Expected behavior
The optional subprogram designator is added at the end of the subprogram.

original:

    function calc_out_function return integer is
        function nested_function_function return integer is
        begin
            return 5;
        end function;
    begin
        return 2 * nested_function_function;
    end function;

expected:

    function calc_out_function return integer is
        function nested_function_function return integer is
        begin
            return 5;
        end function nested_function_function;
    begin
        return 2 * nested_function_function;
    end function calc_out_function;

actual:

    function calc_out_function return integer is
        function nested_function_function return integer is
        begin
            return 5;
        end function;
    begin
        return 2 * nested_function_function;
    end function calc_out_function;function;

[JHertz5]

Hi @Giftkekschen. I've taken a look at your issue.

At first I wasn't able to recreate your issue - the minimal.vhd.txt file that you attached already has the problem in it, so VSG isn't able to process the file since it is not valid VHDL. However, I've copied the "original" inline code example that you provided into a file and I'm now able to recreate the issue.

I'll take a look and see whether I can figure out the problem.

[JHertz5]

I've been able to diagnose the problem. It's to do with the way that the file is updated after a correction is made. It looks like the code works on the assumption that a given section of code will not be modified by the same rule more than once. It iterates through the rules with violations and applies the updates from each violation sequentially. However, in this case, the update from the inner violation overwrites the updates from the outer, because the areas that are being updates overlap.

Thanks for raising this issue. I'll see whether I can come up with a fix.