Module Ide.Utilities

Provide functions for use in the fregIDE

Imports

• import Compiler.common.CompilerOptions as CompilerOptions
• import Compiler.types.ConstructorField as ConstructorField
• import Data.List as DL
• import Tools.doc.Utilities as DU
• import Compiler.types.Expression as Expression
• import Compiler.enums.Flags as Flags
• import Compiler.types.Global as G
• import Compiler.passes.Imp as I
• import Compiler.grammar.Lexer as Lex
• import Compiler.Main as M
• import Lib.Modules as Modules
• import Compiler.types.NSNames as NSNames
• import Java.Net as Net
• import Compiler.classes.Nice as Nice
• import Compiler.instances.Nicer as Nicer
• import Compiler.types.Packs as Packs
• import Compiler.types.Positions as Positions
• import frege.Prelude as Prelude
• import Prelude.PreludeArrays as PreludeArrays
• import Prelude.PreludeBase as PreludeBase
• import Prelude.PreludeDecimal as PreludeDecimal
• import Prelude.PreludeIO as PreludeIO
• import Prelude.PreludeList as PreludeList
• import Prelude.PreludeMonad as PreludeMonad
• import Prelude.PreludeText as PreludeText
• import Compiler.types.QNames as QNames
• import Java.util.Regex as Regexp
• import Compiler.types.Symbols as Symbols
• import Compiler.tc.Util as TC
• import Compiler.common.Types as TH
• import Data.TreeMap as TM
• import Compiler.Typecheck as TY
• import Compiler.enums.TokenID as TokenID
• import Compiler.types.Tokens as Tokens
• import Compiler.types.Types as Types
• import Compiler.Utilities as U
• import Compiler.enums.Visibility as Visibility

Table of Content

• Definitions

  data Proposal

  initRoot ∷ String → IO (Y RTree)

  justCompiled ∷ String → MutableIO URLClassLoader → Y RTree → IO (Y RTree)

  updateCache ∷ Applicative 𝖈 ⇒ 𝖆 → 𝖇 → 𝖈 ()

  refreshPackages ∷ StIO ()

  newLoader ∷ StIO ()

  magicPNs ∷ [([String], 𝖆)] → [([String], 𝖆)]

  backwards ∷ JArray Token → Int → [Token]

  proposeContent ∷ Global → Y RTree → Int → JArray Token → Int → [Proposal]

  imports ∷ Global → [(Position, String, String)]

  symbols ∷ Symtab → [Symbol]

  exprSymbols ∷ ExprT → StG [Symbol]

  verbose ∷ (Nice 𝖆, QNameMatcher.QNameMatcher 𝖆) ⇒ Global → SigmaT 𝖆 → String

  label ∷ Global → SymbolT a → String

  passDone ∷ StG ()

  thisTab ∷ Global → Symtab

  htmlDocumentation ∷ String → StIO String

  htmlify ∷ Global → String → IO String

  packDocumentation ∷ String → StIO String

  symbolDocumentation ∷ Symbol → StIO String

  documentationDocumentation ∷ String → StIO String

  tokenDocumentation ∷ Token → StIO String

  infixDoc ∷ Global → String

  correctDependenciesFor ∷ [String] → String → [String]

  getDependencies ∷ CharSequence → StG [String]

  lexPassIDE ∷ CharSequence → StG (String, Int)

• Re-Exported Items

  symDcolon ∷ Global → String

• Instances

  instance Show Proposal

• Functions and Values by Type

Definitions

initRoot ∷ String → IO (Y RTree)

initialize the root of the package tree

justCompiled ∷ String → MutableIO URLClassLoader → Y RTree → IO (Y RTree)

add a new module

updateCache ∷ Applicative 𝖈 ⇒ 𝖆 → 𝖇 → 𝖈 ()

Remove this package from the package cache

refreshPackages ∷ StIO ()

Force the import to re-create packages next time

newLoader ∷ StIO ()

Make a new loader for operation in the IDE. The rationale is that not making a new loader for every character typed will save time and space.

The IDE code must decide when to make a new loader. For instance, this could be appropriate when the editor is re-activated, because in the meantime other modules could have been rebuild.

magicPNs ∷ [([String], 𝖆)] → [([String], 𝖆)]

add magic package names

backwards ∷ JArray Token → Int → [Token]

create a Token list from an JArray backwards

data Proposal

This resembles the SourceProposal class. The additional information must be lazy!

Constructors

Proposal {proposal ∷ String, newText ∷ String, prefix ∷ String, off ∷ Int, len ∷ Int, cursor ∷ Int, additional ∷ IO String}

Member Functions

additional ∷ Proposal → IO String

Additional information displayed in the pop-up view to the right of the main proposal list view when this proposal is selected.

cursor ∷ Proposal → Int

The offset at which the insertion point should be placed after completing using this proposal, relative to the end of the inserted text.

len ∷ Proposal → Int

The range of text being replaced.

newText ∷ Proposal → String

The new text being added/substituted if the user accepts this proposal

off ∷ Proposal → Int

The range of text being replaced.

prefix ∷ Proposal → String

The prefix being completed.

proposal ∷ Proposal → String

The text shown to the user in the popup view

proposeContent ∷ Global → Y RTree → Int → JArray Token → Int → [Proposal]

