From 75ad9736f8e06fb6ad729ca288ebb56b101f770f Mon Sep 17 00:00:00 2001 From: Christophe Troestler Date: Mon, 29 Jan 2018 14:47:51 +0100 Subject: [PATCH] Move usexp in src/ as it diverged from parsexp --- bootstrap.ml | 2 +- doc/project-layout-specification.rst | 91 ++++++-- {vendor/usexp/src => src/usexp}/jbuild | 0 .../usexp}/parser_automaton_internal.ml | 0 .../usexp}/parser_automaton_internal.mli | 0 {vendor/usexp/src => src/usexp}/sexp_ast.ml | 0 {vendor/usexp/src => src/usexp}/table.ml | 0 {vendor/usexp/src => src/usexp}/table.mli | 0 {vendor/usexp/src => src/usexp}/usexp.ml | 0 {vendor/usexp/src => src/usexp}/usexp.mli | 0 vendor/usexp/LICENSE.md | 202 ------------------ 11 files changed, 72 insertions(+), 223 deletions(-) rename {vendor/usexp/src => src/usexp}/jbuild (100%) rename {vendor/usexp/src => src/usexp}/parser_automaton_internal.ml (100%) rename {vendor/usexp/src => src/usexp}/parser_automaton_internal.mli (100%) rename {vendor/usexp/src => src/usexp}/sexp_ast.ml (100%) rename {vendor/usexp/src => src/usexp}/table.ml (100%) rename {vendor/usexp/src => src/usexp}/table.mli (100%) rename {vendor/usexp/src => src/usexp}/usexp.ml (100%) rename {vendor/usexp/src => src/usexp}/usexp.mli (100%) delete mode 100644 vendor/usexp/LICENSE.md diff --git a/bootstrap.ml b/bootstrap.ml index 96060f42..46482c34 100644 --- a/bootstrap.ml +++ b/bootstrap.ml @@ -33,7 +33,7 @@ let dirs = ; "src/fiber" , Some "Fiber" ; "src/xdg" , Some "Xdg" ; "vendor/boot" , None - ; "vendor/usexp/src" , Some "Usexp" + ; "src/usexp" , Some "Usexp" ; "src" , None ] diff --git a/doc/project-layout-specification.rst b/doc/project-layout-specification.rst index 90378060..44305a30 100644 --- a/doc/project-layout-specification.rst +++ b/doc/project-layout-specification.rst @@ -26,30 +26,81 @@ Metadata format =============== Most configuration files read by Jbuilder are using the S-expression -syntax, which is very simple. Everything is either an atom or a list. -The exact specification of S-expressions is described in the -documentation of the `parsexp `__ -library. - -In a nutshell, the syntax is as follows: - -- atoms that do no contain special characters are simply written as - is. For instance: ``foo``, ``bar`` are valid atomic S-expressions - -- atoms containing special characters or spaces must be quoted using - the syntax ``"..."``: ``"foo bar\n"`` - -- lists are formed by surrounding a sequence of S-expressions separated - by spaces with parentheses: ``(a b (c d))`` - -- single-line comments are introduced with the ``;`` character and may - appear anywhere except in the middle of a quoted atom - -- block comment are enclosed by ``#|`` and ``|#`` and can be nested +syntax, which is very simple. It is described below. Note that the format is completely static. However you can do meta-programming on jbuilds files by writing them in :ref:`ocaml-syntax`. + +Lexical conventions of s-expressions +------------------------------------ + +Whitespace, which consists of space, newline, horizontal tab, and form +feed, is ignored unless within an OCaml-string, where it is treated +according to OCaml-conventions. The left parenthesis opens a new +list, the right one closes it. Lists can be empty. + +The double quote denotes the beginning and end of a string using +similar lexing conventions to the ones of OCaml (see the OCaml-manual +for details). Differences are: + +- octal escape sequences (``\o123``) are not supported; +- backslash that's not a part of any escape sequence is kept as it is + instead of resulting in parse error; +- a backslash followed by a space does not form an escape sequence, so + it’s interpreted as is, while it is interpreted as just a space by + OCaml. + +All characters other than double quotes, left- and right parentheses, +whitespace, carriage return, and comment-introducing characters or +sequences (see next paragraph) are considered part of a contiguous +string. + +Comments +-------- + +There are three kinds of comments: + +- line comments are introduced with ``;``, and end at the newline; +- sexp comments are introduced with ``#;``, and end at the end of the + following s-expression; +- block comments are introduced with ``#|`` and end with ``|#``. + These can be nested, and double-quotes within them must be balanced + and be lexically correct OCaml strings. + +Grammar of s-expressions +------------------------ + +S-expressions are either sequences of non-whitespace characters +(= atoms), doubly quoted strings or lists. The lists can recursively +contain further s-expressions or be empty, and must be balanced, +i.e. parentheses must match. + +Examples +-------- + +:: + + this_is_an_atom_123'&^%! ; this is a comment + "another atom in an OCaml-string \"string in a string\" \123" + + ; empty list follows below + () + + ; a more complex example + ( + ( + list in a list ; comment within a list + (list in a list in a list) + 42 is the answer to all questions + #; (this S-expression + (has been commented out) + ) + #| Block comments #| can be "nested" |# |# + ) + ) + + .. _opam-files: .opam files diff --git a/vendor/usexp/src/jbuild b/src/usexp/jbuild similarity index 100% rename from vendor/usexp/src/jbuild rename to src/usexp/jbuild diff --git a/vendor/usexp/src/parser_automaton_internal.ml b/src/usexp/parser_automaton_internal.ml similarity index 100% rename from vendor/usexp/src/parser_automaton_internal.ml rename to src/usexp/parser_automaton_internal.ml diff --git a/vendor/usexp/src/parser_automaton_internal.mli b/src/usexp/parser_automaton_internal.mli similarity index 100% rename from vendor/usexp/src/parser_automaton_internal.mli rename to src/usexp/parser_automaton_internal.mli diff --git a/vendor/usexp/src/sexp_ast.ml b/src/usexp/sexp_ast.ml similarity index 100% rename from vendor/usexp/src/sexp_ast.ml rename to src/usexp/sexp_ast.ml diff --git a/vendor/usexp/src/table.ml b/src/usexp/table.ml similarity index 100% rename from vendor/usexp/src/table.ml rename to src/usexp/table.ml diff --git a/vendor/usexp/src/table.mli b/src/usexp/table.mli similarity index 100% rename from vendor/usexp/src/table.mli rename to src/usexp/table.mli diff --git a/vendor/usexp/src/usexp.ml b/src/usexp/usexp.ml similarity index 100% rename from vendor/usexp/src/usexp.ml rename to src/usexp/usexp.ml diff --git a/vendor/usexp/src/usexp.mli b/src/usexp/usexp.mli similarity index 100% rename from vendor/usexp/src/usexp.mli rename to src/usexp/usexp.mli diff --git a/vendor/usexp/LICENSE.md b/vendor/usexp/LICENSE.md deleted file mode 100644 index d6456956..00000000 --- a/vendor/usexp/LICENSE.md +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License.