functions

Documentation

Index

• Variables
• func All(validators ...Validator) *all
• func AllArgs(validator SingleArgumentValidator) *allArgs
• func Arg(i int, validator SingleArgumentValidator) *arg
• func AtLeastNArgs(n int) *atLeastNArgs
• func AtMostNArgs(n int) *atMostNArgs
• func ExactlyNArgs(n int) *exactlyNArgs
• func IfArgPresent(i int, validator Validator) *ifArgPresent
• func OneOf(validators ...Validator) *oneOf
• func SingleAll(validators ...SingleArgumentValidator) *singleAll
• func SingleOneOf(validators ...SingleArgumentValidator) *singleOneOf
• func TypeOf(wantedType octosql.Value) *typeOf
• func ValueOf(values ...octosql.Value) *valueOf
• type SingleArgumentValidator

Variables

var FuncAbs = execution.Function{
	Name: "abs",
	ArgumentNames: [][]string{
		{"x"},
	},
	Description: docs.Text("Returns the absolute value of x."),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0,
			SingleOneOf(
				TypeOf(ZeroInt()),
				TypeOf(ZeroFloat()),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[0]
		switch arg.GetType() {
		case TypeInt:
			asInt := arg.AsInt()
			if asInt < 0 {
				return MakeInt(-1 * asInt), nil
			}
			return arg, nil
		case TypeFloat:
			asFloat := arg.AsFloat()
			if asFloat < 0.0 {
				return MakeFloat(-1.0 * asFloat), nil
			}
			return arg, nil
		case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeDuration, TypeTuple, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(arg).String())
		}
		panic("unreachable")
	},
}

var FuncAdd = execution.Function{
	Name: "+",
	ArgumentNames: [][]string{
		{"left", "right"},
	},
	Description: docs.Text("Returns the sum of the two arguments."),
	Validator: OneOf(
		All(
			AtLeastNArgs(1),
			AtMostNArgs(2),
			OneOf(
				AllArgs(TypeOf(ZeroInt())),
				AllArgs(TypeOf(ZeroFloat())),
				AllArgs(TypeOf(ZeroDuration())),
			),
		),
		All(
			ExactlyNArgs(2),
			Arg(0, TypeOf(ZeroTime())),
			Arg(1, TypeOf(ZeroDuration())),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		switch len(args) {
		case 1:
			switch args[0].GetType() {
			case TypeInt, TypeFloat, TypeDuration:
				return args[0], nil
			case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeTuple, TypeObject:
				log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
			}
			panic("unreachable")

		case 2:
			switch args[0].GetType() {
			case TypeInt:
				return MakeInt(args[0].AsInt() + args[1].AsInt()), nil
			case TypeFloat:
				return MakeFloat(args[0].AsFloat() + args[1].AsFloat()), nil
			case TypeDuration:
				return MakeDuration(args[0].AsDuration() + args[1].AsDuration()), nil
			case TypeTime:
				return MakeTime(args[0].AsTime().Add(args[1].AsDuration())), nil
			case TypeNull, TypePhantom, TypeBool, TypeString, TypeTuple, TypeObject:
				log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
			}
			panic("unreachable")

		default:
			log.Fatalf("unexpected argument count in function: %v", len(args))
			panic("unreachable")
		}
	},
}

var FuncCapitalize = execution.Function{
	Name: "capitalize",
	ArgumentNames: [][]string{
		{"text"},
	},
	Description: docs.Text("Returns the text with all words capitalized."),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0, TypeOf(ZeroString())),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[0].AsString()
		arg = strings.ToLower(arg)
		arg = strings.Title(arg)
		return MakeString(arg), nil
	},
}

var FuncCeil = execution.Function{
	Name: "ceil",
	ArgumentNames: [][]string{
		{"x"},
	},
	Description: docs.Text("Returns the ceiling of x."),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0,
			SingleOneOf(
				TypeOf(ZeroInt()),
				TypeOf(ZeroFloat()),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[0]
		switch arg.GetType() {
		case TypeInt:
			return MakeFloat(float64(arg.AsInt())), nil
		case TypeFloat:
			return MakeFloat(math.Ceil(arg.AsFloat())), nil
		case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeDuration, TypeTuple, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(arg).String())
		}
		panic("unreachable")
	},
}

