Constants.hs

-- Note: this is an automatically generated file. Do not edit.

-- | A module for tier-0 constants.

module Hydra.Constants where

import qualified Hydra.Ast as Ast
import qualified Hydra.Coders as Coders
import qualified Hydra.Core as Core
import qualified Hydra.Docs as Docs
import qualified Hydra.Error.Checking as Checking
import qualified Hydra.Error.Core as ErrorCore
import qualified Hydra.Error.File as ErrorFile
import qualified Hydra.Error.Packaging as ErrorPackaging
import qualified Hydra.Error.System as ErrorSystem
import qualified Hydra.Errors as Errors
import qualified Hydra.File as File
import qualified Hydra.Graph as Graph
import qualified Hydra.Json.Model as Model
import qualified Hydra.Packaging as Packaging
import qualified Hydra.Parsing as Parsing
import qualified Hydra.Paths as Paths
import qualified Hydra.Query as Query
import qualified Hydra.Relational as Relational
import qualified Hydra.System as System
import qualified Hydra.Tabular as Tabular
import qualified Hydra.Testing as Testing
import qualified Hydra.Time as Time
import qualified Hydra.Topology as Topology
import qualified Hydra.Typed as Typed
import qualified Hydra.Typing as Typing
import qualified Hydra.Util as Util
import qualified Hydra.Validation as Validation
import qualified Hydra.Variants as Variants
import Prelude hiding  (Enum, Ordering, decodeFloat, encodeFloat, fail, map, pure, sum)
import qualified Data.Scientific as Sci

-- | Disable type checking by default, for better performance
debugInference :: Bool
debugInference = True

-- | The name used for ignored variables
ignoredVariable :: String
ignoredVariable = "_"

-- | Annotation key for type classes
keyClasses :: Core.Name
keyClasses = Core.Name "classes"

-- | Annotation key for debug identifiers
keyDebugId :: Core.Name
keyDebugId = Core.Name "debugId"

-- | Annotation key for deprecated markers
keyDeprecated :: Core.Name
keyDeprecated = Core.Name "deprecated"

-- | Annotation key for descriptions
keyDescription :: Core.Name
keyDescription = Core.Name "description"

-- | Annotation key for exclusions
keyExclude :: Core.Name
keyExclude = Core.Name "exclude"

-- | A flag which tells the language coders to encode a given encoded type as a term rather than a native type
keyFirstClassType :: Core.Name
keyFirstClassType = Core.Name "firstClassType"

-- | A counter for generating fresh type variable names
keyFreshTypeVariableCount :: Core.Name
keyFreshTypeVariableCount = Core.Name "freshTypeVariableCount"

-- | Annotation key for maximum length constraints
keyMaxLength :: Core.Name
keyMaxLength = Core.Name "maxLength"

-- | Annotation key for minimum length constraints
keyMinLength :: Core.Name
keyMinLength = Core.Name "minLength"

-- | Annotation key for preserving field names during code generation
keyPreserveFieldName :: Core.Name
keyPreserveFieldName = Core.Name "preserveFieldName"

-- | Annotation key for type information
keyType :: Core.Name
keyType = Core.Name "type"

-- | The maximum value of a 32-bit integer
maxInt32 :: Int
maxInt32 = 2147483647

-- | A maximum depth for nested computations. Currently, this is set very high because deep recursion is common in type inference over the Hydra kernel.
maxTraceDepth :: Int
maxTraceDepth = 5000

-- | Regex matching a camelCase identifier: starts with a lowercase letter, then any letters or digits.
regexCamelCase :: String
regexCamelCase = "^[a-z][a-zA-Z0-9]*$"

-- | Regex matching a Hydra namespace: dot-separated camelCase segments, each starting with a lowercase letter.
regexNamespace :: String
regexNamespace = "^[a-z][a-zA-Z0-9]*(\\.[a-z][a-zA-Z0-9]*)*$"

-- | Regex matching a Hydra package name: hyphen-separated lowercase segments, each starting with a letter.
regexPackageName :: String
regexPackageName = "^[a-z][a-z0-9]*(-[a-z][a-z0-9]*)*$"

-- | Regex matching a PascalCase identifier: starts with an uppercase letter, then any letters or digits.
regexPascalCase :: String
regexPascalCase = "^[A-Z][a-zA-Z0-9]*$"

-- | A standard warning message for auto-generated files
warningAutoGeneratedFile :: String
warningAutoGeneratedFile = "Note: this is an automatically generated file. Do not edit."