PAKCS
Exported names: Imported modules:

Module System.FrontendExec

This module contains operations to execute the front end of the Curry system.

Author: Bernd Brassel, Michael Hanus, Bjoern Peemoeller, Finn Teegen

Version: November 2018

Summary of exported operations:

defaultParams :: FrontendParams   
The default parameters of the front end.
rcParams :: IO FrontendParams   
The default parameters of the front end as configured by the compiler specific resource configuration file.
setQuiet :: Bool -> FrontendParams -> FrontendParams   
Set quiet mode of the front end.
setExtended :: Bool -> FrontendParams -> FrontendParams   
Set extended mode of the front end.
setCpp :: Bool -> FrontendParams -> FrontendParams   
Set cpp mode of the front end.
addDefinition :: (String,Int) -> FrontendParams -> FrontendParams   
Add cpp definition of the front end.
setDefinitions :: [(String,Int)] -> FrontendParams -> FrontendParams   
Set cpp definitions of the front end.
setOverlapWarn :: Bool -> FrontendParams -> FrontendParams   
Set overlap warn mode of the front end.
setFullPath :: [String] -> FrontendParams -> FrontendParams   
Set the full path of the front end.
setHtmlDir :: String -> FrontendParams -> FrontendParams   
Set the htmldir parameter of the front end.
setLogfile :: String -> FrontendParams -> FrontendParams   
Set the logfile parameter of the front end.
setSpecials :: String -> FrontendParams -> FrontendParams   
Set additional specials parameters of the front end.
addTarget :: FrontendTarget -> FrontendParams -> FrontendParams   
Add an additional front end target.
quiet :: FrontendParams -> Bool   
Returns the value of the "quiet" parameter.
extended :: FrontendParams -> Bool   
Returns the value of the "extended" parameter.
cpp :: FrontendParams -> Bool   
Returns the value of the "cpp" parameter.
definitions :: FrontendParams -> [(String,Int)]   
Returns the value of the "cpp" parameter.
overlapWarn :: FrontendParams -> Bool   
Returns the value of the "overlapWarn" parameter.
fullPath :: FrontendParams -> Maybe [String]   
Returns the full path parameter of the front end.
htmldir :: FrontendParams -> Maybe String   
Returns the htmldir parameter of the front end.
logfile :: FrontendParams -> Maybe String   
Returns the logfile parameter of the front end.
specials :: FrontendParams -> String   
Returns the special parameters of the front end.
callFrontend :: FrontendTarget -> String -> IO ()   
In order to make sure that compiler generated files (like .fcy, .fint, .acy) are up to date, one can call the front end of the Curry compiler with this action.
callFrontendWithParams :: FrontendTarget -> FrontendParams -> String -> IO ()   
In order to make sure that compiler generated files (like .fcy, .fint, .acy) are up to date, one can call the front end of the Curry compiler with this action where various parameters can be set.

Exported datatypes:

FrontendTarget

Data type for representing the different target files that can be produced by the front end of the Curry compiler.

Constructors:

  • FCY :: FrontendTarget : FlatCurry file ending with .fcy
  • TFCY :: FrontendTarget : Typed FlatCurry file ending with .tfcy
  • FINT :: FrontendTarget : FlatCurry interface file ending with .fint
  • ACY :: FrontendTarget : AbstractCurry file ending with .acy
  • UACY :: FrontendTarget : Untyped (without type checking) AbstractCurry file ending with .uacy
  • HTML :: FrontendTarget : colored HTML representation of source program
  • CY :: FrontendTarget : source representation employed by the frontend
  • TOKS :: FrontendTarget : token stream of source program
  • TAFCY :: FrontendTarget
  • AST :: FrontendTarget : abstract syntax tree ending with .sast
  • SAST :: FrontendTarget : shortened abstract syntax tree ending with .sast
FrontendParams

Abstract data type for representing parameters supported by the front end of the Curry compiler.

Constructors:

Exported operations:

defaultParams :: FrontendParams   

The default parameters of the front end.

rcParams :: IO FrontendParams   

The default parameters of the front end as configured by the compiler specific resource configuration file.

setQuiet :: Bool -> FrontendParams -> FrontendParams   

Set quiet mode of the front end.

Further infos:
  • solution complete, i.e., able to compute all solutions

