GHC.Hs.Utils

A simple case alternative with a single pattern, no binds, no guards; pre-typechecking

Make a prefix, non-strict function HsMatchContext

A useful function for building OpApps. The operator is always a variable, and we don't know the fixity yet.

Wrap in parens if hsExprNeedsParens appPrec says it needs them So f x becomes (f x), but 3 stays as 3.

NB: Only for LHsExpr Id.

Type ascription: (e :: ty)

Turn an IdOccP into an IdP, discarding the user-written RdrName.

Not infix, with place holders for coercion and free vars

Convenience function using mkFunBind. This is for generated bindings only, do not use for user-written code.

In Name-land, with empty bind_fvs

If any of the matches in the FunBind are infix, the FunBind is considered infix.

Return the SrcSpan encompassing the contents of any enclosed binds

Wildcard pattern - after parsing

Wildcard pattern - after renaming

The Big equivalents for the source tuple expressions

The Big equivalents for the source tuple patterns

Convert an LHsType to an LHsSigType.

Convert an LHsType to an LHsSigWcType.

Convert TypeSig to ClassOpSig. The former is what is parsed, but the latter is what we need in class/instance declarations

Should we treat this as an unlifted bind? This will be true for any bind that binds an unlifted variable, but we must be careful around AbsBinds. See Note [isUnliftedHsBind]. For usage information, see Note [Strict binds checks] is GHC.HsToCore.Binds.

Is a binding a strict variable or pattern bind (e.g. !x = ...)?

Same as collectHsBindsBinders, but works over a list of bindings

Collect Id binders only, or Ids + pattern synonyms, respectively

Collect both Ids and pattern-synonym binders

Used exclusively for the bindings of an instance decl which are all FunBinds

This class specifies how to collect variable identifiers from extension patterns in the given pass. Consumers of the GHC API that define their own passes should feel free to implement instances in order to make use of functions which depend on it.

In particular, Haddock already makes use of this, with an instance for its DocNameI pass so that it can reuse the code in GHC for collecting binders.

Indicate if evidence binders and type variable binders have to be collected.

This type enumerates the modes of collecting bound variables | evidence | type | term | ghc | | binders | variables | variables | pass | -------------------------------------------- CollNoDictBinders | no | no | yes | any | CollWithDictBinders | yes | no | yes | GhcTc | CollVarTyVarBinders | no | yes | yes | GhcRn |

See Note [Dictionary binders in ConPatOut]

A mapping from constructors to all of their fields.

See Note [Collecting record fields in data declarations].

Returns all the binding names of the decl. The first one is guaranteed to be the name of the decl. The first component represents all binding names except record fields; the second represents field occurrences. For record fields mentioned in multiple constructors, the SrcLoc will be from the first occurrence.

Each returned (Located name) has a SrcSpan for the whole declaration. See Note [SrcSpan for binders]

Collects record pattern-synonym selectors only; the pattern synonym names are collected by collectHsValBinders.

See Note [SrcSpan for binders]

the SrcLoc returned are for the whole declarations, not just the names

All binders corresponding to a single implicit record field pattern.

See Note [Collecting implicit binders].

Collect all record wild card binders in the given pattern.

These are all the variables bound in all (possibly nested) record wildcard patterns appearing inside the pattern.

See Note [Collecting implicit binders].