Ormolu.Fixity

Definitions for fixity analysis.

Documentation

data FixityDirection

Fixity direction.

Constructors

InfixL

InfixR

InfixN

Instances

FromJSON FixityDirection

Defined in Ormolu.Fixity.Internal

Methods

parseJSON :: Value -> Parser FixityDirection

parseJSONList :: Value -> Parser [FixityDirection]

ToJSON FixityDirection

Defined in Ormolu.Fixity.Internal

Methods

toJSON :: FixityDirection -> Value

toEncoding :: FixityDirection -> Encoding

toJSONList :: [FixityDirection] -> Value

toEncodingList :: [FixityDirection] -> Encoding

Show FixityDirection

Defined in Ormolu.Fixity.Internal

Methods

showsPrec :: Int -> FixityDirection -> ShowS

show :: FixityDirection -> String

showList :: [FixityDirection] -> ShowS

Eq FixityDirection

Defined in Ormolu.Fixity.Internal

Methods

(==) :: FixityDirection -> FixityDirection -> Bool

(/=) :: FixityDirection -> FixityDirection -> Bool

Ord FixityDirection

Defined in Ormolu.Fixity.Internal

Methods

compare :: FixityDirection -> FixityDirection -> Ordering

(<) :: FixityDirection -> FixityDirection -> Bool

(<=) :: FixityDirection -> FixityDirection -> Bool

(>) :: FixityDirection -> FixityDirection -> Bool

(>=) :: FixityDirection -> FixityDirection -> Bool

max :: FixityDirection -> FixityDirection -> FixityDirection

min :: FixityDirection -> FixityDirection -> FixityDirection

Lift FixityDirection

Defined in Ormolu.Fixity.Internal

Methods

lift :: Quote m => FixityDirection -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => FixityDirection -> Code m FixityDirection

data FixityInfo

Fixity information about an infix operator that takes the uncertainty that can arise from conflicting definitions into account.

Constructors

FixityInfo

Fields

• fiDirection :: Maybe FixityDirection

  Fixity direction if it is known

• fiMinPrecedence :: Int

  Minimum precedence level found in the (maybe conflicting) definitions for the operator (inclusive)

• fiMaxPrecedence :: Int

  Maximum precedence level found in the (maybe conflicting) definitions for the operator (inclusive)

Instances

FromJSON FixityInfo

Defined in Ormolu.Fixity.Internal

Methods

parseJSON :: Value -> Parser FixityInfo

parseJSONList :: Value -> Parser [FixityInfo]

ToJSON FixityInfo

Defined in Ormolu.Fixity.Internal

Methods

toJSON :: FixityInfo -> Value

toEncoding :: FixityInfo -> Encoding

toJSONList :: [FixityInfo] -> Value

toEncodingList :: [FixityInfo] -> Encoding

Semigroup FixityInfo

Gives the ability to merge two (maybe conflicting) definitions for an operator, keeping the higher level of compatible information from both.

Defined in Ormolu.Fixity.Internal

Methods

(<>) :: FixityInfo -> FixityInfo -> FixityInfo

sconcat :: NonEmpty FixityInfo -> FixityInfo

stimes :: Integral b => b -> FixityInfo -> FixityInfo

Show FixityInfo

Defined in Ormolu.Fixity.Internal

Methods

showsPrec :: Int -> FixityInfo -> ShowS

show :: FixityInfo -> String

showList :: [FixityInfo] -> ShowS

Eq FixityInfo

Defined in Ormolu.Fixity.Internal

Methods

(==) :: FixityInfo -> FixityInfo -> Bool

(/=) :: FixityInfo -> FixityInfo -> Bool

Ord FixityInfo

Defined in Ormolu.Fixity.Internal

Methods

compare :: FixityInfo -> FixityInfo -> Ordering

(<) :: FixityInfo -> FixityInfo -> Bool

(<=) :: FixityInfo -> FixityInfo -> Bool

(>) :: FixityInfo -> FixityInfo -> Bool

(>=) :: FixityInfo -> FixityInfo -> Bool

max :: FixityInfo -> FixityInfo -> FixityInfo

min :: FixityInfo -> FixityInfo -> FixityInfo

Lift FixityInfo

Defined in Ormolu.Fixity.Internal

Methods

lift :: Quote m => FixityInfo -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => FixityInfo -> Code m FixityInfo

type FixityMap = Map String FixityInfo

Map from the operator name to its FixityInfo.

data LazyFixityMap

A variant of FixityMap, represented as a lazy union of several FixityMaps.

Instances

Show LazyFixityMap

Defined in Ormolu.Fixity.Internal

Methods

showsPrec :: Int -> LazyFixityMap -> ShowS

show :: LazyFixityMap -> String

showList :: [LazyFixityMap] -> ShowS

lookupFixity :: String -> LazyFixityMap -> Maybe FixityInfo

Lookup a FixityInfo of an operator. This might have drastically different performance depending on whether this is an "unusal" operator.

data HackageInfo

The map of operators declared by each package and the popularity of each package, if available.

Constructors

HackageInfo

Fields

• (Map String FixityMap)

  Map from package name to a map from operator name to its fixity

• (Map String Int)

  Map from package name to its 30-days download count from Hackage

Instances

FromJSON HackageInfo

Defined in Ormolu.Fixity.Internal

Methods

parseJSON :: Value -> Parser HackageInfo

parseJSONList :: Value -> Parser [HackageInfo]

ToJSON HackageInfo

Defined in Ormolu.Fixity.Internal

Methods

toJSON :: HackageInfo -> Value

toEncoding :: HackageInfo -> Encoding

toJSONList :: [HackageInfo] -> Value

toEncodingList :: [HackageInfo] -> Encoding

Lift HackageInfo

Defined in Ormolu.Fixity.Internal

Methods

lift :: Quote m => HackageInfo -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => HackageInfo -> Code m HackageInfo

defaultStrategyThreshold :: Float

The default value for the popularity ratio threshold, after which a very popular definition from packageToOps will completely rule out conflicting definitions instead of being merged with them.

defaultFixityInfo :: FixityInfo

The lowest level of information we can have about an operator.

buildFixityMap

Arguments

:: Float

Popularity ratio threshold, after which a very popular package will completely rule out conflicting definitions coming from other packages instead of being merged with them

-> Set String

Explicitly known dependencies

-> LazyFixityMap

Resulting map

Build a fixity map using the given popularity threshold and a list of cabal dependencies. Dependencies from the list have higher priority than other packages.

buildFixityMap'

Arguments

:: Map String FixityMap

Map from package to fixity map for operators defined in this package

-> Map String Int

Map from package to popularity

-> Set String

Higher priority packages

-> Float

Popularity ratio threshold, after which a very popular package will completely rule out conflicting definitions coming from other packages instead of being merged with them

-> Set String

Explicitly known dependencies

-> LazyFixityMap

Resulting map

Build a fixity map using the given popularity threshold and a list of cabal dependencies. Dependencies from the list have higher priority than other packages. This specific version of the function allows the user to specify the package databases used to build the final fixity map.

bootPackages :: Set String

List of packages shipped with GHC, for which the download count from Hackage does not reflect their high popularity. See https://github.com/tweag/ormolu/pull/830#issuecomment-986609572. "base" is not is this list, because it is already whitelisted by buildFixityMap'.

packageToOps :: Map String FixityMap

packageToPopularity :: Map String Int