Called by Eclipse Content Proposer to make proposals.

Usage: proposeContent global offset tokens index

global

a symbol table, preferably with type information

offset

position of the caret

tokens

array of tokens

index

index into the array, points to the token that starts before the caret

imports ∷ Global → [(Position, String, String)]

Create a list of triples with position, namespace and package for every import except the automatic ones.

symbols ∷ Symtab → [Symbol]

Create the list of symbols ordered by position

exprSymbols ∷ ExprT → StG [Symbol]

verbose ∷ (Nice 𝖆, QNameMatcher.QNameMatcher 𝖆) ⇒ Global → SigmaT 𝖆 → String

label ∷ Global → SymbolT a → String

Make a label for a symbol

passDone ∷ StG ()

Increment the pass number in the state

thisTab ∷ Global → Symtab

Failure tolerant version of Global.thisTab for use in TreeModelBuilder. In case of syntax errors, there is no symtab yet, hence Global.thisTab is undefined. This, in turn, causes an exception in Eclipse. We can avoid this by just pretending the symbol table was empty.

htmlDocumentation ∷ String → StIO String

htmlify ∷ Global → String → IO String

packDocumentation ∷ String → StIO String

symbolDocumentation ∷ Symbol → StIO String

documentationDocumentation ∷ String → StIO String

tokenDocumentation ∷ Token → StIO String

This is called from the fregIDE documentation provider when the reference resolver didn't find anything.

This indicates the mouse was not hovering over some identifier.

infixDoc ∷ Global → String

find all operators in the current symbol table and tabulate their fixities

correctDependenciesFor ∷ [String] → String → [String]

Correct the result of frege.compiler.Scanner.dependencies, which returns a singleton list with one element "frege.prelude.PreludeBase" for source files that don't have any import clauses. Yet, unless this is a prelude package itself, "frege.Prelude" will be imported.

This discrepancy leads to files not compiling in the FregIDE builder because they are queued before "frege/Prelude.fr"

getDependencies ∷ CharSequence → StG [String]

Get all the dependencies from a source text

This will be done on a fresh Global

lexPassIDE ∷ CharSequence → StG (String, Int)

lexical analysis from the IDE does not read files, but takes the content directly

Instances

instance Show Proposal

Member Functions

display ∷ Proposal → String

inherited from Show.display

show ∷ Proposal → String

showChars ∷ Proposal → [Char]

inherited from Show.showChars

showList ∷ [Proposal] → String → String

inherited from Show.showList

showsPrec ∷ Int → Proposal → String → String

inherited from Show.showsPrec

showsub ∷ Proposal → String

inherited from Show.showsub

Functions and Values by Type

Symtab → [Symbol]

symbols

Symbol → StIO String

symbolDocumentation

JArray Token → Int → [Token]

backwards

String → MutableIO URLClassLoader → Y RTree → IO (Y RTree)

justCompiled

String → String → String → Int → Int → Int → IO String → Proposal

Proposal.Proposal

String → StIO String

documentationDocumentation, htmlDocumentation, packDocumentation

String → IO (Y RTree)

initRoot

[String] → String → [String]

correctDependenciesFor

[Proposal] → String → String

Show_Proposal.showList

ExprT → StG [Symbol]

exprSymbols

Global → Y RTree → Int → JArray Token → Int → [Proposal]

proposeContent

Global → String → IO String

htmlify

Global → Symtab

thisTab

Global → String

infixDoc

Global → [(Position, String, String)]

imports

Token → StIO String

tokenDocumentation

Proposal → (IO String→IO String) → Proposal

Proposal.chg$additional

Proposal → (String→String) → Proposal

Proposal.chg$proposal, Proposal.chg$newText, Proposal.chg$prefix

Proposal → (Int→Int) → Proposal

Proposal.chg$off, Proposal.chg$len, Proposal.chg$cursor

Proposal → IO String → Proposal

Proposal.upd$additional

Proposal → String → Proposal

Proposal.upd$proposal, Proposal.upd$prefix, Proposal.upd$newText

Proposal → Int → Proposal

Proposal.upd$off, Proposal.upd$len, Proposal.upd$cursor

Proposal → IO String

Proposal.additional

Proposal → String

Show_Proposal.showsub, Show_Proposal.display, Show_Proposal.show, Proposal.proposal, Proposal.newText, Proposal.prefix

Proposal → [Char]

Show_Proposal.showChars

Proposal → Int

Proposal.off, Proposal.len, Proposal.cursor

CharSequence → StG (String, Int)

lexPassIDE

CharSequence → StG [String]

getDependencies

Int → Proposal → String → String

Show_Proposal.showsPrec

StIO ()

newLoader, refreshPackages

StG ()

passDone

[([String], 𝖆)] → [([String], 𝖆)]

magicPNs

Global → SymbolT a → String

label

𝖆 → Bool

Proposal.has$proposal, Proposal.has$off, Proposal.has$len, Proposal.has$newText, Proposal.has$prefix, Proposal.has$additional, Proposal.has$cursor

(Nice 𝖆, QNameMatcher.QNameMatcher 𝖆) ⇒ Global → SigmaT 𝖆 → String

verbose

Applicative 𝖈 ⇒ 𝖆 → 𝖇 → 𝖈 ()

updateCache