Language.Fortran.Util.ModFile

Format of Camfort precompiled files with information about Fortran modules. The ModuleMap stores information important to the renamer. The other data is up to you.

Note that the encoder and decoder work on lists of ModFile so that one fsmod-file may contain information about multiple Fortran files.

One typical usage might look like:

let modFile1 = genModFile programFile
let modFile2 = alterModFileData (const (Just ...)) "mydata" modFile1
let bytes    = encodeModFile [modFile2]
...
case decodeModFile bytes of
  Left error -> print error
  Right modFile3:otherModuleFiles -> ...
    where
      moduleMap = combinedModuleMap (modFile3:otherModuleFiles)
      myData    = lookupModFileData "mydata" modFile3
      renamedPF = analyseRenamesWithModuleMap moduleMap programFile

Documentation

modFileSuffix :: String

Standard ending of fortran-src-format "mod files"

data ModFile

The data stored in the "mod files"

Instances

Eq ModFile

Defined in Language.Fortran.Util.ModFile

Methods

(==) :: ModFile -> ModFile -> Bool

(/=) :: ModFile -> ModFile -> Bool

Data ModFile

Defined in Language.Fortran.Util.ModFile

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModFile -> c ModFile

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModFile

toConstr :: ModFile -> Constr

dataTypeOf :: ModFile -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModFile)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModFile)

gmapT :: (forall b. Data b => b -> b) -> ModFile -> ModFile

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModFile -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModFile -> r

gmapQ :: (forall d. Data d => d -> u) -> ModFile -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ModFile -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModFile -> m ModFile

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModFile -> m ModFile

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModFile -> m ModFile

Ord ModFile

Defined in Language.Fortran.Util.ModFile

Methods

compare :: ModFile -> ModFile -> Ordering

(<) :: ModFile -> ModFile -> Bool

(<=) :: ModFile -> ModFile -> Bool

(>) :: ModFile -> ModFile -> Bool

(>=) :: ModFile -> ModFile -> Bool

max :: ModFile -> ModFile -> ModFile

min :: ModFile -> ModFile -> ModFile

Show ModFile

Defined in Language.Fortran.Util.ModFile

Methods

showsPrec :: Int -> ModFile -> ShowS

show :: ModFile -> String

showList :: [ModFile] -> ShowS

Generic ModFile

Defined in Language.Fortran.Util.ModFile

Associated Types

type Rep ModFile :: Type -> Type

Methods

from :: ModFile -> Rep ModFile x

to :: Rep ModFile x -> ModFile

Binary ModFile

Defined in Language.Fortran.Util.ModFile

Methods

put :: ModFile -> Put

get :: Get ModFile

putList :: [ModFile] -> Put

type Rep ModFile

Defined in Language.Fortran.Util.ModFile

type Rep ModFile = D1 (MetaData "ModFile" "Language.Fortran.Util.ModFile" "fortran-src-0.4.0-6iUwcUBJgeJJnlH0SPB9We" False) (C1 (MetaCons "ModFile" PrefixI True) ((S1 (MetaSel (Just "mfFilename") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :*: (S1 (MetaSel (Just "mfStringMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 StringMap) :*: S1 (MetaSel (Just "mfModuleMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ModuleMap))) :*: ((S1 (MetaSel (Just "mfDeclMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DeclMap) :*: S1 (MetaSel (Just "mfTypeEnv") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TypeEnv)) :*: (S1 (MetaSel (Just "mfParamVarMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ParamVarMap) :*: S1 (MetaSel (Just "mfOtherData") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map String ByteString))))))

type ModFiles = [ModFile]

A set of decoded mod files.

emptyModFile :: ModFile

Starting point.

emptyModFiles :: ModFiles

Empty set of mod files. (future proof: may not always be a list)

lookupModFileData :: String -> ModFile -> Maybe ByteString

Looks up the raw "other data" that may be stored in a ModFile by applications that make use of fortran-src.

getLabelsModFileData :: ModFile -> [String]

Get a list of the labels present in the "other data" of a ModFile. More of a meta-programming / debugging feature.

alterModFileData :: (Maybe ByteString -> Maybe ByteString) -> String -> ModFile -> ModFile

Allows modificationinsertiondeletion of "other data" that may be stored in a ModFile by applications that make use of fortran-src. See alter for more information about the interface of this function.

genModFile :: forall a. Data a => ProgramFile (Analysis a) -> ModFile

Generate a fresh ModFile from the module map, declaration map and type analysis of a given analysed and renamed ProgramFile.

regenModFile :: forall a. Data a => ProgramFile (Analysis a) -> ModFile -> ModFile

Extracts the module map, declaration map and type analysis from an analysed and renamed ProgramFile, then inserts it into the ModFile.

encodeModFile :: [ModFile] -> ByteString

Convert ModFiles to a strict ByteString for writing to file.

decodeModFile :: ByteString -> Either String [ModFile]

Convert a strict ByteString to ModFiles, if possible. Revert the String aliases according to the StringMap.

type StringMap = Map String String

A map of aliases => strings, in order to save space and share structure for repeated strings.

type DeclMap = Map Name (DeclContext, SrcSpan)

Map of unique variable name to the unique name of the program unit where it was defined, and the corresponding SrcSpan.

type ParamVarMap = ParameterVarMap

A map of variables => their constant expression if known

data DeclContext

Context of a declaration: the ProgramUnit where it was declared.

Constructors

DCMain

DCBlockData

DCModule ProgramUnitName

DCFunction (ProgramUnitName, ProgramUnitName)

(uniqName, srcName)

DCSubroutine (ProgramUnitName, ProgramUnitName)

(uniqName, srcName)

Instances

Eq DeclContext

Defined in Language.Fortran.Util.ModFile

Methods

(==) :: DeclContext -> DeclContext -> Bool

(/=) :: DeclContext -> DeclContext -> Bool

Data DeclContext

Defined in Language.Fortran.Util.ModFile

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeclContext -> c DeclContext

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeclContext

toConstr :: DeclContext -> Constr

dataTypeOf :: DeclContext -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeclContext)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeclContext)

