raw.compiler.rql2.builtin.ErrorPackage.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of raw-snapi-frontend_2.12 Show documentation
raw-snapi-frontend
There is a newer version: 0.33.11
Show newest version
/*
 * Copyright 2023 RAW Labs S.A.
 *
 * Use of this software is governed by the Business Source License
 * included in the file licenses/BSL.txt.
 *
 * As of the Change Date specified in that file, in accordance with
 * the Business Source License, use of this software will be governed
 * by the Apache License, Version 2.0, included in the file
 * licenses/APL.txt.
 */

package raw.compiler.rql2.builtin

import raw.client.api._
import raw.compiler.base.source.Type
import raw.compiler.rql2._
import raw.compiler.rql2.api.{Arg, EntryExtension, ExpParam, PackageExtension, Param, TypeArg, TypeParam}
import raw.compiler.rql2.source._

class ErrorPackage extends PackageExtension {

  override def name: String = "Error"

  override def docs: PackageDoc = PackageDoc(
    description = "Library of functions for the failure cases of error handling."
  )

}

class ErrorBuildEntry extends EntryExtension {

  override def packageName: String = "Error"

  override def entryName: String = "Build"
  override def docs: EntryDoc = EntryDoc(
    "Builds an error value.",
    examples = List(ExampleDoc("""Error.Build("This is an error")""", result = Some("This is an error"))),
    params = List(ParamDoc("message", TypeDoc(List("string")), "The error message."))
  )

  override def nrMandatoryParams: Int = 1

  override def getMandatoryParam(prevMandatoryArgs: Seq[Arg], idx: Int): Either[String, Param] = idx match {
    case 0 => Right(ExpParam(Rql2StringType()))
  }

  override def returnType(
      mandatoryArgs: Seq[Arg],
      optionalArgs: Seq[(String, Arg)],
      varArgs: Seq[Arg]
  )(implicit programContext: ProgramContext): Either[String, Type] = {
    Right(Rql2UndefinedType(Set(Rql2IsTryableTypeProperty())))
  }

}

class ErrorBuildWithTypeEntry extends EntryExtension {

  override def packageName: String = "Error"

  override def entryName: String = "BuildWithType"

  override def docs: EntryDoc = ???

  override def nrMandatoryParams: Int = 2

  override def getMandatoryParam(prevMandatoryArgs: Seq[Arg], idx: Int): Either[String, Param] = idx match {
    case 0 => Right(TypeParam(DoesNotHaveTypeProperties(Set(Rql2IsTryableTypeProperty()))))
    case 1 => Right(ExpParam(Rql2StringType()))
  }

  override def returnType(
      mandatoryArgs: Seq[Arg],
      optionalArgs: Seq[(String, Arg)],
      varArgs: Seq[Arg]
  )(implicit programContext: ProgramContext): Either[String, Type] = {
    val TypeArg(t) = mandatoryArgs(0)
    Right(addProp(t, Rql2IsTryableTypeProperty()))
  }

}

class ErrorGetEntry extends EntryExtension {

  override def packageName: String = "Error"

  override def entryName: String = "Get"

  override def docs: EntryDoc = ???

  override def nrMandatoryParams: Int = 1

  override def getMandatoryParam(prevMandatoryArgs: Seq[Arg], idx: Int): Either[String, Param] = {
    Right(ExpParam(IsTryable()))
  }

  override def returnType(
      mandatoryArgs: Seq[Arg],
      optionalArgs: Seq[(String, Arg)],
      varArgs: Seq[Arg]
  )(implicit programContext: ProgramContext): Either[String, Type] = {
    Right(Rql2StringType())
  }

}