tdf#150867: Add support for VSTACK function

Change-Id: I76e3267f45a0d035f6a79af934b9ce2c606b4b89
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/181120
Reviewed-by: Xisco Fauli <[email protected]>
Tested-by: Jenkins

Author: Xisco Fauli

formula/inc/core_resource.hrc

@@ -286,6 +286,7 @@ const std::pair<const char *, int> RID_STRLIST_FUNCTION_NAMES_ENGLISH_ODFF[] =
     { "COM.MICROSOFT.DROP" , SC_OPCODE_DROP },
     { "COM.MICROSOFT.EXPAND" , SC_OPCODE_EXPAND },
     { "COM.MICROSOFT.HSTACK" , SC_OPCODE_HSTACK },
+    { "COM.MICROSOFT.VSTACK" , SC_OPCODE_VSTACK },
     { "COM.MICROSOFT.TAKE" , SC_OPCODE_TAKE },
     { "COM.MICROSOFT.TOCOL" , SC_OPCODE_TOCOL },
     { "COM.MICROSOFT.TOROW" , SC_OPCODE_TOROW },
@@ -753,6 +754,7 @@ const std::pair<const char *, int> RID_STRLIST_FUNCTION_NAMES_ENGLISH_OOXML[] =
     { "_xlfn.DROP" , SC_OPCODE_DROP },
     { "_xlfn.EXPAND" , SC_OPCODE_EXPAND },
     { "_xlfn.HSTACK" , SC_OPCODE_HSTACK },
+    { "_xlfn.VSTACK" , SC_OPCODE_VSTACK },
     { "_xlfn.TAKE" , SC_OPCODE_TAKE },
     { "_xlfn.TOCOL" , SC_OPCODE_TOCOL },
     { "_xlfn.TOROW" , SC_OPCODE_TOROW },
@@ -1223,6 +1225,7 @@ const std::pair<const char *, int> RID_STRLIST_FUNCTION_NAMES_ENGLISH_PODF[] =
     { "DROP" , SC_OPCODE_DROP },
     { "EXPAND" , SC_OPCODE_EXPAND },
     { "HSTACK" , SC_OPCODE_HSTACK },
+    { "VSTACK" , SC_OPCODE_VSTACK },
     { "TAKE" , SC_OPCODE_TAKE },
     { "TOCOL" , SC_OPCODE_TOCOL },
     { "TOROW" , SC_OPCODE_TOROW },
@@ -1693,6 +1696,7 @@ const std::pair<const char *, int> RID_STRLIST_FUNCTION_NAMES_ENGLISH_API[] =
     { "DROP" , SC_OPCODE_DROP },
     { "EXPAND" , SC_OPCODE_EXPAND },
     { "HSTACK" , SC_OPCODE_HSTACK },
+    { "VSTACK" , SC_OPCODE_VSTACK },
     { "TAKE" , SC_OPCODE_TAKE },
     { "TOCOL" , SC_OPCODE_TOCOL },
     { "TOROW" , SC_OPCODE_TOROW },
@@ -2161,6 +2165,7 @@ const std::pair<const char *, int> RID_STRLIST_FUNCTION_NAMES_ENGLISH[] =
     { "DROP" , SC_OPCODE_DROP },
     { "EXPAND" , SC_OPCODE_EXPAND },
     { "HSTACK" , SC_OPCODE_HSTACK },
+    { "VSTACK" , SC_OPCODE_VSTACK },
     { "TAKE" , SC_OPCODE_TAKE },
     { "TOCOL" , SC_OPCODE_TOCOL },
     { "TOROW" , SC_OPCODE_TOROW },
@@ -2610,6 +2615,7 @@ const std::pair<TranslateId, int> RID_STRLIST_FUNCTION_NAMES[] =
     { NC_("RID_STRLIST_FUNCTION_NAMES", "DROP") , SC_OPCODE_DROP },
     { NC_("RID_STRLIST_FUNCTION_NAMES", "EXPAND") , SC_OPCODE_EXPAND },
     { NC_("RID_STRLIST_FUNCTION_NAMES", "HSTACK") , SC_OPCODE_HSTACK },
+    { NC_("RID_STRLIST_FUNCTION_NAMES", "VSTACK") , SC_OPCODE_VSTACK },
     { NC_("RID_STRLIST_FUNCTION_NAMES", "TAKE") , SC_OPCODE_TAKE },
     { NC_("RID_STRLIST_FUNCTION_NAMES", "TOCOL") , SC_OPCODE_TOCOL },
     { NC_("RID_STRLIST_FUNCTION_NAMES", "TOROW") , SC_OPCODE_TOROW },

formula/source/core/api/FormulaCompiler.cxx

@@ -1284,6 +1284,7 @@ bool FormulaCompiler::IsMatrixFunction( OpCode eOpCode )
         case ocDrop :
         case ocExpand :
         case ocHStack :
+        case ocVStack :
         case ocTake :
         case ocToCol :
         case ocToRow :

include/formula/compiler.hxx

@@ -522,13 +522,14 @@
 #define SC_OPCODE_DROP              507
 #define SC_OPCODE_EXPAND            508
 #define SC_OPCODE_HSTACK            509
