Documentation

A ModIface plus a ModDetails summarises everything we know about a compiled module. The ModIface is the stuff *before* linking, and can be written out to an interface file. The 'ModDetails is after linking and can be completely recovered from just the ModIface.

When we read an interface file, we also construct a ModIface from it, except that we explicitly make the mi_decls and a few other fields empty; as when reading we consolidate the declarations etc. into a number of indexed maps and environments in the ExternalPackageState.

See Note [Strictness in ModIface] to learn about why some fields are strict and others are not.

See Note [Private fields in ModIface] to learn why we don't export any of the fields.

Copy fields that aren't serialised to disk to the new ModIface_. This includes especially hashes that are usually stored in the interface file header and mi_top_env.

We need this function after calling shareIface, to make sure the ModIface_ doesn't lose any information. This function does not discard the in-memory byte array buffer mi_hi_bytes.

Add a source fingerprint to a ModIface_ without invalidating the byte array buffer mi_hi_bytes. This is a variant of set_mi_src_hash which does invalidate the buffer.

The mi_src_hash is computed outside of ModIface_ based on the ModSummary.

Given a PartialModIface, turn it into a ModIface by completing missing fields.

In-memory byte array representation of a ModIface.

See Note [Sharing of ModIface] for why we need this.

Extends a PartialModIface with information which is either: * Computed after codegen * Or computed just before writing the iface to disk. (Hashes) In order to fully instantiate it.

Selects a IfaceDecl representation. For fully instantiated interfaces we also maintain a fingerprint, which is used for recompilation checks.

The original names declared of a certain module that are exported

Records whether a module has orphans. An "orphan" is one of:

• An instance declaration in a module other than the definition module for one of the type constructors or classes in the instance head
• A rewrite rule in a module other than the one defining the function in the head of the rule

Does this module define family instances?

Old-style accessor for whether or not the ModIface came from an hs-boot file.

Lookups up a (possibly cached) fixity from a ModIface. If one cannot be found, defaultFixity is returned instead.

The semantic module for this interface; e.g., if it's a interface for a signature, if mi_module is p[A=A]:A, mi_semantic_module will be A.

The "precise" free holes, e.g., the signatures that this ModIface depends on.

Given a set of free holes, and a unit identifier, rename the free holes according to the instantiation of the unit identifier. For example, if we have A and B free, and our unit identity is p[A=C,B=impl:B], the renamed free holes are just C.

Constructs cache for the mi_hash_fn field of a ModIface