var FuncCoalesce = execution.Function{
	Name: "coalesce",
	ArgumentNames: [][]string{
		{"...args"},
	},
	Description: docs.List(
		docs.Text("Returns the first non-null argument, or null if there isn't any."),
	),
	Validator: All(
		AtLeastNArgs(1),
	),
	Logic: func(args ...Value) (Value, error) {
		for i := range args {
			switch args[i].GetType() {
			case TypeNull:
				continue
			case TypePhantom, TypeInt, TypeFloat, TypeBool, TypeString, TypeTime, TypeDuration, TypeTuple, TypeObject:
				return args[i], nil
			}
			panic("unreachable")
		}

		return MakeNull(), nil
	},
}

var FuncContains = execution.Function{
	Name: "contains",
	ArgumentNames: [][]string{
		{"substring", "text"},
		{"element", "tuple"},
	},
	Description: docs.List(
		docs.Text("Provided a String, returns whether it contains the given substring."),
		docs.Text("Provided a Tuple, returns whether it contains the given element. "),
	),
	Validator: All(
		ExactlyNArgs(2),
		OneOf(
			AllArgs(TypeOf(ZeroString())),
			Arg(1, TypeOf(ZeroTuple())),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[1]
		switch arg.GetType() {
		case TypeString:
			return MakeBool(
				strings.Contains(
					args[1].AsString(),
					args[0].AsString(),
				),
			), nil
		case TypeTuple:
			for _, el := range arg.AsSlice() {
				if AreEqual(el, args[0]) {
					return MakeBool(true), nil
				}
			}
			return MakeBool(false), nil
		case TypeNull, TypePhantom, TypeInt, TypeFloat, TypeBool, TypeTime, TypeDuration, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
		}
		panic("unreachable")
	},
}

var FuncDecodeBase32 = execution.Function{
	Name: "decode_base32",
	ArgumentNames: [][]string{
		{"text"},
	},
	Description: docs.List(
		docs.Text("Decodes the text from Base32. Especially useful when using a datasource which stores text as byte fields."),
	),
	Validator: All(
		ExactlyNArgs(1),
		AllArgs(TypeOf(ZeroString())),
	),
	Logic: func(args ...Value) (Value, error) {
		data, err := base32.StdEncoding.DecodeString(args[0].AsString())
		if err != nil {
			return ZeroValue(), errors.Wrap(err, "couldn't decode base32")
		}

		return MakeString(string(data)), nil
	},
}

var FuncDivide = execution.Function{
	Name: "/",
	ArgumentNames: [][]string{
		{"left", "right"},
	},
	Description: docs.Text("Returns the division of the two arguments."),
	Validator: All(
		ExactlyNArgs(2),
		OneOf(
			AllArgs(TypeOf(ZeroInt())),
			AllArgs(TypeOf(ZeroFloat())),
			All(
				Arg(0, TypeOf(ZeroDuration())),
				Arg(1, TypeOf(ZeroInt())),
			),
			All(
				Arg(0, TypeOf(ZeroDuration())),
				Arg(1, TypeOf(ZeroFloat())),
			),
			All(
				Arg(0, TypeOf(ZeroDuration())),
				Arg(1, TypeOf(ZeroDuration())),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		switch args[0].GetType() {
		case TypeInt:
			if args[1].AsInt() == 0 {
				return ZeroValue(), fmt.Errorf("division by zero")
			}
			return MakeInt(args[0].AsInt() / args[1].AsInt()), nil
		case TypeFloat:
			return MakeFloat(args[0].AsFloat() / args[1].AsFloat()), nil
		case TypeDuration:
			switch args[1].GetType() {
			case TypeInt:
				if args[1].AsInt() == 0 {
					return ZeroValue(), fmt.Errorf("division by zero")
				}
				return MakeDuration(args[0].AsDuration() / time.Duration(args[1].AsInt())), nil

			case TypeFloat:
				return MakeDuration(args[0].AsDuration() / time.Duration(args[1].AsFloat())), nil

			case TypeDuration:
				return MakeFloat(float64(args[0].AsDuration()) / float64(args[1].AsDuration())), nil

			case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeTuple, TypeObject:
				log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[1]).String())
			}
			panic("unreachable")

		case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeTuple, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
		}
		panic("unreachable")
	},
}

var FuncDuration = execution.Function{
	Name: "duration",
	ArgumentNames: [][]string{
		{"duration"},
		{"count", "unit"},
	},
	Description: docs.List(
		docs.Text("Provided one argument, parses the duration as in https://golang.org/pkg/time/#ParseDuration"),
		docs.Text("Provided two arguments, returns the duration equal to count of unit."),
	),
	Validator: OneOf(
		All(
			ExactlyNArgs(1),
			Arg(0, TypeOf(ZeroString())),
		),
		All(
			ExactlyNArgs(2),
			Arg(0, TypeOf(ZeroInt())),
			Arg(1,
				SingleAll(
					TypeOf(ZeroString()),
					ValueOf(
						MakeString("nanosecond"),
						MakeString("microsecond"),
						MakeString("millisecond"),
						MakeString("second"),
						MakeString("minute"),
						MakeString("hour"),
						MakeString("day"),
						MakeString("month"),
					),
				),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		switch len(args) {
		case 1:
			dur, err := time.ParseDuration(args[0].AsString())
			if err != nil {
				return ZeroValue(), errors.Wrap(err, "couldn't parse duration")
			}
			return MakeDuration(dur), nil

		case 2:
			count := time.Duration(args[0].AsInt())
			switch args[1].AsString() {
			case "nanosecond":
				return MakeDuration(count), nil
			case "microsecond":
				return MakeDuration(count * time.Microsecond), nil
			case "millisecond":
				return MakeDuration(count * time.Millisecond), nil
			case "second":
				return MakeDuration(count * time.Second), nil
			case "minute":
				return MakeDuration(count * time.Minute), nil
			case "hour":
				return MakeDuration(count * time.Hour), nil
			case "day":
				return MakeDuration(count * time.Hour * 24), nil
			default:
				log.Fatalf("unexpected value in function: %v", args[1])
				panic("unreachable")
			}

		default:
			log.Fatalf("unexpected argument count in function: %v", len(args))
			panic("unreachable")
		}
	},
}

var FuncFloat = execution.Function{
	Name: "float",
	ArgumentNames: [][]string{
		{"x"},
	},
	Description: docs.Text("Converts x to a Float."),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0,
			SingleOneOf(
				TypeOf(ZeroBool()),
				TypeOf(ZeroInt()),
				TypeOf(ZeroFloat()),
				TypeOf(ZeroString()),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[0]
		switch arg.GetType() {
		case TypeInt:
			return MakeFloat(float64(arg.AsInt())), nil
		case TypeFloat:
			return arg, nil
		case TypeBool:
			if arg.AsBool() {
				return MakeFloat(1.0), nil
			}
			return MakeFloat(0.0), nil
		case TypeString:
			number, err := strconv.ParseFloat(arg.AsString(), 64)
			if err != nil {
				return ZeroValue(), err
			}
			return MakeFloat(number), nil
		case TypeNull, TypePhantom, TypeTime, TypeDuration, TypeTuple, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(arg).String())
		}
		panic("unreachable")
	},
}

var FuncFloor = execution.Function{
	Name: "floor",
	ArgumentNames: [][]string{
		{"x"},
	},
	Description: docs.Text("Returns the floor of x."),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0,
			SingleOneOf(
				TypeOf(ZeroInt()),
				TypeOf(ZeroFloat()),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[0]
		switch arg.GetType() {
		case TypeInt:
			return MakeFloat(float64(arg.AsInt())), nil
		case TypeFloat:
			return MakeFloat(math.Floor(arg.AsFloat())), nil
		case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeDuration, TypeTuple, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(arg).String())
		}
		panic("unreachable")
	},
}

var FuncGreatest = execution.Function{
	Name: "greatest",
	ArgumentNames: [][]string{
		{"...xs"},
	},
	Description: docs.Text("Returns the greatest argument."),
	Validator: All(
		AtLeastNArgs(1),
		OneOf(
			AllArgs(TypeOf(ZeroInt())),
			AllArgs(TypeOf(ZeroFloat())),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		switch args[0].GetType() {
		case TypeInt:
			max := math.MinInt64
			for _, arg := range args {
				max = intMax(max, arg.AsInt())
			}

			return MakeInt(max), nil
		case TypeFloat:
			max := math.Inf(-1)
			for _, arg := range args {
				max = math.Max(max, arg.AsFloat())
			}

			return MakeFloat(max), nil
		case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeDuration, TypeTuple, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
		}
		panic("unreachable")
	},
}

var FuncHasPrefix = execution.Function{
	Name: "hasprefix",
	ArgumentNames: [][]string{
		{"prefix", "text"},
	},
	Description: docs.Text("Returns whether the text begins with prefix."),
	Validator: All(
		ExactlyNArgs(2),
		AllArgs(TypeOf(ZeroString())),
	),
	Logic: func(args ...Value) (Value, error) {
		return MakeBool(
			strings.HasPrefix(
				args[1].AsString(),
				args[0].AsString(),
			),
		), nil
	},
}

var FuncHasSuffix = execution.Function{
	Name: "hassuffix",
	ArgumentNames: [][]string{
		{"suffix", "text"},
	},
	Description: docs.Text("Returns whether the text ends with suffix."),
	Validator: All(
		ExactlyNArgs(2),
		AllArgs(TypeOf(ZeroString())),
	),
	Logic: func(args ...Value) (Value, error) {
		return MakeBool(
			strings.HasSuffix(
				args[1].AsString(),
				args[0].AsString(),
			),
		), nil
	},
}

var FuncIndex = execution.Function{
	Name: "index",
	ArgumentNames: [][]string{
		{"substring", "text"},
		{"element", "tuple"},
	},
	Description: docs.List(
		docs.Text("Provided a String, returns the index of the substring in the text, or -1 if the text doesn't contain it."),
		docs.Text("Provided a Tuple, returns the index of the element in the tuple, or -1 if the tuple doesn't contain it."),
	),
	Validator: All(
		ExactlyNArgs(2),
		OneOf(
			AllArgs(TypeOf(ZeroString())),
			Arg(1, TypeOf(ZeroTuple())),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[1]
		switch arg.GetType() {
		case TypeString:
			return MakeInt(
				strings.Index(
					args[1].AsString(),
					args[0].AsString(),
				),
			), nil
		case TypeTuple:
			for i, el := range arg.AsSlice() {
				if AreEqual(el, args[0]) {
					return MakeInt(i), nil
				}
			}
			return MakeInt(-1), nil
		case TypeNull, TypePhantom, TypeInt, TypeFloat, TypeBool, TypeTime, TypeDuration, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
		}
		panic("unreachable")
	},
}

var FuncInt = execution.Function{
	Name: "int",
	ArgumentNames: [][]string{
		{"x"},
	},
	Description: docs.Text("Converts x to an Integer."),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0,
			SingleOneOf(
				TypeOf(ZeroBool()),
				TypeOf(ZeroInt()),
				TypeOf(ZeroFloat()),
				TypeOf(ZeroString()),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[0]
		switch arg.GetType() {
		case TypeBool:
			if arg.AsBool() {
				return MakeInt(1), nil
			}
			return MakeInt(0), nil
		case TypeInt:
			return arg, nil
		case TypeFloat:
			return MakeInt(int(arg.AsFloat())), nil
		case TypeString:
			number, err := strconv.Atoi(arg.AsString())
			if err != nil {
				return ZeroValue(), err
			}
			return MakeInt(number), nil
		case TypeNull, TypePhantom, TypeTime, TypeDuration, TypeTuple, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(arg).String())
		}
		panic("unreachable")
	},
}

var FuncLeast = execution.Function{
	Name: "least",
	ArgumentNames: [][]string{
		{"...xs"},
	},
	Description: docs.Text("Returns the least argument."),
	Validator: All(
		AtLeastNArgs(1),
		OneOf(
			AllArgs(TypeOf(ZeroInt())),
			AllArgs(TypeOf(ZeroFloat())),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		switch args[0].GetType() {
		case TypeInt:
			min := math.MaxInt64
			for _, arg := range args {
				min = intMin(min, arg.AsInt())
			}

			return MakeInt(min), nil
		case TypeFloat:
			min := math.Inf(1)
			for _, arg := range args {
				min = math.Min(min, arg.AsFloat())
			}

			return MakeFloat(min), nil
		case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeDuration, TypeTuple, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
		}
		panic("unreachable")
	},
}

Multiple numbers functions

var FuncLength = execution.Function{
	Name: "length",
	ArgumentNames: [][]string{
		{"seq"},
	},
	Description: docs.Text("Returns the length of the given Tuple or String."),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0,
			SingleOneOf(
				TypeOf(ZeroString()),
				TypeOf(ZeroTuple()),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[0]
		switch arg.GetType() {
		case TypeString:
			return MakeInt(len(arg.AsString())), nil
		case TypeTuple:
			return MakeInt(len(arg.AsSlice())), nil
		case TypeNull, TypePhantom, TypeInt, TypeFloat, TypeBool, TypeTime, TypeDuration, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
		}
		panic("unreachable")
	},
}

var FuncLn = execution.Function{
	Name: "ln",
	ArgumentNames: [][]string{
		{"x"},
	},
	Description: docs.Text("Returns the natural logarithm of x."),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0,
			SingleOneOf(
				TypeOf(ZeroInt()),
				TypeOf(ZeroFloat()),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[0]
		switch arg.GetType() {
		case TypeInt:
			asInt := arg.AsInt()
			if asInt <= 0 {
				return ZeroValue(), fmt.Errorf("can't take ln of value %v", arg)
			}
			return MakeFloat(math.Log1p(float64(asInt)) - 1), nil
		case TypeFloat:
			asFloat := arg.AsFloat()
			if asFloat <= 0.0 {
				return ZeroValue(), fmt.Errorf("can't take ln of value %v", arg)
			}
			return MakeFloat(math.Log1p(asFloat) - 1), nil
		case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeDuration, TypeTuple, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
		}
		panic("unreachable")
	},
}

var FuncLog2 = execution.Function{
	Name: "log2",
	ArgumentNames: [][]string{
		{"x"},
	},
	Description: docs.Text("Returns the logarithm base 2 of x."),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0,
			SingleOneOf(
				TypeOf(ZeroInt()),
				TypeOf(ZeroFloat()),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[0]
		switch arg.GetType() {
		case TypeInt:
			asInt := arg.AsInt()
			if asInt <= 0 {
				return ZeroValue(), fmt.Errorf("can't take log of value %v", arg)
			}
			return MakeFloat(math.Log2(float64(asInt))), nil
		case TypeFloat:
			asFloat := arg.AsFloat()
			if asFloat <= 0.0 {
				return ZeroValue(), fmt.Errorf("can't take log of value %v", arg)
			}
			return MakeFloat(math.Log2(asFloat)), nil
		case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeDuration, TypeTuple, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
		}
		panic("unreachable")
	},
}

var FuncLower = execution.Function{
	Name: "lowercase",
	ArgumentNames: [][]string{
		{"text"},
	},
	Description: docs.Text("Returns the text in lowercase."),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0, TypeOf(ZeroString())),
	),
	Logic: func(args ...Value) (Value, error) {
		return MakeString(strings.ToLower(args[0].AsString())), nil
	},
}

var FuncMultiply = execution.Function{
	Name: "*",
	ArgumentNames: [][]string{
		{"left", "right"},
	},
	Description: docs.Text("Returns the dot product of the two arguments."),
	Validator: All(
		ExactlyNArgs(2),
		OneOf(
			AllArgs(TypeOf(ZeroInt())),
			AllArgs(TypeOf(ZeroFloat())),
			All(
				Arg(0, TypeOf(ZeroDuration())),
				Arg(1, TypeOf(ZeroInt())),
			),
			All(
				Arg(0, TypeOf(ZeroDuration())),
				Arg(1, TypeOf(ZeroFloat())),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		switch args[0].GetType() {
		case TypeInt:
			return MakeInt(args[0].AsInt() * args[1].AsInt()), nil
		case TypeFloat:
			return MakeFloat(args[0].AsFloat() * args[1].AsFloat()), nil
		case TypeDuration:
			switch args[1].GetType() {
			case TypeInt:
				return MakeDuration(args[0].AsDuration() * time.Duration(args[1].AsInt())), nil
			case TypeFloat:
				return MakeDuration(time.Duration(float64(args[0].AsDuration()) * args[1].AsFloat())), nil
			case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeDuration, TypeTuple, TypeObject:
				log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[1]).String())
			}
			panic("unreachable")
		case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeTuple, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
		}
		panic("unreachable")
	},
}

var FuncNegate = execution.Function{
	Name: "negate",
	ArgumentNames: [][]string{
		{"x"},
	},
	Description: docs.Text("Returns x multiplied by -1."),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0,
			SingleOneOf(
				TypeOf(ZeroInt()),
				TypeOf(ZeroFloat()),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[0]
		switch arg.GetType() {
		case TypeInt:
			return MakeInt(-1 * arg.AsInt()), nil
		case TypeFloat:
			return MakeFloat(-1.0 * arg.AsFloat()), nil
		case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeDuration, TypeTuple, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(arg).String())
		}
		panic("unreachable")
	},
}

