Safe Haskell	None
Language	Haskell2010

HsDev.Symbols.Location

Synopsis

data ModulePackage = ModulePackage {
- _packageName :: Text
- _packageVersion :: Text
}
mkPackage :: Text -> ModulePackage
data PackageConfig = PackageConfig {
- _package :: ModulePackage
- _packageModules :: [Text]
- _packageExposed :: Bool
}
data ModuleLocation
- = FileModule {
  - _moduleFile :: Path
  - _moduleProject :: Maybe Project
  }
- | InstalledModule {
  - _moduleInstallDirs :: [Path]
  - _modulePackage :: ModulePackage
  - _installedModuleName :: Text
  - _installedModuleExposed :: Bool
  }
- | OtherLocation {
  - _otherLocationName :: Text
  }
- | NoLocation
locationId :: ModuleLocation -> Text
noLocation :: ModuleLocation
data ModuleId = ModuleId {
- _moduleName :: Text
- _moduleLocation :: ModuleLocation
}
moduleName :: Lens' ModuleId Text
moduleLocation :: Lens' ModuleId ModuleLocation
data SymbolId = SymbolId {
- _symbolName :: Text
- _symbolModule :: ModuleId
}
symbolName :: Lens' SymbolId Text
symbolModule :: Lens' SymbolId ModuleId
data Position = Position {
- _positionLine :: Int
- _positionColumn :: Int
}
data Region = Region {
- _regionFrom :: Position
- _regionTo :: Position
}
region :: Position -> Position -> Region
regionAt :: Position -> Region
regionLines :: Region -> Int
regionStr :: Region -> Text -> Text
data Location = Location {
- _locationModule :: ModuleLocation
- _locationPosition :: Maybe Position
}
packageName :: Lens' ModulePackage Text
packageVersion :: Lens' ModulePackage Text
package :: Lens' PackageConfig ModulePackage
packageModules :: Lens' PackageConfig [Text]
packageExposed :: Lens' PackageConfig Bool
moduleFile :: Traversal' ModuleLocation Path
moduleProject :: Traversal' ModuleLocation (Maybe Project)
moduleInstallDirs :: Traversal' ModuleLocation [Path]
modulePackage :: Traversal' ModuleLocation ModulePackage
installedModuleName :: Traversal' ModuleLocation Text
installedModuleExposed :: Traversal' ModuleLocation Bool
otherLocationName :: Traversal' ModuleLocation Text
positionLine :: Lens' Position Int
positionColumn :: Lens' Position Int
regionFrom :: Lens' Region Position
regionTo :: Lens' Region Position
locationModule :: Lens' Location ModuleLocation
locationPosition :: Lens' Location (Maybe Position)
sourceModuleRoot :: Text -> Path -> Path
importPath :: Text -> Path
sourceRoot :: ModuleId -> Maybe Path
sourceRoot_ :: ModuleId -> Path
class RecalcTabs a where
- recalcTabs :: Text -> Int -> a -> a
- calcTabs :: Text -> Int -> a -> a
module HsDev.PackageDb.Types

Documentation

data ModulePackage Source #

Just package name and version without its location

Constructors

ModulePackage
Fields _packageName :: Text _packageVersion :: Text

Instances

Instances details

