(*
 *  Modelicac
 *
 *  Copyright (C) 2005 - 2007 Imagine S.A.
 *  For more information or commercial use please contact us at www.amesim.com
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *)

(** This module provides the required interface an implementation needs to
conform to in order to create a new code generator. *)

module type CODEGENERATOR =
  sig
    val generate_code: string -> string -> string -> Optimization.model -> bool
      -> bool -> string option * string option -> unit
    (** [generate_code path filename fun_name model jac only_outputs
    init_filenames]
    generates the code that
    allows the numeric simulation of [model]. [path] is the path to the
    external
    functions referenced in [model]. [filename] is the name of the file where
    the code is generated. [fun_name] is the name of the entry point in the
    generated code. [jac] is a flag for which true value indicates that a
    symbolic jacobian is requested. [only_outputs] is set when only declared
    outputs have to be observed (this saves some useless computations when
    internal variables need not to be observed). [init_filenames] is the optional
    names of the XML initialization files (input data, output data) in case
    separate initialization is required
    on targets that support separate initialization of models. *)
  end

module type S =
  sig
    val sccs_id: string
    (** Description of the executable *)
    val version: string
    (** The version of the compiler instance. *)
    val run: unit -> unit
    (** [run ()] invokes the compiler's unique entry point. *)
  end

module Make:
  functor (G: CODEGENERATOR) ->
    sig
      val sccs_id: string
      val version: string
      val run: unit -> unit
    end