eql

README

eql

Sheet functions in Go inspired by Google sheet functions

eql is designed to execute functions in sheet file in Go application.

Install

go get github.com/qunv/eql

Usage

import (
	"github.com/qunv/eql"
)


func initData() [][]string {
    // open file
    f, err := os.Open("test.csv")
    if err != nil {
        log.Fatal(err)
    }
    
    defer f.Close()
    records, _ := csv.NewReader(f).ReadAll()
    return records
}

func main() {
	input := initData()
	parser := eql.NewEqlParser(input)
	eql := "SUM(A1:B2; 1; AVG(A1:B2; C2); ADD(D3; 4))"
	result, err := parser.Exec(eql)
	if err != nil {
		// handle err
    }
	//hande result
}

Functions

List of functions are supported currently, happy to contribute.

Math

SUM

Returns the sum of a series of numbers and/or cells

Sample usage

SUM(A2:A100)

SUM(1,2,3,4,5)

SUM(1,2,A2:A50)

SUM(1,SUM(A1:A3, 1), 2+A3)

Syntax

SUM(value1, [value2, ...])

• value1 - The first number or range to add together.

• value2, ... - [ OPTIONAL ] - Additional numbers or ranges to add to value1.

Example

data

A	B	C
1	3	5
2	4	6

Formula	result
SUM(4, 2)	6
SUM(A1, B1)	4
SUM(A1:B2)	10
SUM(A1:B2, SUM(3, C1))	18

ABS

Returns the absolute value of a number.

Sample usage

ABS(-2)

ABS(A2)

Syntax

ABS(value)

• value - The number of which to return the absolute value.

Example

Formula	result
ABS(-1)	1
ABS(A1)	1

Operator

ADD

Returns the sum of two numbers. Equivalent to the + operator.

Sample usage

ADD(A2,A3)

ADD(3,4)

ADD(3,ADD(A2, A3))

Syntax

ADD(value1, value2)

• value1 - The first addend.

• value2 - The second addend.

Example

Formula	result
ADD(-1, 2)	1

AVG

Returns the average of a series of numbers and/or cells

Sample usage

AVG(A2:A100)

AVG(1,2,3,4,5)

AVG(1,2,A2:A50)

AVG(1,AVG(A1:A3, 1), 2+A3)

Syntax

AVG(value1, [value2, ...])

• value1 - The first number or range to add together.

• value2, ... - [ OPTIONAL ] - Additional numbers or ranges to add to value1.

Example

Formula	result
AVG(1, 2, 3)	2

CONCAT

Returns the concatenation of two values. Equivalent to the & operator.

Sample usage

CONCAT("foo","bar")

CONCAT(17,76)

Syntax

CONCAT(value1, value2)

• value1 - The value to which value2 will be appended.

• value2 - The value to append to value1.

Example

Formula	result
CONCAT("foo", "bar")	foobar
CONCAT(1, 2)	12

DIVIDE

Returns one number divided by another. Equivalent to the / operator.

Sample usage

DIVIDE(4,2)

DIVIDE(A2,B2)

Syntax

DIVIDE(dividend, divisor)

• dividend - The number to be divided.

• divisor - The number to divide by.

  • divisor cannot equal 0.

Example

Formula	result
DIVIDE(4, 2)	2
CONCAT(5, 2)	2.5

EQ

Returns "TRUE" if two specified values are equal and "FALSE" otherwise. Equivalent to the "=" operator.

Sample usage

EQ(A2,A3)

EQ(2,3)

Syntax

EQ(value1, value2)

• value1 - The first value.

• value2 - The value to test against value1 for equality.

Example

Formula	result
EQ(4, 2)	FALSE
EQ(2, 2)	TRUE

MULTIPLY

Returns the product of two numbers. Equivalent to the * operator.

Sample usage

MULTIPLY(A2,B2)

MULTIPLY(2,3)

Syntax

MULTIPLY(factor1, factor2)

• factor1 - The first multiplicand.

• factor2 - The second multiplicand.

Example

Formula	result
MULTIPLY(4, 2)	8

GTE

Returns TRUE if the first argument is greater than or equal to the second, and FALSE otherwise. Equivalent to the >= operator.

Sample usage

GTE(A2,A3)

GTE(2,3)

Syntax

GTE(value1, value2)

• value1 - The value to test as being greater than or equal to value2.

• value2 - The second value.

Example

Formula	result
GTE(4, 2)	TRUE

GT

Returns TRUE if the first argument is greater than to the second, and FALSE otherwise. Equivalent to the > operator.

Sample usage

GT(A2,A3)

GT(2,3)

Syntax

GT(value1, value2)

• value1 - The value to test as being greater than to value2.

• value2 - The second value.

Example

Formula	result
GT(4, 2)	TRUE

Logical

IF

Returns one value if a logical expression is TRUE and another if it is FALSE

Sample usage

IF(A2 = "foo","A2 is foo")

IF(A2,"A2 was true","A2 was false")

IF(TRUE,4,5)

Syntax

IF(logical_expression, value_if_true, value_if_false)

• logical_expression - An expression or reference to a cell containing an expression that represents some logical value, i.e. TRUE or FALSE.

• value_if_true - The value the function returns if logical_expression is TRUE.

• value_if_false - The value the function returns if logical_expression is FALSE.

Example

Formula	result
IF(FALSE, 1, "false ne")	false ne
IF(TRUE=TRUE, 1, 2)	1
IF(TRUE=TRUE, 1, 2)	1
IF(1>SUM(1, 2), 1, 2)	2

Contribute

This repo is required antlr to define grammar, make sure install it, change your own EqlLexer.g4 and EqlParser.g4 then run make run first

• Fork repository
• Create a feature branch
• Open a new pull request
• Create an issue for bug report or feature request

License

The MIT License (MIT). Please see LICENSE for more information.

Documentation

Index

• type Parser
  • func NewEqlParser(input [][]string) *Parser
  • func (p *Parser) Exec(q string) (val.EqlValue, error)
  • func (p *Parser) Execf(filepath string) error

Types

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

func NewEqlParser

func NewEqlParser(input [][]string) *Parser

func (*Parser) Exec

func (p *Parser) Exec(q string) (val.EqlValue, error)

func (*Parser) Execf

func (p *Parser) Execf(filepath string) error