IncludeSpec.hs

{-# LANGUAGE CPP #-}

module Language.Fortran.Parser.Fixed.Fortran77.IncludeSpec where

import System.FilePath
import Test.Hspec
import TestUtil

import Language.Fortran.Parser ( f77lIncludes )
import Language.Fortran.AST
import Language.Fortran.Util.Position
import qualified Data.ByteString.Char8 as B

iParser :: [String] -> String -> IO (ProgramFile A0)
iParser incs = f77lIncludes incs mempty "<unknown>" . B.pack

makeSrcR :: (Int, Int, Int, String) -> (Int, Int, Int, String) -> SrcSpan
makeSrcR (i1, i2, i3, s) (j1, j2, j3, s') = SrcSpan (Position i1 i2 i3 s Nothing) (Position j1 j2 j3 s' Nothing)

spec :: SpecWith ()
spec =
  describe "Include Test" $ do
    let source = unlines ["      program bar",
                          "      include 'foo.f'",
                          "      end"
                         ]
        name = "bar"
        puSpan = makeSrcR (6,7,1,"<unknown>") (48,9,3,"<unknown>")
        st1Span = makeSrcR (24,7,2,"<unknown>") (38,21,2,"<unknown>")
        expSpan = makeSrcR (32,15,2,"<unknown>") (38,21,2,"<unknown>")
        pf inc = ProgramFile mi77' [pu]
         where
          -- the expansion returns the span in the included file
          -- it should return the span at the inclusion
          foo = inc </> "foo.f"
          st2Span = makeSrcR (6,7,1, foo) (14,15,1,foo)
          st3Span = makeSrcR (22,7,2, foo) (30,15,2,foo)
          -- declSpan = makeSrcR (6,7,1,foo) (14,15,1,foo)
          ty1Span = makeSrcR (6,7,1,foo) (12,13,1,foo)
          ty2Span = makeSrcR (22,7,2,foo) (28,13,2,foo)
          var1Span = makeSrcR (14,15,1,foo) (14,15,1,foo)
          var2Span = makeSrcR (30,15,2,foo) (30,15,2,foo)
          varGen' ss str =  ExpValue () ss $ ValVariable str

          pu = PUMain () puSpan (Just name) blocks Nothing
          blocks = [bl st1Span st1]
          decl var = Declarator () (getSpan var) var ScalarDecl Nothing Nothing
          typeSpec tySpan = TypeSpec () tySpan TypeInteger Nothing
          st ss tySs var = StDeclaration () ss (typeSpec tySs) Nothing (AList () (getSpan var) [decl var])
          bl ss = BlStatement () ss Nothing
          st1 = StInclude () st1Span ex (Just 
            [ bl st2Span . st st2Span ty1Span $ varGen' var1Span "a"
            , bl st3Span . st st3Span ty2Span $ varGen' var2Span "b"
            ])
          ex = ExpValue () expSpan (ValString "foo.f")
#ifndef FS_DISABLE_WIN_BROKEN_TESTS
    -- 2022-08-18 raehik
    -- These tests failed on the Windows CI on GitHub with an unknown error. I'm
    -- assuming it's to do with 'SrcSpan's not matching -- specifically the
    -- absolute offsets stored inside the positions, which aren't displayed by
    -- their 'Show' instance. I can't reproduce locally and it's almost
    -- certainly not a bug, just an issue with testing, so disabling on Windows.
    it "includes some files and expands them" $ do
      let inc = "." </> "test-data" </> "f77-include"
      pfParsed <- iParser [inc] source
      pfParsed `shouldBe` pf inc
    it "includes without a newline behave the same" $ do 
      let inc = "." </> "test-data" </> "f77-include" </> "no-newline"
      pfParsed <- iParser [inc] source
      pfParsed `shouldBe` pf inc
#else
    pure ()
#endif