Eq ModulePackage Source #
Instance details Defined in HsDev.Symbols.Location Methods (==) :: ModulePackage -> ModulePackage -> Bool # (/=) :: ModulePackage -> ModulePackage -> Bool #
Ord ModulePackage Source #
Instance details Defined in HsDev.Symbols.Location Methods compare :: ModulePackage -> ModulePackage -> Ordering # (<) :: ModulePackage -> ModulePackage -> Bool # (<=) :: ModulePackage -> ModulePackage -> Bool # (>) :: ModulePackage -> ModulePackage -> Bool # (>=) :: ModulePackage -> ModulePackage -> Bool # max :: ModulePackage -> ModulePackage -> ModulePackage # min :: ModulePackage -> ModulePackage -> ModulePackage #
Read ModulePackage Source #
Instance details Defined in HsDev.Symbols.Location Methods readsPrec :: Int -> ReadS ModulePackage # readList :: ReadS [ModulePackage] # readPrec :: ReadPrec ModulePackage # readListPrec :: ReadPrec [ModulePackage] #
Show ModulePackage Source #
Instance details Defined in HsDev.Symbols.Location Methods showsPrec :: Int -> ModulePackage -> ShowS # show :: ModulePackage -> String # showList :: [ModulePackage] -> ShowS #
NFData ModulePackage Source #
Instance details Defined in HsDev.Symbols.Location Methods rnf :: ModulePackage -> () #
ToJSON ModulePackage Source #
Instance details Defined in HsDev.Symbols.Location Methods toJSON :: ModulePackage -> Value # toEncoding :: ModulePackage -> Encoding # toJSONList :: [ModulePackage] -> Value # toEncodingList :: [ModulePackage] -> Encoding #
FromJSON ModulePackage Source #
Instance details Defined in HsDev.Symbols.Location Methods parseJSON :: Value -> Parser ModulePackage # parseJSONList :: Value -> Parser [ModulePackage] #
FromRow ModulePackage Source #
Instance details Defined in HsDev.Database.SQLite.Instances Methods fromRow :: RowParser ModulePackage #
ToRow ModulePackage Source #
Instance details Defined in HsDev.Database.SQLite.Instances Methods toRow :: ModulePackage -> [SQLData] #
Documented ModulePackage Source #
Instance details Defined in HsDev.Symbols.Documented Methods brief :: ModulePackage -> Text Source # detailed :: ModulePackage -> Text Source #

mkPackage :: Text -> ModulePackage Source #

data PackageConfig Source #

Constructors

PackageConfig
Fields _package :: ModulePackage _packageModules :: [Text] _packageExposed :: Bool

Instances

Instances details

Eq PackageConfig Source #
Instance details Defined in HsDev.Symbols.Location Methods (==) :: PackageConfig -> PackageConfig -> Bool # (/=) :: PackageConfig -> PackageConfig -> Bool #
Ord PackageConfig Source #
Instance details Defined in HsDev.Symbols.Location Methods compare :: PackageConfig -> PackageConfig -> Ordering # (<) :: PackageConfig -> PackageConfig -> Bool # (<=) :: PackageConfig -> PackageConfig -> Bool # (>) :: PackageConfig -> PackageConfig -> Bool # (>=) :: PackageConfig -> PackageConfig -> Bool # max :: PackageConfig -> PackageConfig -> PackageConfig # min :: PackageConfig -> PackageConfig -> PackageConfig #
Read PackageConfig Source #
Instance details Defined in HsDev.Symbols.Location Methods readsPrec :: Int -> ReadS PackageConfig # readList :: ReadS [PackageConfig] # readPrec :: ReadPrec PackageConfig # readListPrec :: ReadPrec [PackageConfig] #
Show PackageConfig Source #
Instance details Defined in HsDev.Symbols.Location Methods showsPrec :: Int -> PackageConfig -> ShowS # show :: PackageConfig -> String # showList :: [PackageConfig] -> ShowS #
NFData PackageConfig Source #
Instance details Defined in HsDev.Symbols.Location Methods rnf :: PackageConfig -> () #
ToJSON PackageConfig Source #
Instance details Defined in HsDev.Symbols.Location Methods toJSON :: PackageConfig -> Value # toEncoding :: PackageConfig -> Encoding # toJSONList :: [PackageConfig] -> Value # toEncodingList :: [PackageConfig] -> Encoding #
FromJSON PackageConfig Source #
Instance details Defined in HsDev.Symbols.Location Methods parseJSON :: Value -> Parser PackageConfig # parseJSONList :: Value -> Parser [PackageConfig] #

data ModuleLocation Source #

Location of module

Constructors

FileModule
Fields _moduleFile :: Path _moduleProject :: Maybe Project
InstalledModule
Fields _moduleInstallDirs :: [Path] _modulePackage :: ModulePackage _installedModuleName :: Text _installedModuleExposed :: Bool
OtherLocation
Fields _otherLocationName :: Text
NoLocation

Instances

Instances details