var FuncNow = execution.Function{
	Name: "now",
	ArgumentNames: [][]string{
		{""},
	},
	Description: docs.Text("Returns the current time."),
	Validator:   ExactlyNArgs(0),
	Logic: func(args ...Value) (Value, error) {
		return MakeTime(time.Now()), nil
	},
}

var FuncNth = execution.Function{
	Name: "nth",
	ArgumentNames: [][]string{
		{"n", "tuple"},
	},
	Description: docs.Text("Returns the element with index n in the tuple."),
	Validator: All(
		ExactlyNArgs(2),
		Arg(0, TypeOf(ZeroInt())),
		Arg(1, TypeOf(ZeroTuple())),
	),
	Logic: func(args ...Value) (Value, error) {
		if args[0].AsInt() > len(args[1].AsSlice()) {
			return ZeroValue(), fmt.Errorf(
				"tried to access element with index %v in tuple with length %v",
				args[0].AsInt(),
				len(args[1].AsSlice()),
			)
		}
		return args[1].AsSlice()[args[0].AsInt()], nil
	},
}

var FuncNullIf = execution.Function{
	Name: "nullif",
	ArgumentNames: [][]string{
		{"to_replace", "target"},
	},
	Description: docs.List(
		docs.Text("Returns null if target equals to_replace, returns target otherwise."),
	),
	Validator: All(
		ExactlyNArgs(2),
	),
	Logic: func(args ...Value) (Value, error) {
		if AreEqual(args[0], args[1]) {
			return MakeNull(), nil
		}

		return args[1], nil
	},
}

