Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.Choices

Description

Defines the design language for SCS.

Synopsis

data Choices = Choices {
- lang :: [Lang]
- architecture :: Architecture
- dataInfo :: DataInfo
- maps :: Maps
- optFeats :: OptionalFeatures
- srsConstraints :: Constraints
- extLibs :: [ExtLib]
- icNames :: InternalConcept -> Name
- folderVal :: Int
- defaultConfigFiles :: [RelativeFile]
- extraMods :: [Mod]
- handWiredDefs :: [SimpleQDef]
}
data Architecture = Archt {
- modularity :: Modularity
- impType :: ImplementationType
}
makeArchit :: Modularity -> ImplementationType -> Architecture
data DataInfo = DataInfo {
- inputStructure :: Structure
- constStructure :: ConstantStructure
- constRepr :: ConstantRepr
}
makeData :: Structure -> ConstantStructure -> ConstantRepr -> DataInfo
data Maps = Maps {
- conceptMatch :: ConceptMatchMap
- spaceMatch :: SpaceMatch
}
makeMaps :: ConceptMatchMap -> SpaceMatch -> Maps
spaceToCodeType :: Space -> [CodeType]
data Constraints = Constraints {
- onSfwrConstraint :: ConstraintBehaviour
- onPhysConstraint :: ConstraintBehaviour
}
makeConstraints :: ConstraintBehaviour -> ConstraintBehaviour -> Constraints
data ODE = ODE {
- odeInfo :: [ODEInfo]
- odeLib :: [ODELibPckg]
}
makeODE :: [ODEInfo] -> [ODELibPckg] -> ODE
odeInfoReqs :: ExtLib -> [DefinedQuantityDict]
odeLibReqs :: ExtLib -> [DefinedQuantityDict]
data DocConfig = DocConfig {
- comments :: [Comments]
- doxVerbosity :: Verbosity
- dates :: Visibility
}
makeDocConfig :: [Comments] -> Verbosity -> Visibility -> DocConfig
data LogConfig = LogConfig {
- logging :: [Logging]
- logFile :: FilePath
}
makeLogConfig :: [Logging] -> FilePath -> LogConfig
data OptionalFeatures = OptFeats {
- docConfig :: DocConfig
- logConfig :: LogConfig
- auxFiles :: [SoftwareDossierFile]
}
makeOptFeats :: DocConfig -> LogConfig -> [SoftwareDossierFile] -> OptionalFeatures
newtype ExtLib = Math ODE
data Modularity
- = Modular
- | Unmodular
data Structure
- = Unbundled
- | Bundled
data ConstantStructure
- = Inline
- | WithInputs
- | Store Structure
data ConstantRepr
- = Var
- | Const
type ConceptMatchMap = Map UID [CodeConcept]
type MatchedConceptMap = Map UID CodeConcept
data CodeConcept = Pi
matchConcepts :: HasUID c => [(c, [CodeConcept])] -> ConceptMatchMap
type SpaceMatch = Space -> [CodeType]
matchSpaces :: [(Space, [CodeType])] -> SpaceMatch
data ImplementationType
- = Library
- | Program
data ConstraintBehaviour
- = Warning
- | Exception
data Comments
- = CommentFunc
- | CommentClass
- | CommentMod
data Verbosity
- = Verbose
- | Quiet
data Visibility
- = Show
- | Hide
data Logging
- = LogFunc
- | LogVar
data SoftwareDossierFile
- = SampleInput FilePath
- | ReadME
getSampleData :: Choices -> Maybe FilePath
hasSampleInput :: [SoftwareDossierFile] -> Bool
defaultChoices :: Choices
choicesSent :: Choices -> [Sentence]
showChs :: RenderChoices a => a -> Sentence
data InternalConcept
- = InputConstraintsFn
- | InputConstraintsMod
- | WriteOutput
- | DerivedValuesFn
- | DerivedValuesMod
- | GetInput
- | InputParameters
- | InputFormat
- | OutputFormat
- | Calculations
- | Constants

Documentation

data Choices Source #

The instruction indicates how the generated program should be written down. Full details of Choices documentation https://github.com/JacquesCarette/Drasil/wiki/The-Code-Generator

Constructors

Choices

Fields

