Improve targetContents code docs
authorDaniel Gröber <dxld@darkboxed.org>
Tue, 28 May 2019 13:59:26 +0000 (15:59 +0200)
committerBen Gamari <ben@well-typed.com>
Tue, 4 Jun 2019 03:42:12 +0000 (23:42 -0400)
compiler/main/DriverPipeline.hs
compiler/main/GhcMake.hs
compiler/main/HscTypes.hs

index f977f34..8ffeb5e 100644 (file)
@@ -52,7 +52,7 @@ import DynFlags
 import Config
 import Panic
 import Util
-import StringBuffer     ( StringBuffer, hGetStringBuffer, hPutStringBuffer )
+import StringBuffer     ( hGetStringBuffer, hPutStringBuffer )
 import BasicTypes       ( SuccessFlag(..) )
 import Maybes           ( expectJust )
 import SrcLoc
@@ -90,8 +90,8 @@ import Data.Time        ( UTCTime )
 
 preprocess :: HscEnv
            -> FilePath -- ^ input filename
-           -> Maybe StringBuffer
-           -- ^ optional buffer to use instead of reading input file
+           -> Maybe InputFileBuffer
+           -- ^ optional buffer to use instead of reading the input file
            -> Maybe Phase -- ^ starting phase
            -> IO (Either ErrorMessages (DynFlags, FilePath))
 preprocess hsc_env input_fn mb_input_buf mb_phase =
@@ -576,7 +576,7 @@ doLink dflags stop_phase o_files
 runPipeline
   :: Phase                      -- ^ When to stop
   -> HscEnv                     -- ^ Compilation environment
-  -> (FilePath, Maybe StringBuffer, Maybe PhasePlus)
+  -> (FilePath, Maybe InputFileBuffer, Maybe PhasePlus)
                                 -- ^ Pipeline input file name, optional
                                 -- buffer and maybe -x suffix
   -> Maybe FilePath             -- ^ original basename (if different from ^^^)
index d836cf2..d052b71 100644 (file)
@@ -2479,6 +2479,7 @@ getPreprocessedImports
     -> FilePath
     -> Maybe Phase
     -> Maybe (StringBuffer, UTCTime)
+    -- ^ optional source code buffer and modification time
     -> ExceptT ErrorMessages IO PreprocessedImports
 getPreprocessedImports hsc_env src_fn mb_phase maybe_buf = do
   (pi_local_dflags, pi_hspp_fn)
index d43f5c5..ce97e3a 100644 (file)
@@ -13,7 +13,7 @@ module HscTypes (
         -- * compilation state
         HscEnv(..), hscEPS,
         FinderCache, FindResult(..), InstalledFindResult(..),
-        Target(..), TargetId(..), pprTarget, pprTargetId,
+        Target(..), TargetId(..), InputFileBuffer, pprTarget, pprTargetId,
         HscStatus(..),
         IServ(..),
 
@@ -503,7 +503,7 @@ data Target
   = Target {
       targetId           :: TargetId, -- ^ module or filename
       targetAllowObjCode :: Bool,     -- ^ object code allowed?
-      targetContents     :: Maybe (StringBuffer,UTCTime)
+      targetContents     :: Maybe (InputFileBuffer, UTCTime)
       -- ^ Optional in-memory buffer containing the source code GHC should
       -- use for this target instead of reading it from disk.
       --
@@ -526,6 +526,8 @@ data TargetId
         -- should be determined from the suffix of the filename.
   deriving Eq
 
+type InputFileBuffer = StringBuffer
+
 pprTarget :: Target -> SDoc
 pprTarget (Target id obj _) =
     (if obj then char '*' else empty) <> pprTargetId id