gmapT :: (forall b. Data b => b -> b) -> DeclContext -> DeclContext

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeclContext -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeclContext -> r

gmapQ :: (forall d. Data d => d -> u) -> DeclContext -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeclContext -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeclContext -> m DeclContext

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeclContext -> m DeclContext

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeclContext -> m DeclContext

Ord DeclContext

Defined in Language.Fortran.Util.ModFile

Methods

compare :: DeclContext -> DeclContext -> Ordering

(<) :: DeclContext -> DeclContext -> Bool

(<=) :: DeclContext -> DeclContext -> Bool

(>) :: DeclContext -> DeclContext -> Bool

(>=) :: DeclContext -> DeclContext -> Bool

max :: DeclContext -> DeclContext -> DeclContext

min :: DeclContext -> DeclContext -> DeclContext

Show DeclContext

Defined in Language.Fortran.Util.ModFile

Methods

showsPrec :: Int -> DeclContext -> ShowS

show :: DeclContext -> String

showList :: [DeclContext] -> ShowS

Generic DeclContext

Defined in Language.Fortran.Util.ModFile

Associated Types

type Rep DeclContext :: Type -> Type

Methods

from :: DeclContext -> Rep DeclContext x

to :: Rep DeclContext x -> DeclContext

Binary DeclContext

Defined in Language.Fortran.Util.ModFile

Methods

put :: DeclContext -> Put

get :: Get DeclContext

putList :: [DeclContext] -> Put

type Rep DeclContext

Defined in Language.Fortran.Util.ModFile

type Rep DeclContext = D1 (MetaData "DeclContext" "Language.Fortran.Util.ModFile" "fortran-src-0.4.0-6iUwcUBJgeJJnlH0SPB9We" False) ((C1 (MetaCons "DCMain" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "DCBlockData" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "DCModule" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ProgramUnitName)) :+: (C1 (MetaCons "DCFunction" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ProgramUnitName, ProgramUnitName))) :+: C1 (MetaCons "DCSubroutine" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ProgramUnitName, ProgramUnitName))))))

extractModuleMap :: forall a. Data a => ProgramFile (Analysis a) -> ModuleMap

Extract all module maps (name -> environment) by collecting all of the stored module maps within the PUModule annotation.

extractDeclMap :: forall a. Data a => ProgramFile (Analysis a) -> DeclMap

Extract map of declared variables with their associated program unit and source span.

moduleFilename :: ModFile -> String

Get the associated Fortran filename that was used to compile the ModFile.

combinedStringMap :: ModFiles -> StringMap

Extract the combined string map of ModFiles. Mainly internal use.

combinedDeclMap :: ModFiles -> DeclMap

Extract the combined declaration map from a set of ModFiles. Useful for parsing a Fortran file in a large context of other modules.

combinedModuleMap :: ModFiles -> ModuleMap

Extract the combined module map from a set of ModFiles. Useful for parsing a Fortran file in a large context of other modules.

combinedTypeEnv :: ModFiles -> TypeEnv

Extract the combined module map from a set of ModFiles. Useful for parsing a Fortran file in a large context of other modules.

combinedParamVarMap :: ModFiles -> ParamVarMap

Extract the combined string map of ModFiles. Mainly internal use.

genUniqNameToFilenameMap :: ModFiles -> Map Name String

Create a map that links all unique variable/function names in the ModFiles to their corresponding filename.

data TimestampStatus

Status of mod-file compared to Fortran file.

Constructors

NoSuchFile

CompileFile

ModFileExists FilePath

checkTimestamps :: FilePath -> IO TimestampStatus

Compare the source file timestamp to the fsmod file timestamp, if it exists.