Eq ModuleLocation Source #
Instance details Defined in HsDev.Symbols.Location Methods (==) :: ModuleLocation -> ModuleLocation -> Bool # (/=) :: ModuleLocation -> ModuleLocation -> Bool #
Ord ModuleLocation Source #
Instance details Defined in HsDev.Symbols.Location Methods compare :: ModuleLocation -> ModuleLocation -> Ordering # (<) :: ModuleLocation -> ModuleLocation -> Bool # (<=) :: ModuleLocation -> ModuleLocation -> Bool # (>) :: ModuleLocation -> ModuleLocation -> Bool # (>=) :: ModuleLocation -> ModuleLocation -> Bool # max :: ModuleLocation -> ModuleLocation -> ModuleLocation # min :: ModuleLocation -> ModuleLocation -> ModuleLocation #
Show ModuleLocation Source #
Instance details Defined in HsDev.Symbols.Location Methods showsPrec :: Int -> ModuleLocation -> ShowS # show :: ModuleLocation -> String # showList :: [ModuleLocation] -> ShowS #
Show InspectedModule Source #
Instance details Defined in HsDev.Symbols.Types Methods showsPrec :: Int -> InspectedModule -> ShowS # show :: InspectedModule -> String # showList :: [InspectedModule] -> ShowS #
NFData ModuleLocation Source #
Instance details Defined in HsDev.Symbols.Location Methods rnf :: ModuleLocation -> () #
ToJSON ModuleLocation Source #
Instance details Defined in HsDev.Symbols.Location Methods toJSON :: ModuleLocation -> Value # toEncoding :: ModuleLocation -> Encoding # toJSONList :: [ModuleLocation] -> Value # toEncodingList :: [ModuleLocation] -> Encoding #
FromJSON ModuleLocation Source #
Instance details Defined in HsDev.Symbols.Location Methods parseJSON :: Value -> Parser ModuleLocation # parseJSONList :: Value -> Parser [ModuleLocation] #
Formattable ModuleLocation Source #
Instance details Defined in HsDev.Symbols.Location Methods formattable :: ModuleLocation -> FormatFlags -> Formatted #
FromRow ModuleLocation Source #
Instance details Defined in HsDev.Database.SQLite.Instances Methods fromRow :: RowParser ModuleLocation #
ToRow ModuleLocation Source #
Instance details Defined in HsDev.Database.SQLite.Instances Methods toRow :: ModuleLocation -> [SQLData] #
Paths ModuleLocation Source #
Instance details Defined in HsDev.Symbols.Location Methods paths :: Traversal' ModuleLocation FilePath Source #
Display ModuleLocation Source #
Instance details Defined in HsDev.Symbols.Location Methods display :: ModuleLocation -> String Source # displayType :: ModuleLocation -> String Source #
Documented ModuleLocation Source #
Instance details Defined in HsDev.Symbols.Documented Methods brief :: ModuleLocation -> Text Source # detailed :: ModuleLocation -> Text Source #
EnumContents ModuleLocation Source #
Instance details Defined in HsDev.Scan Methods enumContents :: CommandMonad m => ModuleLocation -> m ScanContents Source #
EnumContents (Extensions ModuleLocation) Source #
Instance details Defined in HsDev.Scan Methods enumContents :: CommandMonad m => Extensions ModuleLocation -> m ScanContents Source #
Monad m => MonadWriter [ModuleLocation] (UpdateM m) Source #
Instance details Defined in HsDev.Database.Update.Types Methods writer :: (a, [ModuleLocation]) -> UpdateM m a # tell :: [ModuleLocation] -> UpdateM m () # listen :: UpdateM m a -> UpdateM m (a, [ModuleLocation]) # pass :: UpdateM m (a, [ModuleLocation] -> [ModuleLocation]) -> UpdateM m a #

locationId :: ModuleLocation -> Text Source #

noLocation :: ModuleLocation Source #

data ModuleId Source #

Constructors

ModuleId
Fields _moduleName :: Text _moduleLocation :: ModuleLocation

Instances

Instances details

