Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.GOOL

Description

Re-export code-related smart constructors for external code writing and generation.

Synopsis

class AuxiliarySym r => PackageSym r where
- type Package r
- package :: ProgData -> [r (Auxiliary r)] -> r (Package r)
class AuxiliarySym r where
- type Auxiliary r
- type AuxHelper r
- doxConfig :: String -> GOOLState -> Verbosity -> r (Auxiliary r)
- readMe :: ReadMeInfo -> r (Auxiliary r)
- sampleInput :: PrintingInformation -> DataDesc -> [Expr] -> r (Auxiliary r)
- optimizeDox :: r (AuxHelper r)
- makefile :: [FilePath] -> ImplementationType -> [Comments] -> GOOLState -> ProgData -> r (Auxiliary r)
- auxHelperDoc :: r (AuxHelper r) -> Doc
- auxFromData :: FilePath -> Doc -> r (Auxiliary r)
data AuxData
data PackData
unPP :: PythonProject a -> a
unJP :: JavaProject a -> a
unCSP :: CSharpProject a -> a
unCPPP :: CppProject a -> a
unSP :: SwiftProject a -> a
unJLP :: JuliaProject a -> a

Documentation

class AuxiliarySym r => PackageSym r where Source #

Members of this class must have all the information necessary for the AuxiliarySym in addition to information necessary to create a package.

Associated Types

type Package r Source #

Methods

package :: ProgData -> [r (Auxiliary r)] -> r (Package r) Source #

Instances

Instances details

PackageSym CSharpProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.CSharpRenderer Associated Types type Package CSharpProject Source # Methods package :: ProgData -> [CSharpProject (Auxiliary CSharpProject)] -> CSharpProject (Package CSharpProject) Source #
PackageSym CppProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.CppRenderer Associated Types type Package CppProject Source # Methods package :: ProgData -> [CppProject (Auxiliary CppProject)] -> CppProject (Package CppProject) Source #
PackageSym JavaProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.JavaRenderer Associated Types type Package JavaProject Source # Methods package :: ProgData -> [JavaProject (Auxiliary JavaProject)] -> JavaProject (Package JavaProject) Source #
PackageSym JuliaProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.JuliaRenderer Associated Types type Package JuliaProject Source # Methods package :: ProgData -> [JuliaProject (Auxiliary JuliaProject)] -> JuliaProject (Package JuliaProject) Source #
PackageSym PythonProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.PythonRenderer Associated Types type Package PythonProject Source # Methods package :: ProgData -> [PythonProject (Auxiliary PythonProject)] -> PythonProject (Package PythonProject) Source #
PackageSym SwiftProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.SwiftRenderer Associated Types type Package SwiftProject Source # Methods package :: ProgData -> [SwiftProject (Auxiliary SwiftProject)] -> SwiftProject (Package SwiftProject) Source #

class AuxiliarySym r where Source #

Members of this class must have a doxygen configuration, ReadMe file, sample input, omptimize doxygen document, information necessary for a makefile, auxiliary helper documents, and auxiliary from data documents.

Associated Types

type Auxiliary r Source #

type AuxHelper r Source #

Methods

doxConfig :: String -> GOOLState -> Verbosity -> r (Auxiliary r) Source #

readMe :: ReadMeInfo -> r (Auxiliary r) Source #

sampleInput :: PrintingInformation -> DataDesc -> [Expr] -> r (Auxiliary r) Source #

optimizeDox :: r (AuxHelper r) Source #

makefile :: [FilePath] -> ImplementationType -> [Comments] -> GOOLState -> ProgData -> r (Auxiliary r) Source #

auxHelperDoc :: r (AuxHelper r) -> Doc Source #

auxFromData :: FilePath -> Doc -> r (Auxiliary r) Source #

Instances

Instances details

