R1C1 Format and Internationalization, plus Relative Offsets (#3052)

* R1C1 Format and Internationalization, plus Relative Offsets

Fix #1704, albeit imperfectly. Excel's implementation of this feature makes it impossible to fix perfectly. I don't know why it was necessary to internationalize R1C1 in the first place - the benefits are so minimal,and the result is worksheets that break when opened in different locales. Ugh. I can't even find complete documentation about the format in different languages; I am using https://answers.microsoft.com/en-us/officeinsider/forum/all/indirect-function-is-broken-at-least-for-excel-in/1fcbcf20-a103-4172-abf1-2c0dfe848e60 as my definitive reference.

This fix concentrates on the original report, using the INDIRECT function; there may be other areas similarly affected. As with ambiguous date formats, PhpSpreadsheet will do a little better than Excel itself when reading spreadsheets with internationalized R1C1 by trying all possibilities before giving up. When it does give up, it will now return `#REF!`, as Excel does, rather than throwing an exception, which is certainly friendlier. Although read now works better, when writing it will use whatever the user specified, so spreadsheets breaking in the wrong locale will still happen.

There were some bugs that turned up as I added test cases, all of them concerning relative addressing in R1C1 format, e.g. `R[+1]C[-1]`. The regexp for validating the format allowed for minus signs, but not plus signs. Also, the relevant functions did not allow for passing the current cell address, which made relative addressing impossible. The code now allows these, and suitable test cases are added.

* Use Locale for Formats, but Not for XML

Implementing a suggestion from @MarkBaker to use the system locale for determining R1C1 format rather than looping through a set of regexes and accepting any that work. This is closer to how Excel itself operates. The assumption we are making is to use the first character of the translated ROW and COLUMN functions. This will not work for Russian or Bulgarian, where each starts with the same letter, but it appears that Russian, at least, still uses R1C1. So our algorithm will not use non-ASCII characters, nor characters where ROW and COLUMN start with the same letter, falling back to R/C in those cases. Turkish falls into that category. Czech uses an accented character for one of the functions, and I'm guessing to use the unaccented character in that case. Polish COLUMN function is NR.KOLUMNY, and I'm guessing to use K in that case.

The function that converts R1C1 references is also used by the XML reader *where the format is always R1C1*, not locale-based (confirmed by successfully opening in Excel an XML spreadsheet when my language is set to French). The conversion code now handles that distinction through the use of an extra parameter. Xml Reader Load Test is duplicated to confirm that spreadsheet is loaded properly whether the locale is English or French. (No, I did not add an INDIRECT function to the Xml spreadsheet.)

Tests CsvIssue2232Test and TranslationTest both changed locale without resetting it when done. That omission was exposed by the new code, and both are now corrected.

* OpenOffice and Gnumeric

OpenOffice and Gnumeric make it much easier to test with other languages - they can be handled with an environment variable. Sensibly, they require R and C as the characters for R1C1 notation regardless of the language. Change code to recognize this difference from Excel.

* Handle Output of ADDRESS Function

One other function has to deal with R1C1 format as a string. Unlike INDIRECT, which receives the string on input, ADDRESS generates the string on output. Ensure that the ADDRESS output is consistent with the INDIRECT input.

ADDRESS expects its 4th arg to be bool, but it can also accept int, and many examples on the net supply it as an int. This had not been handled properly, but is now corrected.

* More Structured Test

I earlier introduced a new test for relative R1C1 addressing. Rewrite it to be clearer.

* Add Row for This to Locale Spreadsheet

It took a while for me to figure out how it all works. I have added a new row (with English value `*RC`) to Translations.xlsx, in the "Lookup and Reference" section of sheet "Excel Functions". By starting the "function name" with an asterisk, it will not be confused with a "real" function (confirmed by a new test). This approach also gives us the flexibility to do something similar if another surprise case occurs in future; in particular, I think this is more flexible than adding this as another option on the "Excel Localisation" sheet. It also means that any errors or omissions in the list below will be handled as with any other translation problem, by updating the spreadsheet without needing to touch any code.

The spreadsheet has the following entries in the *RC row:
- first letter of ROW/COLUMN functions for da, de, es, fi, fr, hu, nl, nb, pt, pt_br, sv
- no value for locales where ROW/COLUMN functions start with same letter - bg, ru, tr
- no value for locales with a multi-part name for ROW and/or COLUMN - it, pl (I had not previously noted Italian as an exception)
- no value for locales where ROW and/or COLUMN starts with a non-ASCII character - cs (this would also apply to bg and ru which are already included under "same letter")
- it does nothing for locales which are defined on the "Excel Localisation" sheet but have no entries yet on the "Excel Functions" sheet (e.g. eu)

Note that all but the first bullet item will continue to use R/C, which leaves them no worse off than they were before this change.

Author: oleibman

infra/LocaleGenerator.php

@@ -146,7 +146,7 @@ protected function buildFunctionsFileForLocale($column, $locale): void
             $translationValue = $translationCell->getValue();
             if ($this->isFunctionCategoryEntry($translationCell)) {
                 $this->writeFileSectionHeader($functionFile, "{$translationValue} ({$functionName})");
-            } elseif (!array_key_exists($functionName, $this->phpSpreadsheetFunctions)) {
+            } elseif (!array_key_exists($functionName, $this->phpSpreadsheetFunctions) && substr($functionName, 0, 1) !== '*') {
                 $this->log("Function {$functionName} is not defined in PhpSpreadsheet");
             } elseif (!empty($translationValue)) {
                 $functionTranslation = "{$functionName} = {$translationValue}" . self::EOL;

src/PhpSpreadsheet/Calculation/Calculation.php

@@ -3110,7 +3110,7 @@ public function setLocale(string $locale)
                     [$localeFunction] = explode('##', $localeFunction); //    Strip out comments
                     if (strpos($localeFunction, '=') !== false) {
                         [$fName, $lfName] = array_map('trim', explode('=', $localeFunction));
-                        if ((isset(self::$phpSpreadsheetFunctions[$fName])) && ($lfName != '') && ($fName != $lfName)) {
+                        if ((substr($fName, 0, 1) === '*' || isset(self::$phpSpreadsheetFunctions[$fName])) && ($lfName != '') && ($fName != $lfName)) {
                             self::$localeFunctions[$fName] = $lfName;
                         }
                     }

src/PhpSpreadsheet/Calculation/LookupRef/Address.php

@@ -4,6 +4,7 @@
 
 use PhpOffice\PhpSpreadsheet\Calculation\ArrayEnabled;
 use PhpOffice\PhpSpreadsheet\Calculation\Information\ExcelError;
+use PhpOffice\PhpSpreadsheet\Cell\AddressHelper;
 use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
 
 class Address
@@ -72,6 +73,9 @@ public static function cell($row, $column, $relativity = 1, $referenceStyle = tr
 
         $sheetName = self::sheetName($sheetName);
 
+        if (is_int($referenceStyle)) {
+            $referenceStyle = (bool) $referenceStyle;
+        }
         if ((!is_bool($referenceStyle)) || $referenceStyle === self::REFERENCE_STYLE_A1) {
             return self::formatAsA1($row, $column, $relativity, $sheetName);
         }
@@ -113,7 +117,8 @@ private static function formatAsR1C1(int $row, int $column, int $relativity, str
         if (($relativity == self::ADDRESS_ROW_RELATIVE) || ($relativity == self::ADDRESS_RELATIVE)) {
             $row = "[{$row}]";
         }
+        [$rowChar, $colChar] = AddressHelper::getRowAndColumnChars();
 
-        return "{$sheetName}R{$row}C{$column}";
+        return "{$sheetName}$rowChar{$row}$colChar{$column}";
     }
 }

src/PhpSpreadsheet/Calculation/LookupRef/Helpers.php

@@ -13,12 +13,12 @@ class Helpers
 
     public const CELLADDRESS_USE_R1C1 = false;
 
-    private static function convertR1C1(string &$cellAddress1, ?string &$cellAddress2, bool $a1): string
+    private static function convertR1C1(string &$cellAddress1, ?string &$cellAddress2, bool $a1, ?int $baseRow = null, ?int $baseCol = null): string
     {
         if ($a1 === self::CELLADDRESS_USE_R1C1) {
-            $cellAddress1 = AddressHelper::convertToA1($cellAddress1);
+            $cellAddress1 = AddressHelper::convertToA1($cellAddress1, $baseRow ?? 1, $baseCol ?? 1);
             if ($cellAddress2) {
-                $cellAddress2 = AddressHelper::convertToA1($cellAddress2);
+                $cellAddress2 = AddressHelper::convertToA1($cellAddress2, $baseRow ?? 1, $baseCol ?? 1);
             }
         }
 
@@ -35,7 +35,7 @@ private static function adjustSheetTitle(string &$sheetTitle, ?string $value): v
         }
     }
 
-    public static function extractCellAddresses(string $cellAddress, bool $a1, Worksheet $sheet, string $sheetName = ''): array
+    public static function extractCellAddresses(string $cellAddress, bool $a1, Worksheet $sheet, string $sheetName = '', ?int $baseRow = null, ?int $baseCol = null): array
     {
         $cellAddress1 = $cellAddress;
         $cellAddress2 = null;
@@ -52,7 +52,7 @@ public static function extractCellAddresses(string $cellAddress, bool $a1, Works
         if (strpos($cellAddress, ':') !== false) {
             [$cellAddress1, $cellAddress2] = explode(':', $cellAddress);
         }
-        $cellAddress = self::convertR1C1($cellAddress1, $cellAddress2, $a1);
+        $cellAddress = self::convertR1C1($cellAddress1, $cellAddress2, $a1, $baseRow, $baseCol);
 
         return [$cellAddress1, $cellAddress2, $cellAddress];
     }

src/PhpSpreadsheet/Calculation/LookupRef/Indirect.php

@@ -7,6 +7,7 @@
 use PhpOffice\PhpSpreadsheet\Calculation\Functions;
 use PhpOffice\PhpSpreadsheet\Calculation\Information\ExcelError;
 use PhpOffice\PhpSpreadsheet\Cell\Cell;
+use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
 use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
 
 class Indirect
@@ -63,6 +64,8 @@ private static function validateAddress($cellAddress): string
      */
     public static function INDIRECT($cellAddress, $a1fmt, Cell $cell)
     {
+        [$baseCol, $baseRow] = Coordinate::indexesFromString($cell->getCoordinate());
+
         try {
             $a1 = self::a1Format($a1fmt);
             $cellAddress = self::validateAddress($cellAddress);
@@ -78,7 +81,11 @@ public static function INDIRECT($cellAddress, $a1fmt, Cell $cell)
             $cellAddress = self::handleRowColumnRanges($worksheet, ...explode(':', $cellAddress));
         }
 
-        [$cellAddress1, $cellAddress2, $cellAddress] = Helpers::extractCellAddresses($cellAddress, $a1, $cell->getWorkSheet(), $sheetName);
+        try {
+            [$cellAddress1, $cellAddress2, $cellAddress] = Helpers::extractCellAddresses($cellAddress, $a1, $cell->getWorkSheet(), $sheetName, $baseRow, $baseCol);
+        } catch (Exception $e) {
+            return ExcelError::REF();
+        }
 
         if (
             (!preg_match('/^' . Calculation::CALCULATION_REGEXP_CELLREF . '$/miu', $cellAddress1, $matches)) ||

src/PhpSpreadsheet/Calculation/locale/Translations.xlsx

@@ -245,6 +245,7 @@ ROWS = RÆKKER
 RTD = RTD
 TRANSPOSE = TRANSPONER
 VLOOKUP = LOPSLAG
+*RC = RK
 
 ##
 ## Matematiske og trigonometriske funktioner (Math & Trig Functions)

src/PhpSpreadsheet/Calculation/locale/da/functions

@@ -243,6 +243,7 @@ ROWS = ZEILEN
 RTD = RTD
 TRANSPOSE = MTRANS
 VLOOKUP = SVERWEIS
+*RC = ZS
 
 ##
 ## Mathematische und trigonometrische Funktionen (Math & Trig Functions)

src/PhpSpreadsheet/Calculation/locale/de/functions

@@ -245,6 +245,7 @@ ROWS = FILAS
 RTD = RDTR
 TRANSPOSE = TRANSPONER
 VLOOKUP = BUSCARV
+*RC = FC
 
 ##
 ## Funciones matemáticas y trigonométricas (Math & Trig Functions)

src/PhpSpreadsheet/Calculation/locale/es/functions

@@ -245,6 +245,7 @@ ROWS = RIVIT
 RTD = RTD
 TRANSPOSE = TRANSPONOI
 VLOOKUP = PHAKU
+*RC = RS
 
 ##
 ## Matemaattiset ja trigonometriset funktiot (Math & Trig Functions)