Eq ModuleId Source #
Instance details Defined in HsDev.Symbols.Location Methods (==) :: ModuleId -> ModuleId -> Bool # (/=) :: ModuleId -> ModuleId -> Bool #
Ord ModuleId Source #
Instance details Defined in HsDev.Symbols.Location Methods compare :: ModuleId -> ModuleId -> Ordering # (<) :: ModuleId -> ModuleId -> Bool # (<=) :: ModuleId -> ModuleId -> Bool # (>) :: ModuleId -> ModuleId -> Bool # (>=) :: ModuleId -> ModuleId -> Bool # max :: ModuleId -> ModuleId -> ModuleId # min :: ModuleId -> ModuleId -> ModuleId #
Show ModuleId Source #
Instance details Defined in HsDev.Symbols.Location Methods showsPrec :: Int -> ModuleId -> ShowS # show :: ModuleId -> String # showList :: [ModuleId] -> ShowS #
NFData ModuleId Source #
Instance details Defined in HsDev.Symbols.Location Methods rnf :: ModuleId -> () #
ToJSON ModuleId Source #
Instance details Defined in HsDev.Symbols.Location Methods toJSON :: ModuleId -> Value # toEncoding :: ModuleId -> Encoding # toJSONList :: [ModuleId] -> Value # toEncodingList :: [ModuleId] -> Encoding #
FromJSON ModuleId Source #
Instance details Defined in HsDev.Symbols.Location Methods parseJSON :: Value -> Parser ModuleId # parseJSONList :: Value -> Parser [ModuleId] #
FromRow ModuleId Source #
Instance details Defined in HsDev.Database.SQLite.Instances Methods fromRow :: RowParser ModuleId #
ToRow ModuleId Source #
Instance details Defined in HsDev.Database.SQLite.Instances Methods toRow :: ModuleId -> [SQLData] #
Sourced ModuleId Source #
Instance details Defined in HsDev.Symbols.Class Methods sourcedName :: Lens' ModuleId Text Source # sourcedDocs :: Traversal' ModuleId Text Source # sourcedModule :: Lens' ModuleId ModuleId Source # sourcedLocation :: Traversal' ModuleId Position Source #
Documented ModuleId Source #
Instance details Defined in HsDev.Symbols.Types Methods brief :: ModuleId -> Text Source # detailed :: ModuleId -> Text Source #

moduleName :: Lens' ModuleId Text Source #

moduleLocation :: Lens' ModuleId ModuleLocation Source #

data SymbolId Source #

Symbol

Constructors

SymbolId
Fields _symbolName :: Text _symbolModule :: ModuleId

Instances

Instances details

Eq SymbolId Source #
Instance details Defined in HsDev.Symbols.Location Methods (==) :: SymbolId -> SymbolId -> Bool # (/=) :: SymbolId -> SymbolId -> Bool #
Ord SymbolId Source #
Instance details Defined in HsDev.Symbols.Location Methods compare :: SymbolId -> SymbolId -> Ordering # (<) :: SymbolId -> SymbolId -> Bool # (<=) :: SymbolId -> SymbolId -> Bool # (>) :: SymbolId -> SymbolId -> Bool # (>=) :: SymbolId -> SymbolId -> Bool # max :: SymbolId -> SymbolId -> SymbolId # min :: SymbolId -> SymbolId -> SymbolId #
Show SymbolId Source #
Instance details Defined in HsDev.Symbols.Location Methods showsPrec :: Int -> SymbolId -> ShowS # show :: SymbolId -> String # showList :: [SymbolId] -> ShowS #
NFData SymbolId Source #
Instance details Defined in HsDev.Symbols.Location Methods rnf :: SymbolId -> () #
ToJSON SymbolId Source #
Instance details Defined in HsDev.Symbols.Location Methods toJSON :: SymbolId -> Value # toEncoding :: SymbolId -> Encoding # toJSONList :: [SymbolId] -> Value # toEncodingList :: [SymbolId] -> Encoding #
FromJSON SymbolId Source #
Instance details Defined in HsDev.Symbols.Location Methods parseJSON :: Value -> Parser SymbolId # parseJSONList :: Value -> Parser [SymbolId] #
FromRow SymbolId Source #
Instance details Defined in HsDev.Database.SQLite.Instances Methods fromRow :: RowParser SymbolId #
ToRow SymbolId Source #
Instance details Defined in HsDev.Database.SQLite.Instances Methods toRow :: SymbolId -> [SQLData] #
Sourced SymbolId Source #
Instance details Defined in HsDev.Symbols.Class Methods sourcedName :: Lens' SymbolId Text Source # sourcedDocs :: Traversal' SymbolId Text Source # sourcedModule :: Lens' SymbolId ModuleId Source # sourcedLocation :: Traversal' SymbolId Position Source #
Documented SymbolId Source #
Instance details Defined in HsDev.Symbols.Types Methods brief :: SymbolId -> Text Source # detailed :: SymbolId -> Text Source #