setExtended :: Bool -> FrontendParams -> FrontendParams   

Set extended mode of the front end.

Further infos:
  • solution complete, i.e., able to compute all solutions

setCpp :: Bool -> FrontendParams -> FrontendParams   

Set cpp mode of the front end.

Further infos:
  • solution complete, i.e., able to compute all solutions

addDefinition :: (String,Int) -> FrontendParams -> FrontendParams   

Add cpp definition of the front end.

Further infos:
  • solution complete, i.e., able to compute all solutions

setDefinitions :: [(String,Int)] -> FrontendParams -> FrontendParams   

Set cpp definitions of the front end.

Further infos:
  • solution complete, i.e., able to compute all solutions

setOverlapWarn :: Bool -> FrontendParams -> FrontendParams   

Set overlap warn mode of the front end.

Further infos:
  • solution complete, i.e., able to compute all solutions

setFullPath :: [String] -> FrontendParams -> FrontendParams   

Set the full path of the front end. If this parameter is set, the front end searches all modules in this path (instead of using the default path).

Further infos:
  • solution complete, i.e., able to compute all solutions

setHtmlDir :: String -> FrontendParams -> FrontendParams   

Set the htmldir parameter of the front end. Relevant for HTML generation.

Further infos:
  • solution complete, i.e., able to compute all solutions

setLogfile :: String -> FrontendParams -> FrontendParams   

Set the logfile parameter of the front end. If this parameter is set, all messages produced by the front end are stored in this file.

Further infos:
  • solution complete, i.e., able to compute all solutions

setSpecials :: String -> FrontendParams -> FrontendParams   

Set additional specials parameters of the front end. These parameters are specific for the current front end and should be used with care, since their form might change in the future.

Further infos:
  • solution complete, i.e., able to compute all solutions

addTarget :: FrontendTarget -> FrontendParams -> FrontendParams   

Add an additional front end target.

Further infos:
  • solution complete, i.e., able to compute all solutions

quiet :: FrontendParams -> Bool   

Returns the value of the "quiet" parameter.

Further infos:
  • solution complete, i.e., able to compute all solutions

extended :: FrontendParams -> Bool   

Returns the value of the "extended" parameter.

Further infos:
  • solution complete, i.e., able to compute all solutions

cpp :: FrontendParams -> Bool   

Returns the value of the "cpp" parameter.

Further infos:
  • solution complete, i.e., able to compute all solutions

definitions :: FrontendParams -> [(String,Int)]   

Returns the value of the "cpp" parameter.

Further infos:
  • solution complete, i.e., able to compute all solutions

overlapWarn :: FrontendParams -> Bool   

Returns the value of the "overlapWarn" parameter.

Further infos:
  • solution complete, i.e., able to compute all solutions

fullPath :: FrontendParams -> Maybe [String]   

Returns the full path parameter of the front end.

Further infos:
  • solution complete, i.e., able to compute all solutions

htmldir :: FrontendParams -> Maybe String   

Returns the htmldir parameter of the front end.

Further infos:
  • solution complete, i.e., able to compute all solutions

logfile :: FrontendParams -> Maybe String   

Returns the logfile parameter of the front end.

Further infos:
  • solution complete, i.e., able to compute all solutions

specials :: FrontendParams -> String   

Returns the special parameters of the front end.

Further infos:
  • solution complete, i.e., able to compute all solutions

callFrontend :: FrontendTarget -> String -> IO ()   

In order to make sure that compiler generated files (like .fcy, .fint, .acy) are up to date, one can call the front end of the Curry compiler with this action. If the front end returns with an error, an exception is raised.

Example call:
(callFrontend target progname)
Parameters:
  • target : the kind of target file to be generated
  • progname : the name of the main module of the application to be compiled

callFrontendWithParams :: FrontendTarget -> FrontendParams -> String -> IO ()   

In order to make sure that compiler generated files (like .fcy, .fint, .acy) are up to date, one can call the front end of the Curry compiler with this action where various parameters can be set. If the front end returns with an error, an exception is raised.

Example call:
(callFrontendWithParams target params modpath)
Parameters:
  • target : the kind of target file to be generated
  • params : parameters for the front end
  • modpath : the name of the main module possibly prefixed with a directory where this module resides