package ppx_compare

You can search for identifiers within the package.

in-package search v0.2.0

ppx_compare.expander
- Ppx_compare_expander
  - Compare
    
    Attrs
  - Equal
    
    Attrs
  - S
    
    Attrs
ppx_compare.runtime-lib
- Ppx_compare_lib

Legend:
Library
Module
Module type
Parameter
Class
Class type

val type_ : 
  with_local:bool ->
  hide:bool ->
  loc:Ppxlib.Location.t ->
  Ppxlib.core_type ->
  Ppxlib.core_type

type_ ~with_local ~hide ty is ty -> ty -> result_type where result_type is int for compare and bool for equal.

hide controls whether some [@merlin.hide] attributes should be added.

with_local adds local_ annotation around the input types.

val core_type : with_local:bool -> Ppxlib.core_type -> Ppxlib.expression

core_type ~with_local ty is an expression of type ty -> ty -> result_type

~with_local:true will make the arguments local

In str_type_decl and sig_type_decl, passing true for the third argument generates additional functions that take local arguments. We generate, e.g. val compare__local : local_ t -> local_ t -> int in addition to compare in order to incrementally grow the portion of the tree which supports local comparison.

We need both compare and compare__local since neither has a stronger type than the other. In the case of polymorphic types, this is due to the fact that compare__local requires local compare functions for each of its type arguments, and in the case of monomorphic types, this is due to the possibility of partial application producing a local closure.

val str_type_decl : 
  ctxt:Ppxlib.Expansion_context.Deriver.t ->
  (Ppxlib.rec_flag * Ppxlib.type_declaration list) ->
  bool ->
  Ppxlib.structure

val sig_type_decl : 
  ctxt:Ppxlib.Expansion_context.Deriver.t ->
  (Ppxlib.rec_flag * Ppxlib.type_declaration list) ->
  bool ->
  Ppxlib.signature

module Attrs : sig ... end

val str_attributes : Ppxlib.Attribute.packed list