-#define SC_OPCODE_TAKE              510
-#define SC_OPCODE_TOCOL             511
-#define SC_OPCODE_TOROW             512
-#define SC_OPCODE_UNIQUE            513
-#define SC_OPCODE_WRAPCOLS          514
-#define SC_OPCODE_WRAPROWS          515
-#define SC_OPCODE_STOP_2_PAR        516     /* last function with two or more parameters' OpCode + 1 */
+#define SC_OPCODE_VSTACK            510
+#define SC_OPCODE_TAKE              511
+#define SC_OPCODE_TOCOL             512
+#define SC_OPCODE_TOROW             513
+#define SC_OPCODE_UNIQUE            514
+#define SC_OPCODE_WRAPCOLS          515
+#define SC_OPCODE_WRAPROWS          516
+#define SC_OPCODE_STOP_2_PAR        517     /* last function with two or more parameters' OpCode + 1 */
 
 #define SC_OPCODE_STOP_FUNCTION     SC_OPCODE_STOP_2_PAR            /* last function's OpCode + 1 */
 #define SC_OPCODE_LAST_OPCODE_ID    (SC_OPCODE_STOP_FUNCTION - 1)   /* last OpCode */

include/formula/opcode.hxx

@@ -518,6 +518,7 @@ enum OpCode : sal_uInt16
         ocDrop              = SC_OPCODE_DROP,
         ocExpand            = SC_OPCODE_EXPAND,
         ocHStack            = SC_OPCODE_HSTACK,
+        ocVStack            = SC_OPCODE_VSTACK,
         ocTake              = SC_OPCODE_TAKE,
         ocToCol             = SC_OPCODE_TOCOL,
         ocToRow             = SC_OPCODE_TOROW,
@@ -1013,6 +1014,7 @@ inline std::string OpCodeEnumToString(OpCode eCode)
     case ocDrop: return "Drop";
     case ocExpand: return "Expand";
     case ocHStack: return "HStack";
+    case ocVStack: return "VStack";
     case ocTake: return "Take";
     case ocToCol: return "ToCol";
     case ocToRow: return "ToRow";

sc/README.md

@@ -60,6 +60,7 @@ https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part4-formula/OpenDocume
   * DROP
   * EXPAND
   * HSTACK
+  * VSTACK
   * TAKE
   * TOCOL
   * TOROW

sc/inc/helpids.h

@@ -605,6 +605,7 @@ inline constexpr OUString HID_FUNC_CHOOSEROWS_MS = u"SC_HID_FUNC_CHOOSEROWS_MS"_
 inline constexpr OUString HID_FUNC_DROP_MS = u"SC_HID_FUNC_DROP_MS"_ustr;
 inline constexpr OUString HID_FUNC_EXPAND_MS = u"SC_HID_FUNC_EXPAND_MS"_ustr;
 inline constexpr OUString HID_FUNC_HSTACK_MS = u"SC_HID_FUNC_HSTACK_MS"_ustr;
+inline constexpr OUString HID_FUNC_VSTACK_MS = u"SC_HID_FUNC_VSTACK_MS"_ustr;
 inline constexpr OUString HID_FUNC_TAKE_MS = u"SC_HID_FUNC_TAKE_MS"_ustr;
 inline constexpr OUString HID_FUNC_TOCOL_MS = u"SC_HID_FUNC_TOCOL_MS"_ustr;
 inline constexpr OUString HID_FUNC_TOROW_MS = u"SC_HID_FUNC_TOROW_MS"_ustr;

sc/inc/scfuncs.hrc

@@ -4311,6 +4311,16 @@ const TranslateId SC_OPCODE_HSTACK_ARY[] =
     NC_("SC_OPCODE_HSTACK", "Array 2, Array 3,... The following arrays to append. if an array has fewer rows, #N/A error will be returned in the additional rows."),
 };
 
+// -=*# Resource for function VSTACK #*=-
+const TranslateId SC_OPCODE_VSTACK_ARY[] =
+{
+    NC_("SC_OPCODE_VSTACK", "Appends arrays vertically to create a larger array"),
+    NC_("SC_OPCODE_VSTACK", "Array"),
+    NC_("SC_OPCODE_VSTACK", "The first array to append."),
+    NC_("SC_OPCODE_VSTACK", "Array 2"),
+    NC_("SC_OPCODE_VSTACK", "Array 2, Array 3,... The following arrays to append. if an array has fewer columns, #N/A error will be returned in the additional columns."),
+};
+
 // -=*# Resource for function TAKE #*=-
 const TranslateId SC_OPCODE_TAKE_ARY[] =
 {

sc/qa/extras/scfunctionlistobj.cxx

@@ -77,7 +77,7 @@ class ScFunctionListObj : public UnoApiTest,
 ScFunctionListObj::ScFunctionListObj()
     : UnoApiTest(u"/sc/qa/extras/testdocuments"_ustr)
     , XElementAccess(cppu::UnoType<uno::Sequence<beans::PropertyValue>>::get())
-    , XIndexAccess(414)
+    , XIndexAccess(415)
     , XNameAccess(u"IF"_ustr)
     , XServiceInfo(u"stardiv.StarCalc.ScFunctionListObj"_ustr,
                    u"com.sun.star.sheet.FunctionDescriptions"_ustr)