var FuncParseTime = execution.Function{
	Name: "parse_time",
	ArgumentNames: [][]string{
		{"format", "text"},
	},
	Description: docs.List(
		docs.Text("Parses the text using the time format given. The format argument should encode the date 'Mon Jan 2 15:04:05 -0700 MST 2006'."),
	),
	Validator: All(
		ExactlyNArgs(2),
		AllArgs(TypeOf(ZeroString())),
	),
	Logic: func(args ...Value) (Value, error) {
		t, err := time.Parse(args[0].AsString(), args[1].AsString())
		if err != nil {
			return ZeroValue(), errors.Wrap(err, "couldn't parse time")
		}

		return MakeTime(t), nil
	},
}

var FuncPower = execution.Function{
	Name: "power",
	ArgumentNames: [][]string{
		{"x", "exponent"},
	},
	Description: docs.Text("Returns x to the power of the exponent."),
	Validator: All(
		ExactlyNArgs(2),
		AllArgs(TypeOf(ZeroFloat())),
	),
	Logic: func(args ...Value) (Value, error) {
		return MakeFloat(math.Pow(args[0].AsFloat(), args[1].AsFloat())), nil
	},
}

var FuncRandFloat = execution.Function{
	Name: "randfloat",
	ArgumentNames: [][]string{
		{},
		{"max"},
		{"min", "max"},
	},
	Description: docs.List(
		docs.Text("Provided no arguments, returns a pseudo-random Float in [0.0,1.0)."),
		docs.Text("Provided one argument, returns a pseudo-random Float in [0.0,max)."),
		docs.Text("Provided two arguments, returns a pseudo-random Float in [min,max)."),
	),
	Validator: All(
		AtMostNArgs(2),
		AllArgs(TypeOf(ZeroInt())),
	),
	Logic: func(args ...Value) (Value, error) {
		switch len(args) {
		case 0:
			return MakeFloat(rand.Float64()), nil
		case 1:
			upper := float64(args[0].AsInt())
			return MakeFloat(upper * rand.Float64()), nil
		default:
			lower := float64(args[0].AsInt())
			upper := float64(args[1].AsInt())

			return MakeFloat(lower + (upper-lower)*rand.Float64()), nil
		}
	},
}

