package GT

  1. Overview
  2. Docs
package GT
Legend:
Library
Module
Module type
Parameter
Class
Class type

Base class type for all plugins.

Is parametrized by output AST types for convenience. All plugins receive input data as OCaml AST and return pieces specific for backend.

Methods that are specific for a concrete plugin implementation

method virtual trait_name : string

Name of a trait (and of plugin too). It is used for constructing new classes and * functions related to plugin.

method virtual inh_of_main : loc:'loc -> Ppxlib.type_declaration -> 'typ

Inherited attribute for whole type declaration. Is is defined by plugin kind.

method virtual syn_of_main : loc:'loc -> ?in_class:bool -> Ppxlib.type_declaration -> 'typ

Synthesized attribute for whole type declaration. Is is defined by plugin kind.

method virtual syn_of_param : loc:'loc -> string -> 'typ

syn_of_param ~loc name constructs synthethized attribute for type paramter name.

method virtual inh_of_param : loc:'loc -> Ppxlib.type_declaration -> string -> 'typ

inh_of_param ~loc tdecl name constructs inherited attribute for type parameter name.

method virtual plugin_class_params : loc:'loc -> Ppxlib.core_type list -> typname:string -> 'typ list

The parameters that the plugin class will have in its definition. * Add 'extra manually if needed.

method virtual alias_inherit_type_params : loc:'loc -> Ppxlib.type_declaration -> Ppxlib.core_type list -> 'typ list

Arguments of inherit class field that will be generated using the types applied in the RHS of type definition.

method virtual extra_class_sig_members : Ppxlib.type_declaration -> 'ctf list

Adds a few extra members to a plugin class. Could be some constraints that are difficult to add in place where type parameters are declared.

method virtual extra_class_str_members : Ppxlib.type_declaration -> 'cf list

The same as extra_class_sig_members but for structures.

Methods that are specific for all plugins and unlikely will need to be override

method virtual do_single_sig : loc:'loc -> is_rec:bool -> Ppxlib.type_declaration -> 'sign list

Generate signature items for single type definition.

method virtual do_single : loc:'loc -> is_rec:bool -> Ppxlib.type_declaration -> 'str list

Generate structure items for single type definition.

method virtual do_typ_gen : loc:'loc -> mutual_decls:Ppxlib.type_declaration list -> is_self_rec:(Ppxlib.core_type -> [ `Nonrecursive | `Nonregular | `Regular ]) -> Ppxlib.type_declaration -> Ppxlib.core_type -> 'exp

Generate transformation expression from specified core_type.

method virtual make_trans_function_name : Ppxlib.type_declaration -> string

Generate name for transformation function.

method virtual make_trans_function_typ : loc:'loc -> Ppxlib.type_declaration -> 'typ

Generate type of a transformation function.

method virtual do_mutuals : loc:'loc -> is_rec:bool -> Ppxlib.type_declaration list -> 'str list

Generate structure items for mutally recursive type declarations.

method virtual do_mutuals_sigs : loc:'loc -> is_rec:bool -> 'sign list
method virtual need_inh_attr : bool
method virtual eta_and_exp : center:'exp -> Ppxlib.type_declaration -> 'exp
method virtual prepare_fa_args : 'a. loc:'loc -> (loc:'loc -> flg:Ppxlib.rec_flag -> pat:'pat -> expr:'exp -> 'a -> 'a) -> Ppxlib.type_declaration -> 'pat list * ('a -> 'a)
method virtual make_final_trans_function_typ : loc:'loc -> Ppxlib.type_declaration -> 'typ
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct