Safe Haskell	None
Language	Haskell2010

Language.Fortran.Util.ModFile

Description

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.

One typical usage might look like:

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

Synopsis

Documentation

modFileSuffix :: String Source #

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

data ModFile Source #

The data stored in the "mod files"

Instances

Eq ModFile Source #
Methods (==) :: ModFile -> ModFile -> Bool # (/=) :: ModFile -> ModFile -> Bool #
Data ModFile Source #
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 Source #
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 Source #
Methods showsPrec :: Int -> ModFile -> ShowS # show :: ModFile -> String # showList :: [ModFile] -> ShowS #
Generic ModFile Source #
Associated Types type Rep ModFile :: * -> * # Methods from :: ModFile -> Rep ModFile x # to :: Rep ModFile x -> ModFile #
Binary ModFile Source #
Methods put :: ModFile -> Put # get :: Get ModFile # putList :: [ModFile] -> Put #
type Rep ModFile Source #
type Rep ModFile = D1 * (MetaData "ModFile" "Language.Fortran.Util.ModFile" "fortran-src-0.2.1.1-4CSp5fVEmo08Ygy2mwA6e4" False) (C1 * (MetaCons "ModFile" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "mfFilename") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * String)) (S1 * (MetaSel (Just Symbol "mfModuleMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * ModuleMap))) ((::) (S1 * (MetaSel (Just Symbol "mfDeclMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * DeclMap)) ((::) (S1 * (MetaSel (Just Symbol "mfTypeEnv") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * TypeEnv)) (S1 * (MetaSel (Just Symbol "mfOtherData") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Map String ByteString)))))))

type ModFiles = [ModFile] Source #

A set of decoded mod files.

emptyModFile :: ModFile Source #

Starting point.

emptyModFiles :: ModFiles Source #

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

lookupModFileData :: String -> ModFile -> Maybe ByteString Source #

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

getLabelsModFileData :: ModFile -> [String] Source #

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 Source #

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 Source #

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 Source #

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

encodeModFile :: ModFile -> ByteString Source #

Convert ModFile to a strict ByteString for writing to file.

decodeModFile :: Binary a => ByteString -> Either String a Source #

Convert a strict ByteString to a ModFile, if possible

type DeclMap = Map Name (DeclContext, SrcSpan) Source #

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

data DeclContext Source #

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 Source #
Methods (==) :: DeclContext -> DeclContext -> Bool # (/=) :: DeclContext -> DeclContext -> Bool #
Data DeclContext Source #
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 Source #
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 Source #
Methods showsPrec :: Int -> DeclContext -> ShowS # show :: DeclContext -> String # showList :: [DeclContext] -> ShowS #
Generic DeclContext Source #
Associated Types type Rep DeclContext :: * -> * # Methods from :: DeclContext -> Rep DeclContext x # to :: Rep DeclContext x -> DeclContext #
Binary DeclContext Source #
Methods put :: DeclContext -> Put # get :: Get DeclContext # putList :: [DeclContext] -> Put #
type Rep DeclContext Source #
type Rep DeclContext = D1 * (MetaData "DeclContext" "Language.Fortran.Util.ModFile" "fortran-src-0.2.1.1-4CSp5fVEmo08Ygy2mwA6e4" False) ((:+:) * ((:+:) * (C1 * (MetaCons "DCMain" PrefixI False) (U1 )) (C1 (MetaCons "DCBlockData" PrefixI False) (U1 ))) ((:+:) (C1 * (MetaCons "DCModule" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * ProgramUnitName))) ((:+:) * (C1 * (MetaCons "DCFunction" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (ProgramUnitName, ProgramUnitName)))) (C1 * (MetaCons "DCSubroutine" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (ProgramUnitName, ProgramUnitName)))))))

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

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 Source #

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

moduleFilename :: ModFile -> String Source #

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

combinedDeclMap :: ModFiles -> DeclMap Source #

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 Source #

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 Source #

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

genUniqNameToFilenameMap :: ModFiles -> Map Name String Source #

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