symbolName :: Lens' SymbolId Text Source #

symbolModule :: Lens' SymbolId ModuleId Source #

data Position Source #

Constructors

Position
Fields _positionLine :: Int _positionColumn :: Int

Instances

Instances details

Eq Position Source #
Instance details Defined in HsDev.Symbols.Location Methods (==) :: Position -> Position -> Bool # (/=) :: Position -> Position -> Bool #
Ord Position Source #
Instance details Defined in HsDev.Symbols.Location Methods compare :: Position -> Position -> Ordering # (<) :: Position -> Position -> Bool # (<=) :: Position -> Position -> Bool # (>) :: Position -> Position -> Bool # (>=) :: Position -> Position -> Bool # max :: Position -> Position -> Position # min :: Position -> Position -> Position #
Read Position Source #
Instance details Defined in HsDev.Symbols.Location Methods readsPrec :: Int -> ReadS Position # readList :: ReadS [Position] # readPrec :: ReadPrec Position # readListPrec :: ReadPrec [Position] #
Show Position Source #
Instance details Defined in HsDev.Symbols.Location Methods showsPrec :: Int -> Position -> ShowS # show :: Position -> String # showList :: [Position] -> ShowS #
NFData Position Source #
Instance details Defined in HsDev.Symbols.Location Methods rnf :: Position -> () #
ToJSON Position Source #
Instance details Defined in HsDev.Symbols.Location Methods toJSON :: Position -> Value # toEncoding :: Position -> Encoding # toJSONList :: [Position] -> Value # toEncodingList :: [Position] -> Encoding #
FromJSON Position Source #
Instance details Defined in HsDev.Symbols.Location Methods parseJSON :: Value -> Parser Position # parseJSONList :: Value -> Parser [Position] #
FromRow Position Source #
Instance details Defined in HsDev.Database.SQLite.Instances Methods fromRow :: RowParser Position #
ToRow Position Source #
Instance details Defined in HsDev.Database.SQLite.Instances Methods toRow :: Position -> [SQLData] #
RecalcTabs Position Source #
Instance details Defined in HsDev.Symbols.Location Methods recalcTabs :: Text -> Int -> Position -> Position Source # calcTabs :: Text -> Int -> Position -> Position Source #

data Region Source #

Constructors

Region
Fields _regionFrom :: Position _regionTo :: Position

Instances

Instances details

Eq Region Source #
Instance details Defined in HsDev.Symbols.Location Methods (==) :: Region -> Region -> Bool # (/=) :: Region -> Region -> Bool #
Ord Region Source #
Instance details Defined in HsDev.Symbols.Location Methods compare :: Region -> Region -> Ordering # (<) :: Region -> Region -> Bool # (<=) :: Region -> Region -> Bool # (>) :: Region -> Region -> Bool # (>=) :: Region -> Region -> Bool # max :: Region -> Region -> Region # min :: Region -> Region -> Region #
Read Region Source #
Instance details Defined in HsDev.Symbols.Location Methods readsPrec :: Int -> ReadS Region # readList :: ReadS [Region] # readPrec :: ReadPrec Region # readListPrec :: ReadPrec [Region] #
Show Region Source #
Instance details Defined in HsDev.Symbols.Location Methods showsPrec :: Int -> Region -> ShowS # show :: Region -> String # showList :: [Region] -> ShowS #
NFData Region Source #
Instance details Defined in HsDev.Symbols.Location Methods rnf :: Region -> () #
ToJSON Region Source #
Instance details Defined in HsDev.Symbols.Location Methods toJSON :: Region -> Value # toEncoding :: Region -> Encoding # toJSONList :: [Region] -> Value # toEncodingList :: [Region] -> Encoding #
FromJSON Region Source #
Instance details Defined in HsDev.Symbols.Location Methods parseJSON :: Value -> Parser Region # parseJSONList :: Value -> Parser [Region] #
FromRow Region Source #
Instance details Defined in HsDev.Database.SQLite.Instances Methods fromRow :: RowParser Region #
ToRow Region Source #
Instance details Defined in HsDev.Database.SQLite.Instances Methods toRow :: Region -> [SQLData] #
RecalcTabs Region Source #
Instance details Defined in HsDev.Symbols.Location Methods recalcTabs :: Text -> Int -> Region -> Region Source # calcTabs :: Text -> Int -> Region -> Region Source #