Other number functions

var FuncRandInt = execution.Function{
	Name: "randint",
	ArgumentNames: [][]string{
		{},
		{"max"},
		{"min", "max"},
	},
	Description: docs.List(
		docs.Text("Provided no arguments, returns a non-negative pseudo-random Int."),
		docs.Text("Provided one argument, returns a non-negative pseudo-random Int in [0,max)."),
		docs.Text("Provided two arguments, returns a pseudo-random Int in [min,max)."),
	),
	Validator: All(
		AtMostNArgs(2),
		AllArgs(TypeOf(ZeroInt())),
	),
	Logic: func(args ...Value) (Value, error) {
		switch len(args) {
		case 0:
			return MakeInt(rand.Int()), nil
		case 1:
			upper := args[0].AsInt()
			if upper <= 0 {
				return ZeroValue(), fmt.Errorf("Upper boundary for random integer must be greater than zero")
			}

			return MakeInt(rand.Intn(upper)), nil
		default:
			lower := args[0].AsInt()
			upper := args[1].AsInt()

			if upper <= lower {
				return ZeroValue(), fmt.Errorf("Upper bound for random integers must be greater than the lower bound")
			}

			return MakeInt(lower + rand.Intn(upper-lower)), nil
		}
	},
}

var FuncRegexpFind = execution.Function{
	Name: "regexp_find",
	ArgumentNames: [][]string{
		{"regexp", "text"},
	},
	Description: docs.Text("Returns the first match of regexp in the text."),
	Validator: All(
		ExactlyNArgs(2),
		AllArgs(TypeOf(ZeroString())),
	),
	Logic: func(args ...Value) (Value, error) {
		re, err := regexp.Compile(args[0].AsString())
		if err != nil {
			return ZeroValue(), fmt.Errorf("couldn't compile regular expression")
		}

		match := re.FindString(args[1].AsString())
		if match == "" {
			return MakeNull(), nil
		}

		return MakeString(match), nil
	},
}