AuxiliarySym CSharpProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.CSharpRenderer Associated Types type Auxiliary CSharpProject Source # type AuxHelper CSharpProject Source # Methods doxConfig :: String -> GOOLState -> Verbosity -> CSharpProject (Auxiliary CSharpProject) Source # readMe :: ReadMeInfo -> CSharpProject (Auxiliary CSharpProject) Source # sampleInput :: PrintingInformation -> DataDesc -> [Expr] -> CSharpProject (Auxiliary CSharpProject) Source # optimizeDox :: CSharpProject (AuxHelper CSharpProject) Source # makefile :: [FilePath] -> ImplementationType -> [Comments] -> GOOLState -> ProgData -> CSharpProject (Auxiliary CSharpProject) Source # auxHelperDoc :: CSharpProject (AuxHelper CSharpProject) -> Doc Source # auxFromData :: FilePath -> Doc -> CSharpProject (Auxiliary CSharpProject) Source #
AuxiliarySym CppProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.CppRenderer Associated Types type Auxiliary CppProject Source # type AuxHelper CppProject Source # Methods doxConfig :: String -> GOOLState -> Verbosity -> CppProject (Auxiliary CppProject) Source # readMe :: ReadMeInfo -> CppProject (Auxiliary CppProject) Source # sampleInput :: PrintingInformation -> DataDesc -> [Expr] -> CppProject (Auxiliary CppProject) Source # optimizeDox :: CppProject (AuxHelper CppProject) Source # makefile :: [FilePath] -> ImplementationType -> [Comments] -> GOOLState -> ProgData -> CppProject (Auxiliary CppProject) Source # auxHelperDoc :: CppProject (AuxHelper CppProject) -> Doc Source # auxFromData :: FilePath -> Doc -> CppProject (Auxiliary CppProject) Source #
AuxiliarySym JavaProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.JavaRenderer Associated Types type Auxiliary JavaProject Source # type AuxHelper JavaProject Source # Methods doxConfig :: String -> GOOLState -> Verbosity -> JavaProject (Auxiliary JavaProject) Source # readMe :: ReadMeInfo -> JavaProject (Auxiliary JavaProject) Source # sampleInput :: PrintingInformation -> DataDesc -> [Expr] -> JavaProject (Auxiliary JavaProject) Source # optimizeDox :: JavaProject (AuxHelper JavaProject) Source # makefile :: [FilePath] -> ImplementationType -> [Comments] -> GOOLState -> ProgData -> JavaProject (Auxiliary JavaProject) Source # auxHelperDoc :: JavaProject (AuxHelper JavaProject) -> Doc Source # auxFromData :: FilePath -> Doc -> JavaProject (Auxiliary JavaProject) Source #
AuxiliarySym JuliaProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.JuliaRenderer Associated Types type Auxiliary JuliaProject Source # type AuxHelper JuliaProject Source # Methods doxConfig :: String -> GOOLState -> Verbosity -> JuliaProject (Auxiliary JuliaProject) Source # readMe :: ReadMeInfo -> JuliaProject (Auxiliary JuliaProject) Source # sampleInput :: PrintingInformation -> DataDesc -> [Expr] -> JuliaProject (Auxiliary JuliaProject) Source # optimizeDox :: JuliaProject (AuxHelper JuliaProject) Source # makefile :: [FilePath] -> ImplementationType -> [Comments] -> GOOLState -> ProgData -> JuliaProject (Auxiliary JuliaProject) Source # auxHelperDoc :: JuliaProject (AuxHelper JuliaProject) -> Doc Source # auxFromData :: FilePath -> Doc -> JuliaProject (Auxiliary JuliaProject) Source #
AuxiliarySym PythonProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.PythonRenderer Associated Types type Auxiliary PythonProject Source # type AuxHelper PythonProject Source # Methods doxConfig :: String -> GOOLState -> Verbosity -> PythonProject (Auxiliary PythonProject) Source # readMe :: ReadMeInfo -> PythonProject (Auxiliary PythonProject) Source # sampleInput :: PrintingInformation -> DataDesc -> [Expr] -> PythonProject (Auxiliary PythonProject) Source # optimizeDox :: PythonProject (AuxHelper PythonProject) Source # makefile :: [FilePath] -> ImplementationType -> [Comments] -> GOOLState -> ProgData -> PythonProject (Auxiliary PythonProject) Source # auxHelperDoc :: PythonProject (AuxHelper PythonProject) -> Doc Source # auxFromData :: FilePath -> Doc -> PythonProject (Auxiliary PythonProject) Source #
AuxiliarySym SwiftProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.SwiftRenderer Associated Types type Auxiliary SwiftProject Source # type AuxHelper SwiftProject Source # Methods doxConfig :: String -> GOOLState -> Verbosity -> SwiftProject (Auxiliary SwiftProject) Source # readMe :: ReadMeInfo -> SwiftProject (Auxiliary SwiftProject) Source # sampleInput :: PrintingInformation -> DataDesc -> [Expr] -> SwiftProject (Auxiliary SwiftProject) Source # optimizeDox :: SwiftProject (AuxHelper SwiftProject) Source # makefile :: [FilePath] -> ImplementationType -> [Comments] -> GOOLState -> ProgData -> SwiftProject (Auxiliary SwiftProject) Source # auxHelperDoc :: SwiftProject (AuxHelper SwiftProject) -> Doc Source # auxFromData :: FilePath -> Doc -> SwiftProject (Auxiliary SwiftProject) Source #

data AuxData Source #

The underlying data type for auxiliary files in all renderers.

data PackData Source #

The underlying data type for packages in all renderers.

unPP :: PythonProject a -> a Source #

unJP :: JavaProject a -> a Source #

unCSP :: CSharpProject a -> a Source #

unCPPP :: CppProject a -> a Source #

unSP :: SwiftProject a -> a Source #

unJLP :: JuliaProject a -> a Source #