This closes #1582, fixes the formula calculation bug, and improves form controls

- Fix incorrect formula calculate results on a nested argument function which returns a numeric result
- Add a new exported error variable `ErrorFormControlValue`
- Rename exported enumeration `FormControlCheckbox` to `FormControlCheckBox`
- Rename exported enumeration `FormControlRadio` to `FormControlOptionButton`
- The `AddFormControl` function supports new 5 form controls: spin button, check box, group box, label, and scroll bar
- Update documentation for the `GraphicOptions` data type, `AddFormControl` and `NewStreamWriter` functions
- Update the unit tests

Author: xuri

calc.go

@@ -1053,16 +1053,16 @@ func (f *File) evalInfixExpFunc(ctx *calcContext, sheet, cell string, token, nex
 		if nextToken.TType == efp.TokenTypeOperatorInfix || (opftStack.Len() > 1 && opfdStack.Len() > 0) {
 			// mathematics calculate in formula function
 			opfdStack.Push(arg)
-		} else {
-			argsStack.Peek().(*list.List).PushBack(arg)
-		}
-	} else {
-		val := arg.Value()
-		if arg.Type == ArgMatrix && len(arg.Matrix) > 0 && len(arg.Matrix[0]) > 0 {
-			val = arg.Matrix[0][0].Value()
+			return newEmptyFormulaArg()
 		}
-		opdStack.Push(newStringFormulaArg(val))
+		argsStack.Peek().(*list.List).PushBack(arg)
+		return newEmptyFormulaArg()
+	}
+	if arg.Type == ArgMatrix && len(arg.Matrix) > 0 && len(arg.Matrix[0]) > 0 {
+		opdStack.Push(arg.Matrix[0][0])
+		return newEmptyFormulaArg()
 	}
+	opdStack.Push(arg)
 	return newEmptyFormulaArg()
 }
 

calc_test.go

@@ -5918,6 +5918,23 @@ func TestCalcCellResolver(t *testing.T) {
 		assert.NoError(t, err, formula)
 		assert.Equal(t, expected, result, formula)
 	}