var FuncRegexpMatches = execution.Function{
	Name: "regexp_matches",
	ArgumentNames: [][]string{
		{"regexp", "text"},
	},
	Description: docs.Text("Returns a boolean indicating if the text matches the given regular expression."),
	Validator: All(
		ExactlyNArgs(2),
		AllArgs(TypeOf(ZeroString())),
	),
	Logic: func(args ...Value) (Value, error) {
		re, err := regexp.Compile(args[0].AsString())
		if err != nil {
			return ZeroValue(), fmt.Errorf("couldn't compile regular expression")
		}

		return MakeBool(re.MatchString(args[1].AsString())), nil
	},
}

var FuncReplace = execution.Function{
	Name: "replace",
	ArgumentNames: [][]string{
		{"old", "new", "text"},
	},
	Description: docs.Text("Returns the text with all the instances of old replaced with new."),
	Validator: All(
		ExactlyNArgs(3),
		AllArgs(TypeOf(ZeroString())),
	),
	Logic: func(args ...Value) (Value, error) {
		return MakeString(
			strings.Replace(
				args[2].AsString(),
				args[0].AsString(),
				args[1].AsString(),
				-1),
		), nil
	},
}

var FuncReverse = execution.Function{
	Name: "reverse",
	ArgumentNames: [][]string{
		{"list"},
	},
	Description: docs.List(
		docs.Text("Provided a String, returns the reversed string."),
		docs.Text("Provided a Tuple, returns the elements in reverse order."),
	),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0,
			SingleOneOf(
				TypeOf(ZeroString()),
				TypeOf(ZeroTuple()),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[0]
		switch arg.GetType() {
		case TypeString:
			out := make([]rune, len(arg.AsString()))
			for i, el := range arg.AsString() {
				out[len(out)-i-1] = el
			}
			return MakeString(string(out)), nil
		case TypeTuple:
			out := make([]Value, len(arg.AsSlice()))
			for i, el := range arg.AsSlice() {
				out[len(out)-i-1] = el
			}
			return MakeTuple(out), nil
		case TypeNull, TypePhantom, TypeInt, TypeFloat, TypeBool, TypeTime, TypeDuration, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
		}
		panic("unreachable")
	},
}