lang :: [Lang]
Target languages. Choosing multiple means program will be generated in multiple languages.
architecture :: Architecture
Architecture of the program, include modularity and implementation type
dataInfo :: DataInfo
Data structure and represent
maps :: Maps
Maps for 'Drasil concepts' to 'code concepts' or Space to a 'CodeType
optFeats :: OptionalFeatures
Setting for Softifacts that can be added to the program or left it out
srsConstraints :: Constraints
Constraint violation behaviour. Exception or Warning.
extLibs :: [ExtLib]
List of external libraries what to utilize
icNames :: InternalConcept -> Name
Function to get modifiable function names
folderVal :: Int
Number of folders to go up in order to obtain the image
defaultConfigFiles :: [RelativeFile]
A list of "program configuration files" to be copied over to the exported project, required for execution, and configurable by the user.
extraMods :: [Mod]
List of extra modules for generation.
handWiredDefs :: [SimpleQDef]
A list of supplementary hand-wired quantity definitions usable in code generation, unique to a particular code solution.
FIXME: These formulas are inadequately argued. They should be constructed through theory refinement in an SDS describing a software solution for a specific SRS. See the following for further discussion: * https://github.com/JacquesCarette/Drasil/pull/4663#issuecomment-3791189095 * https://github.com/JacquesCarette/Drasil/pull/4664#issuecomment-3791983458

data Architecture Source #

Architecture of a program

Constructors

Archt
Fields modularity :: Modularity How the program should be modularized. impType :: ImplementationType Implementation type, program or library.

makeArchit :: Modularity -> ImplementationType -> Architecture Source #

Constructor to create a Architecture

data DataInfo Source #

Data of a program - how information should be encoded.

Constructors

DataInfo
Fields inputStructure :: Structure Structure of inputs (bundled or not). constStructure :: ConstantStructure Structure of constants (inlined or bundled or not, or stored with inputs). constRepr :: ConstantRepr Representation of constants (as variables or as constants).

makeData :: Structure -> ConstantStructure -> ConstantRepr -> DataInfo Source #

Constructor to create a DataInfo

data Maps Source #

Maps for Concepts and Space

Constructors

Maps
Fields conceptMatch :: ConceptMatchMap Map of `UID`s for Drasil concepts to code concepts. Matching a `UID` to a code concept means the code concept should be used instead of the chunk associated with the `UID`. spaceMatch :: SpaceMatch Map of `Space`s to `CodeType`s Matching a `Space` to a `CodeType` means values of the `Space` should have that `CodeType` in the generated code.

makeMaps :: ConceptMatchMap -> SpaceMatch -> Maps Source #

Constructor to create a Maps

spaceToCodeType :: Space -> [CodeType] Source #

Default mapping between Space and CodeType.

data Constraints Source #

SRS Constraints

Constructors

Constraints
Fields onSfwrConstraint :: ConstraintBehaviour onPhysConstraint :: ConstraintBehaviour

makeConstraints :: ConstraintBehaviour -> ConstraintBehaviour -> Constraints Source #

Constructor to create a Constraints

data ODE Source #

All Information needed to solve an ODE

Constructors

ODE
Fields odeInfo :: [ODEInfo] ODE information. odeLib :: [ODELibPckg] Preferentially-ordered list ODE libraries to try.

makeODE :: [ODEInfo] -> [ODELibPckg] -> ODE Source #

Constructor to create an ODE

odeInfoReqs :: ExtLib -> [DefinedQuantityDict] Source #

odeLibReqs :: ExtLib -> [DefinedQuantityDict] Source #

data DocConfig Source #

Configuration for Doxygen documentation

Constructors

DocConfig
Fields comments :: [Comments] Turns Doxygen comments for different code structures on or off. doxVerbosity :: Verbosity Standard output from running Doxygen: verbose or quiet? dates :: Visibility Turns date field on or off in the generated module-level Doxygen comments.

makeDocConfig :: [Comments] -> Verbosity -> Visibility -> DocConfig Source #

Constructor to create a DocConfig

data LogConfig Source #

Log Configuration

Constructors

LogConfig
Fields logging :: [Logging] Turns different forms of logging on or off. logFile :: FilePath Name of log file.

makeLogConfig :: [Logging] -> FilePath -> LogConfig Source #

Constructor to create a LogConfig

data OptionalFeatures Source #

Constructors

OptFeats
Fields docConfig :: DocConfig logConfig :: LogConfig auxFiles :: [SoftwareDossierFile] Turns generation of different auxiliary (non-source-code) files on or off.

makeOptFeats :: DocConfig -> LogConfig -> [SoftwareDossierFile] -> OptionalFeatures Source #

Constructor to create a OptionalFeatures

newtype ExtLib Source #

External Library Options

Constructors

Math ODE

data Modularity Source #

Modularity of a program.

Constructors

Modular	Different modules. For controller, input, calculations, output.
Unmodular	All generated code is in one module/file.

data Structure Source #

Variable structure options.

Constructors

Unbundled	Individual variables
Bundled	Variables bundled in a class

data ConstantStructure Source #

Constants options.

Constructors

Inline	Inline values for constants.
WithInputs	Store constants with inputs.
Store Structure	Store constants separately from inputs, whether bundled or unbundled.

data ConstantRepr Source #

Options for representing constants in a program.

Constructors

Var	Constants represented as regular variables.
Const	Use target language's mechanism for defining constants.

