ligo/src/passes/01-parsing/reasonligo.mli

(** This file provides an interface to the ReasonLIGO parser. *)

open Trace
module CST = Cst.Cameligo

(** Open a ReasonLIGO filename given by string and convert into an
    abstract syntax tree. *)
val parse_file : string -> (CST.t , Errors.parser_error) result

(** Convert a given string into a ReasonLIGO abstract syntax tree *)
val parse_string : string -> (CST.t , Errors.parser_error) result

(** Parse a given string as a ReasonLIGO expression and return an
    expression CST.

    This is intended to be used for interactive interpreters, or other
    scenarios where you would want to parse a ReasonLIGO expression
    outside of a contract. *)
val parse_expression : string -> (CST.expr , Errors.parser_error) result

(** Preprocess a given ReasonLIGO file and preprocess it. *)
val preprocess : string -> (Buffer.t , Errors.parser_error) result

(** Pretty-print a given CameLIGO file (after parsing it). *)
val pretty_print : string -> (Buffer.t , Errors.parser_error) result