var FuncSqrt = execution.Function{
	Name: "sqrt",
	ArgumentNames: [][]string{
		{"x"},
	},
	Description: docs.Text("Returns the square root of x."),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0,
			SingleOneOf(
				TypeOf(ZeroInt()),
				TypeOf(ZeroFloat()),
			),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		arg := args[0]
		switch arg.GetType() {
		case TypeInt:
			asInt := arg.AsInt()
			if asInt < 0 {
				return ZeroValue(), fmt.Errorf("can't take square root of value %v", arg)
			}
			return MakeFloat(math.Sqrt(float64(asInt))), nil
		case TypeFloat:
			asFloat := arg.AsFloat()
			if asFloat < 0 {
				return ZeroValue(), fmt.Errorf("can't take square root of value %v", arg)
			}
			return MakeFloat(math.Sqrt(asFloat)), nil
		case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeDuration, TypeTuple, TypeObject:
			log.Fatalf("unexpected type in function: %v", reflect.TypeOf(arg).String())
		}
		panic("unreachable")
	},
}

var FuncStringJoin = execution.Function{
	Name: "strjoin",
	ArgumentNames: [][]string{
		{"delimiter", "tuple"},
	},
	Description: docs.Text("Returns the elements of the string tuple joined into a string separated by the delimiter."),
	Validator: All(
		ExactlyNArgs(2),
		Arg(0, TypeOf(ZeroString())),
		Arg(1, TypeOf(ZeroTuple())),
	),
	Logic: func(args ...Value) (Value, error) {
		tup := args[1].AsSlice()
		out := make([]string, len(tup))
		for i := range tup {
			if tup[i].GetType() != TypeString {
				return ZeroValue(), fmt.Errorf("tuple element with index %v not string, got %v", i, tup[i])
			}
			out[i] = tup[i].AsString()
		}
		return MakeString(strings.Join(out, args[0].AsString())), nil
	},
}