type ConceptMatchMap = Map UID [CodeConcept] Source #

Specifies matches between chunks and CodeConcepts, meaning the target language's pre-existing definition of the concept should be used instead of defining a new variable for the concept in the generated code. [CodeConcept] is preferentially-ordered, generator concretizes a ConceptMatchMap to a MatchedConceptMap by checking user's other choices.

type MatchedConceptMap = Map UID CodeConcept Source #

Concrete version of ConceptMatchMap dependent on user choices.

data CodeConcept Source #

Code concepts. For now, just pi.

Constructors

Pi

Instances

Instances details

Eq CodeConcept Source #
Instance details Defined in Language.Drasil.Choices Methods (==) :: CodeConcept -> CodeConcept -> Bool # (/=) :: CodeConcept -> CodeConcept -> Bool #

matchConcepts :: HasUID c => [(c, [CodeConcept])] -> ConceptMatchMap Source #

Builds a ConceptMatchMap from an association list of chunks and CodeConcepts.

type SpaceMatch = Space -> [CodeType] Source #

Specifies which CodeType should be used to represent each mathematical Space. [CodeType] is preferentially-ordered, first CodeType that does not conflict with other choices will be selected.

matchSpaces :: [(Space, [CodeType])] -> SpaceMatch Source #

Builds a SpaceMatch from an association list of Spaces and CodeTypes.

data ImplementationType Source #

Program implementation options.

Constructors

Library	Generated code does not include Controller.
Program	Generated code includes Controller.

data ConstraintBehaviour Source #

Constraint behaviour options within program.

Constructors

Warning	Print warning when constraint violated.
Exception	Throw exception when constraint violated.

data Comments Source #

Comment implementation options.

Constructors

CommentFunc	Function/method-level comments.
CommentClass	Class-level comments.
CommentMod	File/Module-level comments.

Instances

Instances details

Eq Comments Source #
Instance details Defined in Language.Drasil.Choices Methods (==) :: Comments -> Comments -> Bool # (/=) :: Comments -> Comments -> Bool #

data Verbosity Source #

Doxygen file verbosity options.

Constructors

Verbose
Quiet

data Visibility Source #

Doxygen date-field visibility options.

Constructors

Show
Hide

data Logging Source #

Logging options for function calls and variable assignments. Eq instances required for Logging and Comments because generator needs to check membership of these elements in lists

Constructors

LogFunc	Log messages generated for function calls.
LogVar	Log messages generated for variable assignments.

Instances

Instances details

Eq Logging Source #
Instance details Defined in Language.Drasil.Choices Methods (==) :: Logging -> Logging -> Bool # (/=) :: Logging -> Logging -> Bool #

data SoftwareDossierFile Source #

Currently we only support two kind of auxiliary files: sample input file, readme. To generate a sample input file compatible with the generated program, FilePath is the path to the user-provided file containing a sample set of input data.

Constructors

SampleInput FilePath
ReadME

Instances

Instances details

Eq SoftwareDossierFile Source #
Instance details Defined in Language.Drasil.Choices Methods (==) :: SoftwareDossierFile -> SoftwareDossierFile -> Bool # (/=) :: SoftwareDossierFile -> SoftwareDossierFile -> Bool #

getSampleData :: Choices -> Maybe FilePath Source #

Gets the file path to a sample input data set from a Choices structure, if the user chose to generate a sample input file.

hasSampleInput :: [SoftwareDossierFile] -> Bool Source #

Predicate that returns true if the list of SoftwareDossierFiles includes a SampleInput.

defaultChoices :: Choices Source #

Default choices to be used as the base from which design specifications can be built.

choicesSent :: Choices -> [Sentence] Source #

Renders Choices as Sentences.

showChs :: RenderChoices a => a -> Sentence Source #

data InternalConcept Source #

Data type of internal concepts

Constructors

InputConstraintsFn
InputConstraintsMod
WriteOutput
DerivedValuesFn
DerivedValuesMod
GetInput
InputParameters
InputFormat
OutputFormat
Calculations
Constants

Instances

Instances details

Eq InternalConcept Source #
Instance details Defined in Language.Drasil.Choices Methods (==) :: InternalConcept -> InternalConcept -> Bool # (/=) :: InternalConcept -> InternalConcept -> Bool #
Ord InternalConcept Source #
Instance details Defined in Language.Drasil.Choices Methods compare :: InternalConcept -> InternalConcept -> Ordering # (<) :: InternalConcept -> InternalConcept -> Bool # (<=) :: InternalConcept -> InternalConcept -> Bool # (>) :: InternalConcept -> InternalConcept -> Bool # (>=) :: InternalConcept -> InternalConcept -> Bool # max :: InternalConcept -> InternalConcept -> InternalConcept # min :: InternalConcept -> InternalConcept -> InternalConcept #