-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
60 changed files
with
407 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ocaml_protoc (ocaml-protoc.Ocaml_protoc)</title><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc v2.3.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">ocaml-protoc</a> » Ocaml_protoc</nav><header class="odoc-preamble"><h1>Module <code><span>Ocaml_protoc</span></code></h1></header><div class="odoc-content"></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ocaml_protoc (ocaml-protoc.Ocaml_protoc)</title><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">ocaml-protoc</a> » Ocaml_protoc</nav><header class="odoc-preamble"><h1>Module <code><span>Ocaml_protoc</span></code></h1></header><div class="odoc-content"></div></body></html> |
8 changes: 8 additions & 0 deletions
8
dev/ocaml-protoc/Ocaml_protoc_compiler_lib/Pb_codegen_all/index.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Pb_codegen_all (ocaml-protoc.Ocaml_protoc_compiler_lib.Pb_codegen_all)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">ocaml-protoc</a> » <a href="../index.html">Ocaml_protoc_compiler_lib</a> » Pb_codegen_all</nav><header class="odoc-preamble"><h1>Module <code><span>Ocaml_protoc_compiler_lib.Pb_codegen_all</span></code></h1><p>Generate all the code for a given OCaml module.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Ot"><a href="#module-Ot" class="anchor"></a><code><span><span class="keyword">module</span> Ot</span><span> = <a href="../Pb_codegen_ocaml_type/index.html">Pb_codegen_ocaml_type</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Plugin"><a href="#module-Plugin" class="anchor"></a><code><span><span class="keyword">module</span> Plugin</span><span> = <a href="../Pb_codegen_plugin/index.html">Pb_codegen_plugin</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-F"><a href="#module-F" class="anchor"></a><code><span><span class="keyword">module</span> F</span><span> = <a href="../Pb_codegen_formatting/index.html">Pb_codegen_formatting</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-ocaml_mod"><a href="#type-ocaml_mod" class="anchor"></a><code><span><span class="keyword">type</span> ocaml_mod</span><span> = </span><span>{</span></code><ol><li id="type-ocaml_mod.ml" class="def record field anchored"><a href="#type-ocaml_mod.ml" class="anchor"></a><code><span>ml : <a href="../Pb_codegen_formatting/index.html#type-scope">F.scope</a>;</span></code></li><li id="type-ocaml_mod.mli" class="def record field anchored"><a href="#type-ocaml_mod.mli" class="anchor"></a><code><span>mli : <a href="../Pb_codegen_formatting/index.html#type-scope">F.scope</a>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-codegen"><a href="#val-codegen" class="anchor"></a><code><span><span class="keyword">val</span> codegen : | ||
| <span><a href="../Pb_codegen_ocaml_type/index.html#type-proto">Ot.proto</a> <span class="arrow">-></span></span> | ||
| <span><span class="label">generate_make</span>:bool <span class="arrow">-></span></span> | ||
| <span><span class="label">proto_file_options</span>:<a href="../Pb_option/index.html#type-set">Pb_option.set</a> <span class="arrow">-></span></span> | ||
| <span><span class="label">proto_file_name</span>:string <span class="arrow">-></span></span> | ||
| <span><span><a href="../Pb_codegen_plugin/index.html#type-t">Plugin.t</a> list</span> <span class="arrow">-></span></span> | ||
| <a href="#type-ocaml_mod">ocaml_mod</a></span></code></div><div class="spec-doc"><p><code>codegen types</code> returns a full code listing for the <code>.ml</code> and the <code>.mli</code> files.</p></div></div></div></body></html> |
10 changes: 10 additions & 0 deletions
10
dev/ocaml-protoc/Ocaml_protoc_compiler_lib/Pb_codegen_backend/Internal/index.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Internal (ocaml-protoc.Ocaml_protoc_compiler_lib.Pb_codegen_backend.Internal)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">ocaml-protoc</a> » <a href="../../index.html">Ocaml_protoc_compiler_lib</a> » <a href="../index.html">Pb_codegen_backend</a> » Internal</nav><header class="odoc-preamble"><h1>Module <code><span>Pb_codegen_backend.Internal</span></code></h1><p>Internal helpers.</p><p>For now there are no guarantees of stability within this module. It's unlikely that the signatures will change, but the possibility is still there.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.4</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-is_mutable"><a href="#val-is_mutable" class="anchor"></a><code><span><span class="keyword">val</span> is_mutable : <span><span class="optlabel">?field_name</span>:string <span class="arrow">-></span></span> <span><a href="../../Pb_option/index.html#type-set">Pb_option.set</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-constructor_name"><a href="#val-constructor_name" class="anchor"></a><code><span><span class="keyword">val</span> constructor_name : <span>string <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_name"><a href="#val-module_name" class="anchor"></a><code><span><span class="keyword">val</span> module_name : <span>string <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-label_name_of_field_name"><a href="#val-label_name_of_field_name" class="anchor"></a><code><span><span class="keyword">val</span> label_name_of_field_name : <span>string <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-type_name"><a href="#val-type_name" class="anchor"></a><code><span><span class="keyword">val</span> type_name : <span><span>string list</span> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-variant_of_oneof"><a href="#val-variant_of_oneof" class="anchor"></a><code><span><span class="keyword">val</span> variant_of_oneof : | ||
| <span><span class="optlabel">?include_oneof_name</span>:unit <span class="arrow">-></span></span> | ||
| <span><span class="label">outer_message_names</span>:<span>string list</span> <span class="arrow">-></span></span> | ||
| <span><span class="label">unsigned_tag</span>:bool <span class="arrow">-></span></span> | ||
| <span><span class="label">all_types</span>:<span><span><span class="type-var">'a</span> <a href="../../Pb_typing_type_tree/index.html#type-proto_type">Tt.proto_type</a></span> list</span> <span class="arrow">-></span></span> | ||
| <span><a href="../../Pb_option/index.html#type-set">Pb_option.set</a> <span class="arrow">-></span></span> | ||
| <span>string <span class="arrow">-></span></span> | ||
| <span><span>int <a href="../../Pb_typing_type_tree/index.html#type-oneof">Tt.oneof</a></span> <span class="arrow">-></span></span> | ||
| <a href="../../Pb_codegen_ocaml_type/index.html#type-variant">Ot.variant</a></span></code></div></div></div></body></html> |
6 changes: 6 additions & 0 deletions
6
dev/ocaml-protoc/Ocaml_protoc_compiler_lib/Pb_codegen_backend/index.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Pb_codegen_backend (ocaml-protoc.Ocaml_protoc_compiler_lib.Pb_codegen_backend)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">ocaml-protoc</a> » <a href="../index.html">Ocaml_protoc_compiler_lib</a> » Pb_codegen_backend</nav><header class="odoc-preamble"><h1>Module <code><span>Ocaml_protoc_compiler_lib.Pb_codegen_backend</span></code></h1><p>Compile protobuf typed tree to the OCaml AST.</p><p>This module focuses on the compilation steps which transforms a fully resolved Protobuf message into an OCaml representation.</p><p>After compilation this module also expose code generation functionality.</p></header><nav class="odoc-toc"><ul><li><a href="#compilation">Compilation</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Tt"><a href="#module-Tt" class="anchor"></a><code><span><span class="keyword">module</span> Tt</span><span> = <a href="../Pb_typing_type_tree/index.html">Pb_typing_type_tree</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Ot"><a href="#module-Ot" class="anchor"></a><code><span><span class="keyword">module</span> Ot</span><span> = <a href="../Pb_codegen_ocaml_type/index.html">Pb_codegen_ocaml_type</a></span></code></div></div><h3 id="compilation"><a href="#compilation" class="anchor"></a>Compilation</h3><div class="odoc-spec"><div class="spec value anchored" id="val-compile"><a href="#val-compile" class="anchor"></a><code><span><span class="keyword">val</span> compile : | ||
| <span><span class="label">unsigned_tag</span>:bool <span class="arrow">-></span></span> | ||
| <span><span class="label">all_types</span>:<span><span><a href="../Pb_field_type/index.html#type-resolved">Pb_field_type.resolved</a> <a href="../Pb_typing_type_tree/index.html#type-proto_type">Tt.proto_type</a></span> list</span> <span class="arrow">-></span></span> | ||
| <span><span><a href="../Pb_field_type/index.html#type-resolved">Pb_field_type.resolved</a> <a href="../Pb_typing_type_tree/index.html#type-proto">Tt.proto</a></span> <span class="arrow">-></span></span> | ||
| <a href="../Pb_codegen_ocaml_type/index.html#type-proto">Ot.proto</a></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Internal"><a href="#module-Internal" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Internal/index.html">Internal</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Internal helpers.</p></div></div></div></body></html> |
2 changes: 2 additions & 0 deletions
2
dev/ocaml-protoc/Ocaml_protoc_compiler_lib/Pb_codegen_decode_binary/index.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Pb_codegen_decode_binary (ocaml-protoc.Ocaml_protoc_compiler_lib.Pb_codegen_decode_binary)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">ocaml-protoc</a> » <a href="../index.html">Ocaml_protoc_compiler_lib</a> » Pb_codegen_decode_binary</nav><header class="odoc-preamble"><h1>Module <code><span>Ocaml_protoc_compiler_lib.Pb_codegen_decode_binary</span></code></h1><p>Code generator for the <code>decode</code> function</p></header><div class="odoc-content"><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../Pb_codegen_plugin/module-type-S/index.html">Pb_codegen_plugin.S</a></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-gen_sig"><a href="#val-gen_sig" class="anchor"></a><code><span><span class="keyword">val</span> gen_sig : <a href="../Pb_codegen_plugin/index.html#type-codegen_f">Pb_codegen_plugin.codegen_f</a></span></code></div><div class="spec-doc"><p>Generate a signature file (.mli)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-gen_struct"><a href="#val-gen_struct" class="anchor"></a><code><span><span class="keyword">val</span> gen_struct : <a href="../Pb_codegen_plugin/index.html#type-codegen_f">Pb_codegen_plugin.codegen_f</a></span></code></div><div class="spec-doc"><p>Generate the implementation (.ml)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ocamldoc_title"><a href="#val-ocamldoc_title" class="anchor"></a><code><span><span class="keyword">val</span> ocamldoc_title : string</span></code></div><div class="spec-doc"><p>OCamldoc title</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-requires_mutable_records"><a href="#val-requires_mutable_records" class="anchor"></a><code><span><span class="keyword">val</span> requires_mutable_records : bool</span></code></div><div class="spec-doc"><p>Does this record depend on mutable records being defined?</p></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-plugin"><a href="#val-plugin" class="anchor"></a><code><span><span class="keyword">val</span> plugin : <a href="../Pb_codegen_plugin/index.html#type-t">Pb_codegen_plugin.t</a></span></code></div></div></div></body></html> |
2 changes: 2 additions & 0 deletions
2
dev/ocaml-protoc/Ocaml_protoc_compiler_lib/Pb_codegen_decode_bs/index.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Pb_codegen_decode_bs (ocaml-protoc.Ocaml_protoc_compiler_lib.Pb_codegen_decode_bs)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">ocaml-protoc</a> » <a href="../index.html">Ocaml_protoc_compiler_lib</a> » Pb_codegen_decode_bs</nav><header class="odoc-preamble"><h1>Module <code><span>Ocaml_protoc_compiler_lib.Pb_codegen_decode_bs</span></code></h1></header><div class="odoc-content"><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../Pb_codegen_plugin/module-type-S/index.html">Pb_codegen_plugin.S</a></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-gen_sig"><a href="#val-gen_sig" class="anchor"></a><code><span><span class="keyword">val</span> gen_sig : <a href="../Pb_codegen_plugin/index.html#type-codegen_f">Pb_codegen_plugin.codegen_f</a></span></code></div><div class="spec-doc"><p>Generate a signature file (.mli)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-gen_struct"><a href="#val-gen_struct" class="anchor"></a><code><span><span class="keyword">val</span> gen_struct : <a href="../Pb_codegen_plugin/index.html#type-codegen_f">Pb_codegen_plugin.codegen_f</a></span></code></div><div class="spec-doc"><p>Generate the implementation (.ml)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ocamldoc_title"><a href="#val-ocamldoc_title" class="anchor"></a><code><span><span class="keyword">val</span> ocamldoc_title : string</span></code></div><div class="spec-doc"><p>OCamldoc title</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-requires_mutable_records"><a href="#val-requires_mutable_records" class="anchor"></a><code><span><span class="keyword">val</span> requires_mutable_records : bool</span></code></div><div class="spec-doc"><p>Does this record depend on mutable records being defined?</p></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-plugin"><a href="#val-plugin" class="anchor"></a><code><span><span class="keyword">val</span> plugin : <a href="../Pb_codegen_plugin/index.html#type-t">Pb_codegen_plugin.t</a></span></code></div></div></div></body></html> |
Oops, something went wrong.