Skip to content
This repository
tag: v646
Fetching contributors…

Cannot retrieve contributors at this time

file 88 lines (73 sloc) 2.046 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
(*
Copyright © 2011 MLstate

This file is part of OPA.

OPA is free software: you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License, version 3, as published by
the Free Software Foundation.

OPA 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 Affero General Public License for
more details.

You should have received a copy of the GNU Affero General Public License
along with OPA. If not, see <http://www.gnu.org/licenses/>.
*)
(**
Convention of naming for plugins.
@author Mathieu Barbin
*)

(**
These convention are shared knowledge between opa-plugin-* (bsl{register,browser}) and the OPA compiler,
for simplifying plugin inclusion.
*)

module Extension :
sig
  (**
Extensions produced for plugins.
*)

  type extension = string
  val bypass : extension
  val jsconf : extension
  val plugin : extension
end

module Suffix :
sig
  (**
Given the name of the lib and adding these suffix, gives the name of the corresponding file,
<!> without the extension.
*)

  type suffix = string
  val jskeys : suffix
  val loader : suffix
  val marshalplugin : suffix
  val mlruntime : suffix
  val plugin : suffix
end

(**
Convention over plugin names
*)
val plugin_name : string -> string

(** {6 Inclusions} *)

(**
Regrouping implied options by the inclusion of a plugin
*)
type inclusion = {
  extrapath : string ;
  (**
An absolute path name to a directory to include
*)

  extralib : string ;
  (**
An absolute filename to the mlruntime to link with
*)

  plugin : string ;
  (**
An absolute filename to the marshaled plugin to load
*)
}

(**
Given the location of an plugin directory (opp), return
the list of implied options.
If the location is relative, will prefix it by the current
working directory.
*)
val inclusion : cwd:string -> string -> inclusion
Something went wrong with that request. Please try again.