errors.go

package goods

import (
	"errors"
	"fmt"
)

// Sentinel errors returned by the package. Callers may compare with errors.Is.
var (
	ErrSheetNotFound             = errors.New("goods: sheet not found")
	ErrSheetExists               = errors.New("goods: sheet already exists")
	ErrSheetNameEmpty            = errors.New("goods: sheet name cannot be empty")
	ErrNoSheets                  = errors.New("goods: workbook must have at least one sheet")
	ErrInvalidCell               = errors.New("goods: invalid cell reference")
	ErrInvalidCoords             = errors.New("goods: invalid coordinates")
	ErrColumnOutOfRange          = errors.New("goods: column number out of range")
	ErrRowOutOfRange             = errors.New("goods: row number out of range")
	ErrMergeOverlap              = errors.New("goods: merge range overlaps with existing merge")
	ErrMergeNotFound             = errors.New("goods: merge range not found")
	ErrStyleNotFound             = errors.New("goods: style not found")
	ErrFileClosed                = errors.New("goods: file is closed")
	ErrInvalidODS                = errors.New("goods: invalid ODS file")
	ErrUnsupportedType           = errors.New("goods: unsupported value type")
	ErrCircularReference         = errors.New("goods: circular reference detected")
	ErrNamedRangeNotFound        = errors.New("goods: named range not found")
	ErrNamedRangeExists          = errors.New("goods: named range already exists")
	ErrValidationNotFound        = errors.New("goods: data validation not found")
	ErrAutoFilterExists          = errors.New("goods: auto-filter already exists on this sheet")
	ErrAutoFilterNotFound        = errors.New("goods: auto-filter not found")
	ErrConditionalFormatNotFound = errors.New("goods: conditional format not found")
)

// CellError wraps an underlying error with the sheet name and cell reference
// where the failure occurred. The wrapped error is accessible via errors.Unwrap.
type CellError struct {
	Sheet string
	Cell  string
	Err   error
}

// Error returns the error message including the sheet and, when available, the cell reference.
func (e *CellError) Error() string {
	if e.Cell != "" {
		return fmt.Sprintf("sheet %q cell %s: %v", e.Sheet, e.Cell, e.Err)
	}
	return fmt.Sprintf("sheet %q: %v", e.Sheet, e.Err)
}

// Unwrap returns the underlying error for use with errors.Is and errors.As.
func (e *CellError) Unwrap() error {
	return e.Err
}

func sheetErr(sheet string, err error) *CellError {
	return &CellError{Sheet: sheet, Err: err}
}

func cellErr(sheet, cell string, err error) *CellError {
	return &CellError{Sheet: sheet, Cell: cell, Err: err}
}