+	// Test calculates formula that contains a nested argument function which returns a numeric result
+	f = NewFile()
+	for _, cell := range []string{"A1", "B2", "B3", "B4"} {
+		assert.NoError(t, f.SetCellValue("Sheet1", cell, "ABC"))
+	}
+	for cell, formula := range map[string]string{
+		"A2": "IF(B2<>\"\",MAX(A1:A1)+1,\"\")",
+		"A3": "IF(B3<>\"\",MAX(A1:A2)+1,\"\")",
+		"A4": "IF(B4<>\"\",MAX(A1:A3)+1,\"\")",
+	} {
+		assert.NoError(t, f.SetCellFormula("Sheet1", cell, formula))
+	}
+	for cell, expected := range map[string]string{"A2": "1", "A3": "2", "A4": "3"} {
+		result, err := f.CalcCellValue("Sheet1", cell)
+		assert.NoError(t, err)
+		assert.Equal(t, expected, result)
+	}
 }
 
 func TestEvalInfixExp(t *testing.T) {

errors.go

@@ -255,4 +255,7 @@ var (
 	// ErrUnprotectWorkbookPassword defined the error message on remove workbook
 	// protection with password verification failed.
 	ErrUnprotectWorkbookPassword = errors.New("workbook protect password not match")
+	// ErrorFormControlValue defined the error message for receiving a scroll
+	// value exceeds limit.
+	ErrorFormControlValue = fmt.Errorf("scroll value must be between 0 and %d", MaxFormControlValue)
 )

picture.go

@@ -110,41 +110,46 @@ func parseGraphicOptions(opts *GraphicOptions) *GraphicOptions {
 //	    }
 //	}
 //
-// The optional parameter "AutoFit" specifies if you make image size auto-fits the
-// cell, the default value of that is 'false'.
+// The optional parameter "AltText" is used to add alternative text to a graph
+// object.
 //
-// The optional parameter "Hyperlink" specifies the hyperlink of the image.
+// The optional parameter "PrintObject" indicates whether the graph object is
+// printed when the worksheet is printed, the default value of that is 'true'.
 //
-// The optional parameter "HyperlinkType" defines two types of
-// hyperlink "External" for website or "Location" for moving to one of the
-// cells in this workbook. When the "HyperlinkType" is "Location",
-// coordinates need to start with "#".
+// The optional parameter "Locked" indicates whether lock the graph object.
+// Locking an object has no effect unless the sheet is protected.
 //
-// The optional parameter "Positioning" defines two types of the position of an
-// image in an Excel spreadsheet, "oneCell" (Move but don't size with
-// cells) or "absolute" (Don't move or size with cells). If you don't set this
-// parameter, the default positioning is move and size with cells.
+// The optional parameter "LockAspectRatio" indicates whether lock aspect ratio
+// for the graph object, the default value of that is 'false'.
 //
-// The optional parameter "PrintObject" indicates whether the image is printed
-// when the worksheet is printed, the default value of that is 'true'.
+// The optional parameter "AutoFit" specifies if you make graph object size
+// auto-fits the cell, the default value of that is 'false'.
 //
-// The optional parameter "LockAspectRatio" indicates whether lock aspect
-// ratio for the image, the default value of that is 'false'.
+// The optional parameter "OffsetX" specifies the horizontal offset of the graph
+// object with the cell, the default value of that is 0.
 //
-// The optional parameter "Locked" indicates whether lock the image. Locking
-// an object has no effect unless the sheet is protected.
+// The optional parameter "OffsetY" specifies the vertical offset of the graph
+// object with the cell, the default value of that is 0.
 //
-// The optional parameter "OffsetX" specifies the horizontal offset of the
-// image with the cell, the default value of that is 0.
+// The optional parameter "ScaleX" specifies the horizontal scale of graph
+// object, the default value of that is 1.0 which presents 100%.
 //
-// The optional parameter "ScaleX" specifies the horizontal scale of images,
+// The optional parameter "ScaleY" specifies the vertical scale of graph object,
 // the default value of that is 1.0 which presents 100%.
 //
-// The optional parameter "OffsetY" specifies the vertical offset of the
-// image with the cell, the default value of that is 0.
+// The optional parameter "Hyperlink" specifies the hyperlink of the graph
+// object.
 //
-// The optional parameter "ScaleY" specifies the vertical scale of images,
-// the default value of that is 1.0 which presents 100%.
+// The optional parameter "HyperlinkType" defines two types of
+// hyperlink "External" for website or "Location" for moving to one of the
+// cells in this workbook. When the "HyperlinkType" is "Location",
+// coordinates need to start with "#".
+//
+// The optional parameter "Positioning" defines 3 types of the position of a
+// graph object in a spreadsheet: "oneCell" (Move but don't size with
+// cells), "twoCell" (Move and size with cells), and "absolute" (Don't move or
+// size with cells). If you don't set this parameter, the default positioning
+// is to move and size with cells.
 func (f *File) AddPicture(sheet, cell, name string, opts *GraphicOptions) error {
 	var err error
 	// Check picture exists first.
@@ -330,6 +335,9 @@ func (f *File) addDrawingPicture(sheet, drawingXML, cell, ext string, rID, hyper
 	if err != nil {
 		return err
 	}
+	if opts.Positioning != "" && inStrSlice(supportedPositioning, opts.Positioning, true) == -1 {
+		return ErrParameterInvalid
+	}
 	width, height := img.Width, img.Height
 	if opts.AutoFit {
 		if width, height, col, row, err = f.drawingResize(sheet, cell, float64(width), float64(height), opts); err != nil {

picture_test.go

@@ -192,6 +192,8 @@ func TestAddDrawingPicture(t *testing.T) {
 	f := NewFile()
 	opts := &GraphicOptions{PrintObject: boolPtr(true), Locked: boolPtr(false)}
 	assert.EqualError(t, f.addDrawingPicture("sheet1", "", "A", "", 0, 0, image.Config{}, opts), newCellNameToCoordinatesError("A", newInvalidCellNameError("A")).Error())
+	// Test addDrawingPicture with invalid positioning types
+	assert.Equal(t, f.addDrawingPicture("sheet1", "", "A1", "", 0, 0, image.Config{}, &GraphicOptions{Positioning: "x"}), ErrParameterInvalid)
 
 	path := "xl/drawings/drawing1.xml"
 	f.Pkg.Store(path, MacintoshCyrillicCharset)

stream.go

@@ -38,14 +38,16 @@ type StreamWriter struct {
 	tableParts      string
 }
 
-// NewStreamWriter return stream writer struct by given worksheet name for
-// generate new worksheet with large amounts of data. Note that after set
-// rows, you must call the 'Flush' method to end the streaming writing process
-// and ensure that the order of row numbers is ascending, the normal mode
-// functions and stream mode functions can't be work mixed to writing data on
-// the worksheets, you can't get cell value when in-memory chunks data over
-// 16MB. For example, set data for worksheet of size 102400 rows x 50 columns
-// with numbers and style:
+// NewStreamWriter returns stream writer struct by given worksheet name used for
+// writing data on a new existing empty worksheet with large amounts of data.
+// Note that after writing data with the stream writer for the worksheet, you
+// must call the 'Flush' method to end the streaming writing process, ensure
+// that the order of row numbers is ascending when set rows, and the normal
+// mode functions and stream mode functions can not be work mixed to writing
+// data on the worksheets. The stream writer will try to use temporary files on
+// disk to reduce the memory usage when in-memory chunks data over 16MB, and
+// you can't get cell value at this time. For example, set data for worksheet
+// of size 102400 rows x 50 columns with numbers and style:
 //
 //	f := excelize.NewFile()
 //	defer func() {