Re: [GHC] #1886: GHC API should preserve and provide access to comments
#1886: GHC API should preserve and provide access to comments
--+-
Reporter: claus |
Owner:
Type: bug|
Status: closed
Priority: normal |
Milestone: 6.12 branch
Component: GHC API|
Version: 6.9
Severity: normal |
Resolution: fixed
Keywords: GHC API, comments, program transformation, layout |
Difficulty: Unknown
Testcase: |
Os: Unknown/Multiple
Architecture: Unknown/Multiple |
--+-
Changes (by simonmar):
* status: new = closed
* resolution: = fixed
Comment:
We now have
{{{
getRichTokenStream :: GhcMonad m = Module - m [(Located Token, String)]
showRichTokenStream :: [(Located Token, String)] - String
}}}
amongst other thing, thanks to Jedai. If this isn't enough, please re-
open.
--
Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/1886#comment:10
GHC http://www.haskell.org/ghc/
The Glasgow Haskell Compiler___
Glasgow-haskell-bugs mailing list
Glasgow-haskell-bugs@haskell.org
http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #1886: GHC API should preserve and provide access to comments
#1886: GHC API should preserve and provide access to comments --+- Reporter: claus | Owner: Type: bug| Status: new Priority: normal | Milestone: 6.12 branch Component: GHC API| Version: 6.9 Severity: normal | Resolution: Keywords: GHC API, comments, program transformation, layout | Difficulty: Unknown Testcase: | Os: Unknown/Multiple Architecture: Unknown/Multiple | --+- Changes (by igloo): * milestone: 6.10 branch = 6.12 branch -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/1886#comment:9 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #1886: GHC API should preserve and provide access to comments
#1886: GHC API should preserve and provide access to comments ---+ Reporter: claus | Owner: Type: bug| Status: new Priority: normal | Milestone: 6.10 branch Component: GHC API| Version: 6.9 Severity: normal | Resolution: Keywords: GHC API, comments, program transformation, layout | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Comment (by Jedai): My proposal is to support access to a special kind of token stream including comments. As the tokens themselves aren't enough to get back to the source that produced them (some aesthetic details disappear), I also create a function to add source strings to the tokens in a stream and a function to show such a rich token stream. HaRe use the following model : get the AST and the token stream modify AST propagate changes to token stream second (pretty print the token stream). While this model may not be as convenient as we could hope for, it works and the guts of this process could eventually become a package on Hackage, separate from HaRe. -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/1886#comment:6 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #1886: GHC API should preserve and provide access to comments
#1886: GHC API should preserve and provide access to comments ---+ Reporter: claus | Owner: Type: bug| Status: new Priority: normal | Milestone: 6.10 branch Component: GHC API| Version: 6.9 Severity: normal | Resolution: Keywords: GHC API, comments, program transformation, layout | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Comment (by claus): see also this thread for a simpler breakdown of what is needed, and how it might be achieved: http://www.haskell.org/pipermail/haskell-cafe/2008-May/042671.html -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/1886#comment:5 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #1886: GHC API should preserve and provide access to comments
#1886: GHC API should preserve and provide access to comments ---+ Reporter: claus | Owner: Type: bug| Status: new Priority: normal | Milestone: 6.10 branch Component: GHC API| Version: 6.9 Severity: normal | Resolution: Keywords: GHC API, comments, program transformation, layout | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Comment (by claus): see also this thread on `cvs-ghc`, messages before and after this one: [http://www.haskell.org/pipermail/cvs-ghc/2007-November/039526.html should haddock.ghc be a sub-repo of ghc?] -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/1886#comment:3 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #1886: GHC API should preserve and provide access to comments
#1886: GHC API should preserve and provide access to comments ---+ Reporter: claus | Owner: Type: bug| Status: new Priority: normal | Milestone: 6.10 branch Component: GHC API| Version: 6.9 Severity: normal | Resolution: Keywords: GHC API, comments, program transformation, layout | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Changes (by j.waldmann): * cc: j.waldmann (added) -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/1886#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #1886: GHC API should preserve and provide access to comments
#1886: GHC API should preserve and provide access to comments ---+ Reporter: claus | Owner: Type: bug| Status: new Priority: normal | Milestone: 6.10 branch Component: GHC API| Version: 6.9 Severity: normal | Resolution: Keywords: GHC API, comments, program transformation, layout | Difficulty: Unknown Testcase: | Architecture: Unknown Os: Unknown| ---+ Changes (by igloo): * difficulty: = Unknown * milestone: = 6.10 branch -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/1886#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
[GHC] #1886: GHC API should preserve and provide access to comments
#1886: GHC API should preserve and provide access to comments
-+--
Reporter: claus| Owner:
Type: bug | Status: new
Priority: normal | Milestone:
Component: GHC API |Version: 6.9
Severity: normal | Keywords:
Testcase: | Architecture: Unknown
Os: Unknown |
-+--
one class of applications of the `GHC API` are program transformations
(refactoring, source to source optimisation, partial evaluation, ..) and
code layouters (pretty-print, 2html, syntax-colouring, ..). but, even
ignoring layout, parsing and pretty-printing with the `GHC API` does not
currently preserve the source (nor does it generate syntactically valid
code..).
consider this simple test: we want to parse a module, then pretty-print it
(we might want to adjust the layout, or switch between layout and explicit
braces). applying the attached code to itself gives this result:
{{{
$ /cygdrive/c/fptools/ghc/compiler/stage2/ghc-inplace -package ghc -e main
API_Layout.hs
module API where
import DynFlags
import GHC
import PprTyThing
import System.Process
import System.IO
import Outputable
import Data.Maybe
instance Num () where
[]
[]
{ fromInteger = undefined }
mode = CompManager
compileToCoreFlag = False
writer | cmd = runInteractiveCommand cmd = \ (i, o, e, p) - writer i
cmd | reader = runInteractiveCommand cmd = \ (i, o, e, p) - reader o
ghcDir = c:/fptools/ghc/compiler/stage2/ghc-inplace --print-libdir
|
(fmap dropLineEnds . hGetContents)
where
dropLineEnds = filter (not . (`elem` \r\n))
main = defaultErrorHandler defaultDynFlags
$ do s - newSession . Just = ghcDir
flags - getSessionDynFlags s
(flags, _) - parseDynamicFlags flags [-package ghc]
GHC.defaultCleanupHandler flags
$ do setSessionDynFlags s (flags {hscTarget = HscInterpreted})
addTarget s = guessTarget API_Layout.hs Nothing
load s LoadAllTargets
prelude - findModule s (mkModuleName Prelude) Nothing
usermod - findModule s (mkModuleName API) Nothing
setContext s [usermod] [prelude]
Just cm - checkModule s (mkModuleName API)
compileToCoreFlag
unqual - getPrintUnqual s
printForUser stdout unqual $ ppr $ parsedSource cm
}}}
this has lost all comments, including pragmas, and is syntactically
invalid!
one suggestion, to avoid upsetting the rest of `ghc`, would be to preserve
the comments, with source locations, but to separate them from the main
abstract syntax tree. there would also need to be a way to link ast
fragments to comments, which might be slightly awkward. perhaps something
like:
{{{
-- was there a comment just preceeding the current AST fragment?
commentsBefore :: AST - Maybe String
-- was there a comment immediately following the current AST fragment?
commentsAfter :: AST - Maybe String
}}}
--
Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/1886
GHC http://www.haskell.org/ghc/
The Glasgow Haskell Compiler___
Glasgow-haskell-bugs mailing list
Glasgow-haskell-bugs@haskell.org
http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
Re: [GHC] #1886: GHC API should preserve and provide access to comments
#1886: GHC API should preserve and provide access to comments --+- Reporter: claus | Owner: Type: bug| Status: new Priority: normal | Milestone: Component: GHC API| Version: 6.9 Severity: normal | Resolution: Keywords: GHC API, comments, program transformation, layout | Testcase: Architecture: Unknown| Os: Unknown --+- Changes (by claus): * keywords: = GHC API, comments, program transformation, layout Comment: i forgot one important example of program transformations that would also need layout preservation: version updates to follow library api changes. i think someone once started a business with this kind of thing?-) related ticket: #1467 (api reorganisation of stages) -- Ticket URL: http://hackage.haskell.org/trac/ghc/ticket/1886#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler___ Glasgow-haskell-bugs mailing list Glasgow-haskell-bugs@haskell.org http://www.haskell.org/mailman/listinfo/glasgow-haskell-bugs