var FuncSubstring = execution.Function{
	Name: "sub",
	ArgumentNames: [][]string{
		{"word", "begin"},
		{"word", "begin", "end"},
	},
	Description: docs.List(
		docs.Text("Provided two arguments, returns word[begin:]."),
		docs.Text("Provided three arguments, returns word[begin:end]."),
	),
	Validator: All(
		AtLeastNArgs(2),
		AtMostNArgs(3),
		Arg(0, TypeOf(ZeroString())),
		Arg(1, TypeOf(ZeroInt())),
		IfArgPresent(2, Arg(2, TypeOf(ZeroInt()))),
	),
	Logic: func(args ...Value) (Value, error) {
		str := args[0].AsString()
		start := args[1].AsInt()
		end := len(str)

		if len(args) == 3 {
			end = args[2].AsInt()
		}

		return MakeString(str[start:end]), nil
	},
}

var FuncSubtract = execution.Function{
	Name: "-",
	ArgumentNames: [][]string{
		{"left", "right"},
	},
	Description: docs.Text("Returns the difference between the two arguments."),
	Validator: OneOf(
		All(
			AtLeastNArgs(1),
			AtMostNArgs(2),
			OneOf(
				AllArgs(TypeOf(ZeroInt())),
				AllArgs(TypeOf(ZeroFloat())),
				AllArgs(TypeOf(ZeroDuration())),
			),
		),
		All(
			ExactlyNArgs(2),
			Arg(0, TypeOf(ZeroTime())),
			Arg(1, TypeOf(ZeroDuration())),
		),
	),
	Logic: func(args ...Value) (Value, error) {
		switch len(args) {
		case 1:
			switch args[0].GetType() {
			case TypeInt:
				return MakeInt(args[0].AsInt() * -1), nil
			case TypeFloat:
				return MakeFloat(args[0].AsFloat() * -1), nil
			case TypeDuration:
				return MakeDuration(args[0].AsDuration() * -1), nil
			case TypeNull, TypePhantom, TypeBool, TypeString, TypeTime, TypeTuple, TypeObject:
				log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
			}
			panic("unreachable")

		case 2:
			switch args[0].GetType() {
			case TypeInt:
				return MakeInt(args[0].AsInt() - args[1].AsInt()), nil
			case TypeFloat:
				return MakeFloat(args[0].AsFloat() - args[1].AsFloat()), nil
			case TypeDuration:
				return MakeDuration(args[0].AsDuration() - args[1].AsDuration()), nil
			case TypeTime:
				return MakeTime(args[0].AsTime().Add(-1 * args[1].AsDuration())), nil
			case TypeNull, TypePhantom, TypeBool, TypeString, TypeTuple, TypeObject:
				log.Fatalf("unexpected type in function: %v", reflect.TypeOf(args[0]).String())
			}
			panic("unreachable")

		default:
			log.Fatalf("unexpected argument count in function: %v", len(args))
			panic("unreachable")
		}
	},
}

var FuncUpper = execution.Function{
	Name: "uppercase",
	ArgumentNames: [][]string{
		{"text"},
	},
	Description: docs.Text("Returns the text in uppercase."),
	Validator: All(
		ExactlyNArgs(1),
		Arg(0, TypeOf(ZeroString())),
	),
	Logic: func(args ...Value) (Value, error) {
		return MakeString(strings.ToUpper(args[0].AsString())), nil
	},
}

var FunctionTable = map[string]*execution.Function{}

The only legal functions are the ones that appear in this

table. Otherwise the function will be considered undefined and will throw an error on physical -> execution conversion. IMPORTANT: As of now the lookup is case sensitive, so the functions must be stored in lowercase, and the user must input them as lowercase as well.

Functions

func All

func All(validators ...Validator) *all

func AllArgs

func AllArgs(validator SingleArgumentValidator) *allArgs

func Arg

func Arg(i int, validator SingleArgumentValidator) *arg

func AtLeastNArgs

func AtLeastNArgs(n int) *atLeastNArgs

func AtMostNArgs

func AtMostNArgs(n int) *atMostNArgs

func ExactlyNArgs

func ExactlyNArgs(n int) *exactlyNArgs

func IfArgPresent

func IfArgPresent(i int, validator Validator) *ifArgPresent

func OneOf

func OneOf(validators ...Validator) *oneOf

func SingleAll

func SingleAll(validators ...SingleArgumentValidator) *singleAll

func SingleOneOf

func SingleOneOf(validators ...SingleArgumentValidator) *singleOneOf

func TypeOf

func TypeOf(wantedType octosql.Value) *typeOf

func ValueOf

func ValueOf(values ...octosql.Value) *valueOf

Types

type SingleArgumentValidator

type SingleArgumentValidator interface {
	docs.Documented
	Validate(arg octosql.Value) error
}