helm/software/components/hbugs/hbugs_messages.mli

   1 (*
   2  * Copyright (C) 2003:
   3  *    Stefano Zacchiroli <zack@cs.unibo.it>
   4  *    for the HELM Team http://helm.cs.unibo.it/
   5  *
   6  *  This file is part of HELM, an Hypertextual, Electronic
   7  *  Library of Mathematics, developed at the Computer Science
   8  *  Department, University of Bologna, Italy.
   9  *
  10  *  HELM is free software; you can redistribute it and/or
  11  *  modify it under the terms of the GNU General Public License
  12  *  as published by the Free Software Foundation; either version 2
  13  *  of the License, or (at your option) any later version.
  14  *
  15  *  HELM is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with HELM; if not, write to the Free Software
  22  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  23  *  MA  02111-1307, USA.
  24  *
  25  *  For details, see the HELM World-Wide-Web page,
  26  *  http://helm.cs.unibo.it/
  27  *)
  28
  29 open Hbugs_types;;
  30
  31 exception Parse_error of string * string  (* parsing subject, reason *)
  32 exception Unexpected_message of message;;
  33
  34 val msg_of_string: string -> message
  35 val string_of_msg: message -> string
  36
  37 val submit_req: url:string -> message -> message
  38   (** close outchan afterwards *)
  39 val respond_msg: message -> out_channel -> unit
  40   (** close outchan afterwards *)
  41   (* exception_name, exception_value, output_channel *)
  42 val respond_exc: string -> string -> out_channel -> unit
  43
  44 (* TODO the below functions are for debugging only and shouldn't be exposed *)
  45 val parse_state:
  46   ('a Pxp_document.node Pxp_document.extension as 'a) Pxp_document.node ->
  47     (string * string * int)
  48 val pp_state: (string * string * int) option -> string
  49