IDE.Core.CTypes

Description

Synopsis

• data PackageDescr = PackageDescr {
  • pdPackage :: PackageIdentifier
  • pdMbSourcePath :: Maybe FilePath
  • pdModules :: [ModuleDescr]
  • pdBuildDepends :: [PackageIdentifier]
  }
• data ModuleDescr = ModuleDescr {
  • mdModuleId :: PackModule
  • mdMbSourcePath :: Maybe FilePath
  • mdReferences :: Map ModuleName (Set Text)
  • mdIdDescriptions :: [Descr]
  }
• data Descr
  • = Real RealDescr
  • | Reexported ReexportedDescr
• data RealDescr = RealDescr {
  • dscName' :: Text
  • dscMbTypeStr' :: Maybe ByteString
  • dscMbModu' :: Maybe PackModule
  • dscMbLocation' :: Maybe Location
  • dscMbComment' :: Maybe ByteString
  • dscTypeHint' :: TypeDescr
  • dscExported' :: Bool
  }
• data ReexportedDescr = ReexportedDescr {
  • dsrMbModu :: Maybe PackModule
  • dsrDescr :: Descr
  }
• newtype Present alpha = Present alpha
• data TypeDescr
  • = VariableDescr
  • | FieldDescr Descr
  • | ConstructorDescr Descr
  • | DataDescr [SimpleDescr] [SimpleDescr]
  • | TypeDescr
  • | NewtypeDescr SimpleDescr (Maybe SimpleDescr)
  • | ClassDescr [Text] [SimpleDescr]
  • | MethodDescr Descr
  • | InstanceDescr [Text]
  • | KeywordDescr
  • | ExtensionDescr
  • | ModNameDescr
  • | QualModNameDescr
  • | ErrorDescr
• data DescrType
  • = Variable
  • | Field
  • | Constructor
  • | Data
  • | Type
  • | Newtype
  • | Class
  • | Method
  • | Instance
  • | Keyword
  • | Extension
  • | ModName
  • | QualModName
  • | Error
• data SimpleDescr = SimpleDescr {
  • sdName :: Text
  • sdType :: Maybe ByteString
  • sdLocation :: Maybe Location
  • sdComment :: Maybe ByteString
  • sdExported :: Bool
  }
• data GenScope = forall alpha . SymbolTable alpha => GenScopeC (PackScope alpha)
• dscName :: Descr -> Text
• dscMbTypeStr :: Descr -> Maybe ByteString
• dscMbModu :: Descr -> Maybe PackModule
• dsMbModu :: Descr -> Maybe PackModule
• dscMbLocation :: Descr -> Maybe Location
• dscMbComment :: Descr -> Maybe ByteString
• dscTypeHint :: Descr -> TypeDescr
• dscExported :: Descr -> Bool
• descrType :: TypeDescr -> DescrType
• isReexported :: Descr -> Bool
• data PackScope alpha = SymbolTable alpha => PackScope (Map PackageIdentifier PackageDescr) alpha
• class SymbolTable alpha where
  • symLookup :: Text -> alpha -> [Descr]
  • symbols :: alpha -> Set Text
  • symSplitLookup :: Text -> alpha -> (alpha, Maybe [Descr], alpha)
  • symInsert :: Text -> [Descr] -> alpha -> alpha
  • symEmpty :: alpha
  • symElems :: alpha -> [[Descr]]
  • symUnion :: alpha -> alpha -> alpha
• data PackModule = PM {
  • pack :: PackageIdentifier
  • modu :: ModuleName
  }
• parsePackModule :: Text -> PackModule
• showPackModule :: PackModule -> Text
• packageIdentifierToString :: PackageIdentifier -> Text
• packageIdentifierFromString :: Text -> Maybe PackageIdentifier
• data Location = Location {
  • locationFile :: FilePath
  • locationSLine :: Int
  • locationSCol :: Int
  • locationELine :: Int
  • locationECol :: Int
  }
• data SrcSpan = SrcSpan {
  • srcSpanFilename :: FilePath
  • srcSpanStartLine :: Int
  • srcSpanStartColumn :: Int
  • srcSpanEndLine :: Int
  • srcSpanEndColumn :: Int
  }
• data Scope
  • = PackageScope Bool
  • | WorkspaceScope Bool
  • | SystemScope
• data ServerCommand
  • = SystemCommand {
    • scRebuild :: Bool
    • scSources :: Bool
    • scExtract :: Bool
    }
  • | WorkspaceCommand {
    • wcRebuild :: Bool
    • wcPackage :: PackageIdentifier
    • wcPath :: FilePath
    • wcModList :: [(Text, FilePath)]
    }
  • | ParseHeaderCommand {
    • hcFilePath :: FilePath
    }
• data ServerAnswer
  • = ServerOK
  • | ServerFailed Text
  • | ServerHeader (Either [ImportDecl] Int)
• leksahVersion :: FilePath
• configDirName :: FilePath
• metadataVersion :: Integer
• data ImportDecl = ImportDecl {
  • importLoc :: Location
  • importModule :: Text
  • importQualified :: Bool
  • importSrc :: Bool
  • importPkg :: Maybe Text
  • importAs :: Maybe Text
  • importSpecs :: Maybe ImportSpecList
  }
• data ImportSpecList = ImportSpecList Bool [ImportSpec]
• data ImportSpec
  • = IVar Text
  • | IAbs Text
  • | IThingAll Text
  • | IThingWith Text [Text]
• getThisPackage :: PackageConfig -> PackageIdentifier
• data RetrieveStrategy
  • = RetrieveThenBuild
  • | BuildThenRetrieve
  • | NeverRetrieve

Documentation