ogma-core
Safe HaskellNone
LanguageHaskell2010

Command.Overview

Description

Produce an overview of the input files.

Synopsis

Documentation

command Source #

Arguments

:: FilePath

Path to a file containing a specification

-> CommandOptions

Customization options

-> IO (Maybe CommandSummary, Result ErrorCode) 

Generate overview of a spec given in an input file.

PRE: The file given is readable, contains a valid file with recognizable format, the formulas in the file do not use any identifiers that exist in Copilot, or any of prop, clock, ftp, notPreviousNot. All identifiers used are valid C99 identifiers. The template, if provided, exists and uses the variables needed by the overview application generator. The target directory is writable and there's enough disk space to copy the files over.

data CommandOptions Source #

Options used to customize the interpretation of input specifications.

data CommandSummary Source #

Instances

Instances details
ToJSON CommandSummary Source # 
Instance details

Defined in Command.Overview

Generic CommandSummary Source # 
Instance details

Defined in Command.Overview

Associated Types

type Rep CommandSummary 
Instance details

Defined in Command.Overview

type Rep CommandSummary = D1 ('MetaData "CommandSummary" "Command.Overview" "ogma-core-1.8.0-AiLUmUztkDKGgOcm25t3dd" 'False) (C1 ('MetaCons "CommandSummary" 'PrefixI 'True) (S1 ('MetaSel ('Just "commandExternalVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: (S1 ('MetaSel ('Just "commandInternalVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "commandRequirements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))
Show CommandSummary Source # 
Instance details

Defined in Command.Overview

type Rep CommandSummary Source # 
Instance details

Defined in Command.Overview

type Rep CommandSummary = D1 ('MetaData "CommandSummary" "Command.Overview" "ogma-core-1.8.0-AiLUmUztkDKGgOcm25t3dd" 'False) (C1 ('MetaCons "CommandSummary" 'PrefixI 'True) (S1 ('MetaSel ('Just "commandExternalVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: (S1 ('MetaSel ('Just "commandInternalVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "commandRequirements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))

type ErrorCode = Int Source #

Encoding of reasons why the command can fail.