Add optional value checking for CalcMode and RefMode calculation properties

- Add valid optional value prompt in error message for the functions: `AddFormControl`, `AddPicture` and `AddPictureFromBytes`
- Rename the internal error message function `newInvalidPageLayoutValueError` to `newInvalidOptionalValue`
- Update unit tests

Author: xuri

errors.go

@@ -14,6 +14,7 @@ package excelize
 import (
 	"errors"
 	"fmt"
+	"strings"
 )
 
 var (
@@ -255,10 +256,10 @@ func newInvalidNameError(name string) error {
 	return fmt.Errorf("invalid name %q, the name should be starts with a letter or underscore, can not include a space or character, and can not conflict with an existing name in the workbook", name)
 }
 
-// newInvalidPageLayoutValueError defined the error message on receiving the invalid
-// page layout options value.
-func newInvalidPageLayoutValueError(name, value, msg string) error {
-	return fmt.Errorf("invalid %s value %q, acceptable value should be one of %s", name, value, msg)
+// newInvalidOptionalValue defined the error message on receiving the invalid
+// optional value.
+func newInvalidOptionalValue(name, value string, values []string) error {
+	return fmt.Errorf("invalid %s value %q, acceptable value should be one of %s", name, value, strings.Join(values, ", "))
 }
 
 // newInvalidRowNumberError defined the error message on receiving the invalid

picture.go

@@ -355,7 +355,7 @@ func (f *File) addDrawingPicture(sheet, drawingXML, cell, ext string, rID, hyper
 		return err
 	}
 	if opts.Positioning != "" && inStrSlice(supportedPositioning, opts.Positioning, true) == -1 {
-		return ErrParameterInvalid
+		return newInvalidOptionalValue("Positioning", opts.Positioning, supportedPositioning)
 	}
 	width, height := img.Width, img.Height
 	if opts.AutoFit {

picture_test.go

@@ -290,7 +290,8 @@ func TestAddDrawingPicture(t *testing.T) {
 	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)
+	assert.Equal(t, newInvalidOptionalValue("Positioning", "x", supportedPositioning),
+		f.addDrawingPicture("sheet1", "", "A1", "", 0, 0, image.Config{}, &GraphicOptions{Positioning: "x"}))
 
 	path := "xl/drawings/drawing1.xml"
 	f.Pkg.Store(path, MacintoshCyrillicCharset)

sheet.go

@@ -1646,7 +1646,7 @@ func (ws *xlsxWorksheet) setPageSetUp(opts *PageLayoutOptions) error {
 	}
 	if opts.Orientation != nil {
 		if inStrSlice(supportedPageOrientation, *opts.Orientation, true) == -1 {
-			return newInvalidPageLayoutValueError("Orientation", *opts.Orientation, strings.Join(supportedPageOrientation, ", "))
+			return newInvalidOptionalValue("Orientation", *opts.Orientation, supportedPageOrientation)
 		}
 		ws.newPageSetUp()
 		ws.PageSetUp.Orientation = *opts.Orientation
@@ -1677,7 +1677,7 @@ func (ws *xlsxWorksheet) setPageSetUp(opts *PageLayoutOptions) error {
 	}
 	if opts.PageOrder != nil {
 		if inStrSlice(supportedPageOrder, *opts.PageOrder, true) == -1 {
-			return newInvalidPageLayoutValueError("PageOrder", *opts.PageOrder, strings.Join(supportedPageOrder, ", "))
+			return newInvalidOptionalValue("PageOrder", *opts.PageOrder, supportedPageOrder)
 		}
 		ws.newPageSetUp()
 		ws.PageSetUp.PageOrder = *opts.PageOrder

templates.go

@@ -476,6 +476,12 @@ var supportedImageTypes = map[string]string{
 	".tif": ".tiff", ".tiff": ".tiff", ".wmf": ".wmf", ".wmz": ".wmz",
 }
 
+// supportedCalcMode defined supported formula calculate mode.
+var supportedCalcMode = []string{"manual", "auto", "autoNoTable"}
+
+// supportedRefMode defined supported formula calculate mode.
+var supportedRefMode = []string{"A1", "R1C1"}
+
 // supportedContentTypes defined supported file format types.
 var supportedContentTypes = map[string]string{
 	".xlam": ContentTypeAddinMacro,

vml.go

@@ -809,7 +809,7 @@ func (f *File) addFormCtrlShape(preset formCtrlPreset, col, row int, anchor stri
 	if opts.Format.Positioning != "" {
 		idx := inStrSlice(supportedPositioning, opts.Format.Positioning, true)
 		if idx == -1 {
-			return &sp, ErrParameterInvalid
+			return &sp, newInvalidOptionalValue("Positioning", opts.Format.Positioning, supportedPositioning)
 		}
 		sp.ClientData.MoveWithCells = []*string{stringPtr(""), nil, nil}[idx]
 		sp.ClientData.SizeWithCells = []*string{stringPtr(""), stringPtr(""), nil}[idx]

vml_test.go

@@ -271,10 +271,11 @@ func TestFormControl(t *testing.T) {
 		Cell: "A1", Type: FormControlButton, Macro: "Button1_Click",
 	}))
 	// Test add form control with invalid positioning types
-	assert.Equal(t, f.AddFormControl("Sheet1", FormControl{
-		Cell: "A1", Type: FormControlButton,
-		Format: GraphicOptions{Positioning: "x"},
-	}), ErrParameterInvalid)
+	assert.Equal(t, newInvalidOptionalValue("Positioning", "x", supportedPositioning),
+		f.AddFormControl("Sheet1", FormControl{
+			Cell: "A1", Type: FormControlButton,
+			Format: GraphicOptions{Positioning: "x"},
+		}))
 	// Test add spin form control with illegal cell link reference
 	assert.Equal(t, f.AddFormControl("Sheet1", FormControl{
 		Cell: "C5", Type: FormControlSpinButton, CellLink: "*",

workbook.go

@@ -53,7 +53,9 @@ func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error) {
 	return opts, err
 }
 
-// SetCalcProps provides a function to sets calculation properties.
+// SetCalcProps provides a function to sets calculation properties. Optional
+// value of "CalcMode" property is: "manual", "auto" or "autoNoTable". Optional
+// value of "RefMode" property is: "A1" or "R1C1".
 func (f *File) SetCalcProps(opts *CalcPropsOptions) error {
 	if opts == nil {
 		return nil
@@ -65,6 +67,12 @@ func (f *File) SetCalcProps(opts *CalcPropsOptions) error {
 	if wb.CalcPr == nil {
 		wb.CalcPr = new(xlsxCalcPr)
 	}
+	if opts.CalcMode != nil && inStrSlice(supportedCalcMode, *opts.CalcMode, true) == -1 {
+		return newInvalidOptionalValue("CalcMode", *opts.CalcMode, supportedCalcMode)
+	}
+	if opts.RefMode != nil && inStrSlice(supportedRefMode, *opts.RefMode, true) == -1 {
+		return newInvalidOptionalValue("RefMode", *opts.RefMode, supportedRefMode)
+	}
 	setNoPtrFieldsVal([]string{
 		"CalcCompleted", "CalcOnSave", "ForceFullCalc", "FullCalcOnLoad", "FullPrecision", "Iterate",
 		"IterateDelta",

workbook_test.go

@@ -57,11 +57,14 @@ func TestCalcProps(t *testing.T) {
 	opts, err = f.GetCalcProps()
 	assert.NoError(t, err)
 	assert.Equal(t, CalcPropsOptions{}, opts)
-	// Test set workbook properties with unsupported charset workbook
+	// Test set calculation properties with unsupported optional value
+	assert.Equal(t, newInvalidOptionalValue("CalcMode", "AUTO", supportedCalcMode), f.SetCalcProps(&CalcPropsOptions{CalcMode: stringPtr("AUTO")}))
+	assert.Equal(t, newInvalidOptionalValue("RefMode", "a1", supportedRefMode), f.SetCalcProps(&CalcPropsOptions{RefMode: stringPtr("a1")}))
+	// Test set calculation properties with unsupported charset workbook
 	f.WorkBook = nil
 	f.Pkg.Store(defaultXMLPathWorkbook, MacintoshCyrillicCharset)
 	assert.EqualError(t, f.SetCalcProps(&expected), "XML syntax error on line 1: invalid UTF-8")
-	// Test get workbook properties with unsupported charset workbook
+	// Test get calculation properties with unsupported charset workbook
 	f.WorkBook = nil
 	f.Pkg.Store(defaultXMLPathWorkbook, MacintoshCyrillicCharset)
 	_, err = f.GetCalcProps()