CommandFretReqsDB2Copilot.hs

-- Copyright 2020 United States Government as represented by the Administrator
-- of the National Aeronautics and Space Administration. All Rights Reserved.
--
-- Disclaimers
--
-- No Warranty: THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY
-- OF ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT
-- LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO
-- SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
-- PARTICULAR PURPOSE, OR FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT THE
-- SUBJECT SOFTWARE WILL BE ERROR FREE, OR ANY WARRANTY THAT DOCUMENTATION, IF
-- PROVIDED, WILL CONFORM TO THE SUBJECT SOFTWARE. THIS AGREEMENT DOES NOT, IN
-- ANY MANNER, CONSTITUTE AN ENDORSEMENT BY GOVERNMENT AGENCY OR ANY PRIOR
-- RECIPIENT OF ANY RESULTS, RESULTING DESIGNS, HARDWARE, SOFTWARE PRODUCTS OR
-- ANY OTHER APPLICATIONS RESULTING FROM USE OF THE SUBJECT SOFTWARE. FURTHER,
-- GOVERNMENT AGENCY DISCLAIMS ALL WARRANTIES AND LIABILITIES REGARDING
-- THIRD-PARTY SOFTWARE, IF PRESENT IN THE ORIGINAL SOFTWARE, AND DISTRIBUTES
-- IT "AS IS."
--
-- Waiver and Indemnity: RECIPIENT AGREES TO WAIVE ANY AND ALL CLAIMS AGAINST
-- THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS
-- ANY PRIOR RECIPIENT. IF RECIPIENT'S USE OF THE SUBJECT SOFTWARE RESULTS IN
-- ANY LIABILITIES, DEMANDS, DAMAGES, EXPENSES OR LOSSES ARISING FROM SUCH USE,
-- INCLUDING ANY DAMAGES FROM PRODUCTS BASED ON, OR RESULTING FROM, RECIPIENT'S
-- USE OF THE SUBJECT SOFTWARE, RECIPIENT SHALL INDEMNIFY AND HOLD HARMLESS THE
-- UNITED STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY
-- PRIOR RECIPIENT, TO THE EXTENT PERMITTED BY LAW. RECIPIENT'S SOLE REMEDY
-- FOR ANY SUCH MATTER SHALL BE THE IMMEDIATE, UNILATERAL TERMINATION OF THIS
-- AGREEMENT.
--
-- | CLI interface to the CStructs2Copilot subcommand
module CLI.CommandFretReqsDB2Copilot
    (
      -- * Direct command access
      command
    , CommandOpts
    , ErrorCode

      -- * CLI
    , commandDesc
    , commandOptsParser
    )
  where

-- External imports
import Options.Applicative ( Parser, help, long, metavar, showDefault,
                             strOption, switch, value )

-- External imports: command results
import Command.Result ( Result )

-- External imports: actions or commands supported
import Command.FRETReqsDB2Copilot ( ErrorCode, FRETReqsDB2CopilotOptions (..),
                                    fretReqsDB2Copilot )

-- * Command

-- | Options to generate Copilot from FRET Requirements Databases.
data CommandOpts = CommandOpts
  { fretReqsDBFileName :: FilePath
  , fretReqsDBCoCoSpec :: Bool
  , fretReqsDBTarget   :: String
  }

-- | Transform a FRET requirements database containing a temporal logic
-- specification into a Copilot specification.
--
-- This is just an uncurried version of "Command.FRETReqsDB2Copilot".
command :: CommandOpts -> IO (Result ErrorCode)
command c =
    fretReqsDB2Copilot
      (fretReqsDBFileName c)
      internalCommandOpts

  where

    internalCommandOpts :: FRETReqsDB2CopilotOptions
    internalCommandOpts = FRETReqsDB2CopilotOptions
      { fretReqsDB2CopilotUseCoCoSpec = fretReqsDBCoCoSpec c
      , fretReqsDB2CopilotFilename    = fretReqsDBTarget   c
      }

-- * CLI

-- | Command description for CLI help.
commandDesc :: String
commandDesc =
  "Generate a Copilot file from a FRET Requirements Database"

-- | Subparser for the @fret-reqs-db@ command, used to generate a Copilot
-- specification from a FRET file containing requirements only.
commandOptsParser :: Parser CommandOpts
commandOptsParser = CommandOpts
  <$> strOption
        (  long "fret-file-name"
        <> metavar "FILENAME"
        <> help strFretArgDesc
        )
  <*> switch
        (  long "cocospec"
        <> help strFretCoCoDesc
        )
  <*> strOption
        (  long "target-file-name"
        <> metavar "FILENAME"
        <> help strFretTargetDesc
        <> showDefault
        <> value "fret"
        )

-- | Argument FRET command description
strFretArgDesc :: String
strFretArgDesc = "FRET file with requirements."

-- | CoCoSpec flag description
strFretCoCoDesc :: String
strFretCoCoDesc = "Use CoCoSpec variant of TL properties"

-- | Target file name flag description.
strFretTargetDesc :: String
strFretTargetDesc = "Filename prefix for monitoring files in target language"