region :: Position -> Position -> Region Source #

regionAt :: Position -> Region Source #

regionLines :: Region -> Int Source #

regionStr :: Region -> Text -> Text Source #

Get string at region

data Location Source #

Location of symbol

Constructors

Location
Fields _locationModule :: ModuleLocation _locationPosition :: Maybe Position

Instances

Instances details

Eq Location Source #
Instance details Defined in HsDev.Symbols.Location Methods (==) :: Location -> Location -> Bool # (/=) :: Location -> Location -> Bool #
Ord Location Source #
Instance details Defined in HsDev.Symbols.Location Methods compare :: Location -> Location -> Ordering # (<) :: Location -> Location -> Bool # (<=) :: Location -> Location -> Bool # (>) :: Location -> Location -> Bool # (>=) :: Location -> Location -> Bool # max :: Location -> Location -> Location # min :: Location -> Location -> Location #
Show Location Source #
Instance details Defined in HsDev.Symbols.Location Methods showsPrec :: Int -> Location -> ShowS # show :: Location -> String # showList :: [Location] -> ShowS #
NFData Location Source #
Instance details Defined in HsDev.Symbols.Location Methods rnf :: Location -> () #
ToJSON Location Source #
Instance details Defined in HsDev.Symbols.Location Methods toJSON :: Location -> Value # toEncoding :: Location -> Encoding # toJSONList :: [Location] -> Value # toEncodingList :: [Location] -> Encoding #
FromJSON Location Source #
Instance details Defined in HsDev.Symbols.Location Methods parseJSON :: Value -> Parser Location # parseJSONList :: Value -> Parser [Location] #

packageName :: Lens' ModulePackage Text Source #

packageVersion :: Lens' ModulePackage Text Source #

package :: Lens' PackageConfig ModulePackage Source #

packageModules :: Lens' PackageConfig [Text] Source #

packageExposed :: Lens' PackageConfig Bool Source #

moduleFile :: Traversal' ModuleLocation Path Source #

moduleProject :: Traversal' ModuleLocation (Maybe Project) Source #

moduleInstallDirs :: Traversal' ModuleLocation [Path] Source #

modulePackage :: Traversal' ModuleLocation ModulePackage Source #

installedModuleName :: Traversal' ModuleLocation Text Source #

installedModuleExposed :: Traversal' ModuleLocation Bool Source #

otherLocationName :: Traversal' ModuleLocation Text Source #

positionLine :: Lens' Position Int Source #

positionColumn :: Lens' Position Int Source #

regionFrom :: Lens' Region Position Source #

regionTo :: Lens' Region Position Source #

locationModule :: Lens' Location ModuleLocation Source #

locationPosition :: Lens' Location (Maybe Position) Source #

sourceModuleRoot :: Text -> Path -> Path Source #

Get source module root directory, i.e. for "...srcFooBar.hs" with module Bar will return "...src"

importPath :: Text -> Path Source #

Path to module source >importPath Quux.Blah = "Quux/Blah.hs"

sourceRoot :: ModuleId -> Maybe Path Source #

Root of sources, package dir or root directory of standalone modules

sourceRoot_ :: ModuleId -> Path Source #

class RecalcTabs a where Source #

Recalc positions to interpret 't' as one symbol instead of N

Methods

recalcTabs :: Text -> Int -> a -> a Source #

Interpret 't' as one symbol instead of N

calcTabs :: Text -> Int -> a -> a Source #

Inverse of recalcTabs: interpret 't' as N symbols instead of 1

Instances

Instances details

RecalcTabs Position Source #
Instance details Defined in HsDev.Symbols.Location Methods recalcTabs :: Text -> Int -> Position -> Position Source # calcTabs :: Text -> Int -> Position -> Position Source #
RecalcTabs Region Source #
Instance details Defined in HsDev.Symbols.Location Methods recalcTabs :: Text -> Int -> Region -> Region Source # calcTabs :: Text -> Int -> Region -> Region Source #
RecalcTabs (Note a) Source #
Instance details Defined in HsDev.Tools.Types Methods recalcTabs :: Text -> Int -> Note a -> Note a Source # calcTabs :: Text -> Int -> Note a -> Note a Source #

module HsDev.PackageDb.Types