pax_global_header00006660000000000000000000000064144061525130014513gustar00rootroot0000000000000052 comment=303ab85afb67c7c22ea548b87241b08616b9f6f2 opam-file-format-2.1.6/000077500000000000000000000000001440615251300146605ustar00rootroot00000000000000opam-file-format-2.1.6/.gitattributes000066400000000000000000000001311440615251300175460ustar00rootroot00000000000000# Default behaviour, for if core.autocrlf isn't set * text=auto appveyor.sh text eol=lf opam-file-format-2.1.6/.gitignore000066400000000000000000000002771440615251300166560ustar00rootroot00000000000000*~ .#* \#*# *.cmo *.cmx *.cmi *.cmt *.cmti *.cma *.cmxa *.cmxs *.a *.lib *.o _build *.install .merlin *.obj src/.depend src/opamBaseParser.ml src/opamBaseParser.mli src/opamLexer.ml src/META opam-file-format-2.1.6/CHANGES000066400000000000000000000032271440615251300156570ustar00rootroot000000000000002.1.6 [20 March 2023] ------------------------ * Remove deprecated usage of `Printf.ksprintf`, ocaml 5 compatibility 2.1.5 [14 December 2022] ------------------------ * Fix extra lines on non empty headers [#49 @hhugo] * Make the tests flambda2-ready [#52 @lthls] * Fix build failure on OCaml 5.0 when using the non-dune build mode [#50 @dra27] 2.1.4 [12 April 2022] --------------------- * Fix position in the sections parser [#46 @hhugo] 2.1.3 [21 May 2021] ------------------- * Fix module link order (broken by #37) [#41 @dra27] * opam-version: "2.1" must appear at most once and as the first non-comment item. If opam-version is at the start and is greater than the library version, `OpamLexer.Error` and `Parsing.Parse_error` are no longer raised; instead the opam-version variable is returned along with an invalid group to signal the parsing error, giving the client enough information to act. [#43, #44, #45 @dra27] 2.1.2 [07 Jan 2021] ------------------- * Some hash-consing for strings [#27 @AltGr] * Fix named section position [#31 @rjbou] * Don't include build system Flags module in installation [#34 @dra27] * Allow compilation with Dune 1.x [#35 @kit-ty-kate] * Fix compilation of OpamParserTypes [#36 @dra27] 2.1.1 [17 Nov 2020] ------------------- * New types with more complete positions [#24 @rjbou] * Deprecation of all old functions [#24 @rjbou] * Add tests [#28 @rjbou] 2.1.0 [26 Aug 2020] ------------------- * Don't add a newline at the start of strings with newlines [#18 @dra27] * Report starting position of strings correctly [#19 @rjbou] * Add dune files [#13 @avsm @jonludlam @dra27] 2.0.0 [1 Aug 2018] ------------------ * Initial version opam-file-format-2.1.6/LICENSE000066400000000000000000000645251440615251300157010ustar00rootroot00000000000000All files are distributed under the terms of the GNU Lesser General Public License (LGPL) version 2.1 (included below). As a special exception to the GNU Lesser General Public License, you may link, statically or dynamically, a "work that uses opam" with a publicly distributed version of opam to produce an executable file containing portions of opam, and distribute that executable file under terms of your choice, without any of the additional requirements listed in clause 6 of the GNU Lesser General Public License. By "a publicly distributed version of opam", we mean either the unmodified opam as distributed by OCamlPro, or a modified version of the opam that is distributed under the conditions defined in clause 2 of the GNU Lesser General Public License. This exception does not however invalidate any other reasons why the executable file might be covered by the GNU Lesser General Public License. ---------------------------------------------------------------------- GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things. To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights. We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library. To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs. When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library. We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances. For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License. In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system. Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run. TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface-compatible with the version that the work was made with. c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 13. The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. one line to give the library's name and an idea of what it does. Copyright (C) year name of author This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library 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 Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. signature of Ty Coon, 1 April 1990 Ty Coon, President of Vice That's all there is to it! -------------------------------------------------- opam-file-format-2.1.6/Makefile000066400000000000000000000014151440615251300163210ustar00rootroot00000000000000TARGETS = opam-file-format.cma opam-file-format.cmxa opam-file-format.cmxs all: $(TARGETS) $(MAKE) -C src META byte: $(filter %.cma,$(TARGETS)) $(MAKE) -C src META native: $(filter %.cmxa,$(TARGETS)) $(MAKE) -C src META .PHONY: dune clean dune: dune build --profile=dev @all %: $(MAKE) -C src $@ tests: opam-file-format.cmxa $(MAKE) -C tests run PREFIX ?= /usr/local LIBDIR ?= $(PREFIX)/lib install: mkdir -p $(DESTDIR)$(LIBDIR)/opam-file-format install -m 0644 \ $(wildcard $(addprefix src/*.,cmi cmo cmx cmt cmti lib a cma cmxa cmxs)) \ src/META \ $(DESTDIR)$(LIBDIR)/opam-file-format/ uninstall: rm -f $(DESTDIR)$(LIBDIR)/opam-file-format/* rmdir $(DESTDIR)$(LIBDIR)/opam-file-format clean:: rm -rf _build $(MAKE) -C src $@ $(MAKE) -C tests $@ opam-file-format-2.1.6/README.md000066400000000000000000000014761440615251300161470ustar00rootroot00000000000000# opam-file-format - Parser and printer for the opam file syntax This library provides the parser and printer for the opam file syntax as a library with no dependencies. The package can be built either with GNU make or any version of [Dune](https://dune.build). Opam was created and is maintained by [OCamlPro](http://www.ocamlpro.com). ## Copyright and license Copyright 2012-2020 OCamlPro Copyright 2012 INRIA All rights reserved. Opam is distributed under the terms of the GNU Lesser General Public License version 2.1, with the special exception on linking described in the file LICENSE. Opam 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 Lesser General Public License for more details. opam-file-format-2.1.6/appveyor.cmd000066400000000000000000000076241440615251300172230ustar00rootroot00000000000000@rem *********************************************************************** @rem * * @rem * opam * @rem * * @rem * David Allsopp, OCaml Labs, Cambridge. * @rem * * @rem * Copyright 2018 MetaStack Solutions Ltd. * @rem * * @rem * All rights reserved. This file is distributed under the terms of * @rem * the GNU Lesser General Public License version 2.1, with the * @rem * special exception on linking described in the file LICENSE. * @rem * * @rem *********************************************************************** @rem BE CAREFUL ALTERING THIS FILE TO ENSURE THAT ERRORS PROPAGATE @rem IF A COMMAND SHOULD FAIL IT PROBABLY NEEDS TO END WITH @rem || exit /b 1 @rem BASICALLY, DO THE TESTING IN BASH... @rem Do not call setlocal! @echo off goto %1 goto :EOF :CheckPackage "%CYG_ROOT%\bin\bash.exe" -lc "cygcheck -dc %1" | findstr %1 > nul if %ERRORLEVEL% equ 1 ( echo Cygwin package %1 will be installed set CYGWIN_INSTALL_PACKAGES=%CYGWIN_INSTALL_PACKAGES%,%1 ) goto :EOF :UpgradeCygwin if "%CYGWIN_INSTALL_PACKAGES%" neq "" "%CYG_ROOT%\setup-%CYG_ARCH%.exe" --quiet-mode --no-shortcuts --no-startmenu --no-desktop --only-site --root "%CYG_ROOT%" --site "%CYG_MIRROR%" --local-package-dir "%CYG_CACHE%" --packages %CYGWIN_INSTALL_PACKAGES:~1% > nul for %%P in (%CYGWIN_COMMANDS%) do "%CYG_ROOT%\bin\bash.exe" -lc "%%P --help" > nul || set CYGWIN_UPGRADE_REQUIRED=1 "%CYG_ROOT%\bin\bash.exe" -lc "cygcheck -dc %CYGWIN_PACKAGES%" if %CYGWIN_UPGRADE_REQUIRED% equ 1 ( echo Cygwin package upgrade required - please go and drink coffee "%CYG_ROOT%\setup-%CYG_ARCH%.exe" --quiet-mode --no-shortcuts --no-startmenu --no-desktop --only-site --root "%CYG_ROOT%" --site "%CYG_MIRROR%" --local-package-dir "%CYG_CACHE%" --upgrade-also > nul "%CYG_ROOT%\bin\bash.exe" -lc "cygcheck -dc %CYGWIN_PACKAGES%" ) goto :EOF :install set CYG_ROOT=C:\%CYG_ROOT% cd "%APPVEYOR_BUILD_FOLDER%" rem CYGWIN_PACKAGES is the list of required Cygwin packages (cygwin is included rem in the list just so that the Cygwin version is always displayed on the log). rem CYGWIN_COMMANDS is a corresponding command to run with --version to test rem whether the package works. This is used to verify whether the installation rem needs upgrading. set CYGWIN_PACKAGES=cygwin make patch diffutils tar unzip set CYGWIN_COMMANDS=cygcheck make patch diff tar unzip if "%OCAML_PORT%" equ "mingw" ( set CYGWIN_PACKAGES=%CYGWIN_PACKAGES% mingw64-i686-gcc-core set CYGWIN_COMMANDS=%CYGWIN_COMMANDS% i686-w64-mingw32-core ) if "%OCAML_PORT%" equ "mingw64" ( set CYGWIN_PACKAGES=%CYGWIN_PACKAGES% mingw64-x86_64-gcc-core set CYGWIN_COMMANDS=%CYGWIN_COMMANDS% x86_64-w64-mingw32-core ) if "%OCAML_PORT:~0,6%" equ "cygwin" ( set CYGWIN_PACKAGES=%CYGWIN_PACKAGES% flexdll gcc-core set CYGWIN_COMMANDS=%CYGWIN_COMMANDS% flexlink gcc ) set CYGWIN_INSTALL_PACKAGES= set CYGWIN_UPGRADE_REQUIRED=0 for %%P in (%CYGWIN_PACKAGES%) do call :CheckPackage %%P call :UpgradeCygwin if "%OCAML_PORT%" equ "msvc64" call "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat" if "%OCAML_PORT%" equ "msvc" call "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars32.bat" "%CYG_ROOT%\bin\bash.exe" -lc "$APPVEYOR_BUILD_FOLDER/appveyor.sh install" || exit /b 1 set PATH=%OCAML_ROOT%\%OCAML_VERSION%\%OCAML_PORT%\bin;%PATH% goto :EOF :build "%CYG_ROOT%\bin\bash.exe" -lc "$APPVEYOR_BUILD_FOLDER/appveyor.sh build" || exit /b 1 goto :EOF :test goto :EOF opam-file-format-2.1.6/appveyor.sh000066400000000000000000000142071440615251300170650ustar00rootroot00000000000000#!/bin/bash TERM=st # Increment whenever the OCaml version or a package is updated to invalidate the caches SERIAL=1 ROOT_CYG=$(echo $OCAML_ROOT| cygpath -f -) APPVEYOR_BUILD_FOLDER=$(echo $APPVEYOR_BUILD_FOLDER| cygpath -f -) ERRORS_ALLOWED=0 function quietly_log { if ! script --quiet --return --append --command "$1" $LOG_FILE > /dev/null 2>&1 ; then sed -e 's/\d027\[K//g' \ -e 's/\d027\[m/\d027[0m/g' \ -e 's/\d027\[01\([m;]\)/\d027[1\1/g' $LOG_FILE if ((ERRORS_ALLOWED)) ; then return 1 else exit 1 fi fi } function msvs_promote_path { if [[ ${1%64} = "msvc" ]] ; then eval $($ROOT_CYG/msvs-promote-path) fi } case "$1" in install) # @@DRA TODO This should be converted OCAML_ROOT to a regexp, not having C:\\\\OCaml hard coded! if ! cat $APPVEYOR_BUILD_FOLDER/appveyor.yml | tr -d '\015' | sed -e '1,/^cache:/d' -e '/^$/,$d' | grep -q "^ \+- \+C:\\\\OCaml$" ; then echo "$(tput setf 4)ERROR$(tput sgr0) C:\\OCaml doesn't appear to be cached in appveyor.yml" exit 1 fi if [[ ! -e $ROOT_CYG/$OCAML_VERSION/$OCAML_PORT/bin/ocamlopt.exe || ! -e $ROOT_CYG/$OCAML_VERSION/version || $(cat $ROOT_CYG/$OCAML_VERSION/version) != "$OCAML_VERSION-$SERIAL" ]] ; then if [[ -e $ROOT_CYG/$OCAML_VERSION/version && $(cat $ROOT_CYG/$OCAML_VERSION/version) != "$OCAML_VERSION-$SERIAL" ]] ; then echo "Build cache for $OCAML_VERSION has serial $(cat $ROOT_CYG/$OCAML_VERSION/version); should be $OCAML_VERSION-$SERIAL -- clearing" rm -rf $ROOT_CYG/$OCAML_VERSION elif [[ ! -e $ROOT_CYG/$OCAML_VERSION/version ]] ; then rm -rf $ROOT_CYG/$OCAML_VERSION fi PREFIX=$ROOT_CYG/$OCAML_VERSION/$OCAML_PORT ROOT=$(echo $OCAML_ROOT| cygpath -m -f -)/$OCAML_VERSION/$OCAML_PORT OCAML_BRANCH=${OCAML_VERSION%.*} OCAML_BRANCH=${OCAML_BRANCH/.} if [[ ! -d $APPVEYOR_BUILD_FOLDER/../src ]] ; then mkdir -p $APPVEYOR_BUILD_FOLDER/../src cd $APPVEYOR_BUILD_FOLDER/../src git clone https://github.com/ocaml/ocaml.git cd ocaml mkdir -p $PREFIX cp tools/msvs-promote-path $ROOT_CYG/ cd .. FLEXDLL_VER=0.37 appveyor DownloadFile "https://github.com/alainfrisch/flexdll/releases/download/$FLEXDLL_VER/flexdll-bin-$FLEXDLL_VER.zip" -FileName flexdll-bin-$FLEXDLL_VER.zip [[ -e $PREFIX/../version ]] || echo $OCAML_VERSION-$SERIAL> $PREFIX/../version fi cd $APPVEYOR_BUILD_FOLDER/../src/ocaml git checkout $OCAML_VERSION git worktree add ../$OCAML_VERSION/$OCAML_PORT/ocaml -b build-$OCAML_VERSION-$OCAML_PORT if [[ $OCAML_BRANCH -ge 403 ]] ; then pushd ../$OCAML_VERSION/$OCAML_PORT/ocaml > /dev/null git submodule update --init popd > /dev/null fi cd ../$OCAML_VERSION/$OCAML_PORT/ocaml if [[ ${OCAML_PORT%64} = "cygwin" ]] ; then if [[ $OCAML_BRANCH -gt 406 ]] ; then NO_ALT_RUNTIMES="-no-instrumented-runtime -no-debug-runtime" else NO_ALT_RUNTIMES= fi PRE_WORLD= POST_WORLD= MAKEFILE= ./configure -prefix $PREFIX -no-ocamldoc -no-debugger $NO_ALT_RUNTIMES else if [[ $OCAML_BRANCH -ge 406 ]] ; then cp config/s-nt.h byterun/caml/s.h cp config/m-nt.h byterun/caml/m.h else cp config/s-nt.h config/s.h cp config/m-nt.h config/m.h fi if [[ $OCAML_BRANCH -ge 405 ]] ; then POST_WORLD=flexlink.opt MAKEFILE= else POST_WORLD= MAKEFILE=-f Makefile.nt fi if [[ $OCAML_BRANCH -lt 403 ]] ; then mkdir -p $PREFIX/bin pushd $PREFIX/bin > /dev/null case $OCAML_PORT in msvc) MANIFEST=default.manifest;; msvc64) MANIFEST=default_amd64.manifest;; *) MANIFEST=;; esac unzip $APPVEYOR_BUILD_FOLDER/../src/flexdll-bin-$FLEXDLL_VER.zip flexdll_*$OCAML_PORT.* flexdll.h flexlink.exe $MANIFEST popd > /dev/null PRE_WORLD= else PRE_WORLD=flexdll fi sed -e "s|PREFIX=[^\r]*|PREFIX=$ROOT|" config/Makefile.$OCAML_PORT > config/Makefile msvs_promote_path $OCAML_PORT fi LOG_FILE=OCaml-$OCAML_VERSION-$OCAML_PORT.log echo "Building OCaml $OCAML_VERSION for $OCAML_PORT" | tee $LOG_FILE echo "Please see $LOG_FILE for further information" LOG_FILE="$APPVEYOR_BUILD_FOLDER/$LOG_FILE" quietly_log "make $MAKEFILE $PRE_WORLD world.opt $POST_WORLD install" # Remove unnecessary executables to keep the build cache size down # These are removed here to ensure findlib doesn't configure itself # to use .opt commands if [[ $OCAML_BRANCH -ge 404 ]] ; then if [[ ${OCAML_PORT%64} != "cygwin" ]] ; then rm $PREFIX/bin/*.opt.exe fi rm $PREFIX/bin/*.byte.exe else for i in $PREFIX/bin/*.opt.exe ; do rm ${i%.opt.exe}.exe mv $i ${i%.opt.exe}.exe done fi # Remove unnecessary commands to keep the build cache size down rm -f $PREFIX/bin/{ocamlcp,ocamldebug,ocamldoc,ocamlmktop,ocamlobjinfo,ocamloptp,ocamlprof}.exe \ $PREFIX/lib/{expunge,extract_crc,objinfo_helper}.exe # Remove unnecessary files if [[ $OCAML_BRANCH -lt 405 && $OCAML_BRANCH -gt 402 ]] ; then rm $PREFIX/*.txt fi find $PREFIX -name \*.cmt\* | xargs rm find $PREFIX -name \*.ml\* | xargs rm rm -f $PREFIX/lib/compiler-libs/*.cmx* $PREFIX/lib/compiler-libs/*.{lib,a} $PREFIX/lib/compiler-libs/ocamloptcomp.cma echo "Complete" appveyor PushArtifact $(echo $LOG_FILE| cygpath -m -f -) fi ;; build) if [[ -z $2 ]] ; then set -o pipefail SCRIPT=$(echo "$0"| cygpath -f -) script -qec "\"$SCRIPT\" $1 script" | sed -e 's/\d027\[K//g' \ -e 's/\d027\[m/\d027[0m/g' \ -e 's/\d027\[01\([m;]\)/\d027[1\1/g' exit $? fi msvs_promote_path $OCAML_PORT make -C $APPVEYOR_BUILD_FOLDER all ;; esac opam-file-format-2.1.6/appveyor.yml000066400000000000000000000020411440615251300172450ustar00rootroot00000000000000platform: - x64 image: Visual Studio 2017 clone_depth: 1 environment: global: CYG_ROOT: cygwin64 CYG_ARCH: x86_64 OCAML_ROOT: C:\OCaml OCAML_VERSION: 4.06.1 CYG_CACHE: C:\cygwin\var\cache\setup CYG_MIRROR: http://mirrors.kernel.org/sourceware/cygwin/ matrix: - CYG_ROOT: cygwin CYG_ARCH: x86 OCAML_PORT: cygwin - CYG_ROOT: cygwin64 OCAML_PORT: cygwin64 - OCAML_PORT: msvc - OCAML_PORT: msvc64 - OCAML_PORT: mingw - OCAML_PORT: mingw64 cache: - C:\OCaml install: - call "%APPVEYOR_BUILD_FOLDER%\appveyor.cmd" install build_script: - call "%APPVEYOR_BUILD_FOLDER%\appveyor.cmd" build test_script: - call "%APPVEYOR_BUILD_FOLDER%\appveyor.cmd" test # Uncomment this to enable Remote Desktop on the build worker at the end of the # build. The worker is available for the remainder of the allocated hour. #on_finish: # - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1')) opam-file-format-2.1.6/dune-project000066400000000000000000000000201440615251300171720ustar00rootroot00000000000000(lang dune 1.3) opam-file-format-2.1.6/opam-file-format.opam000066400000000000000000000015031440615251300206740ustar00rootroot00000000000000opam-version: "2.0" version: "2.1.6" synopsis: "Parser and printer for the opam file syntax" maintainer: "Louis Gesbert " authors: "Louis Gesbert " homepage: "https://opam.ocaml.org" bug-reports: "https://github.com/ocaml/opam-file-format/issues" license: "LGPL-2.1-only WITH OCaml-LGPL-linking-exception" dev-repo: "git+https://github.com/ocaml/opam-file-format" build: [ [make "byte" {!ocaml:native} "all" {ocaml:native}] {!dune:installed} ["dune" "build" "-p" name "-j" jobs "@install" "@doc" {with-doc}] {dune:installed} ["dune" "runtest" "-p" name "-j" jobs] {with-test & dune:installed} ] install: [make "install" "PREFIX=%{prefix}%"] {!dune:installed} depends: [ "ocaml" {>= "3.09.0"} "alcotest" {with-test} ] depopts: [ "dune" ] conflicts: "dune" {< "1.3.0"} opam-file-format-2.1.6/src/000077500000000000000000000000001440615251300154475ustar00rootroot00000000000000opam-file-format-2.1.6/src/META.in000066400000000000000000000002371440615251300165270ustar00rootroot00000000000000version = VERSION description = "Parser and printer for the opam file syntax" archive(byte) = "opam-file-format.cma" archive(native) = "opam-file-format.cmxa" opam-file-format-2.1.6/src/Makefile000066400000000000000000000032421440615251300171100ustar00rootroot00000000000000all: opam-file-format.cmxa opam-file-format.cma %.ml: %.mll ocamllex $< EMPTY= SPACE=$(EMPTY) $(EMPTY) OCAML_VERSION:=$(firstword $(subst ~, ,$(subst +, ,$(shell ocamlc -version)))) ifeq ($(OCAML_VERSION),) OCAML_VERSION:=0 else OCAML_VERSION:=$(subst ., ,$(OCAML_VERSION)) OCAML_VERSION:=$(subst $(SPACE),,$(firstword $(OCAML_VERSION))$(foreach i,$(wordlist 2,$(words $(OCAML_VERSION)),$(OCAML_VERSION)),$(if $(filter 0 1 2 3 4 5 6 7 8 9,$(i)),0,)$(i))) endif ifeq ($(shell test $(OCAML_VERSION) -ge 40202 || echo no-attributes),) PP= else PP=-pp 'sed -e s/\\[@@\\?ocaml[^]]*\\]//' endif show: echo $(OCAML_VERSION) opamParserTypes.cmi: opamParserTypes.cmo %.ml %.mli: %.mly ocamlyacc $< %.cmi: %.mli ocamlc -c $(PP) $< %.cmo: %.ml ocamlc -c $(PP) $< %.cmx: %.ml ocamlopt -c $(PP) $< MODULES = opamParserTypes opamBaseParser opamLexer opamParser opamPrinter GENERATED = $(patsubst %.mly,%.ml,$(wildcard *.mly)) \ $(patsubst %.mly,%.mli,$(wildcard *.mly)) \ $(patsubst %.mll,%.ml,$(wildcard *.mll)) \ META opam-file-format.cma: $(addsuffix .cmo,$(MODULES)) ocamlc -a $^ -o $@ opam-file-format.cmxa: $(addsuffix .cmx,$(MODULES)) ocamlopt -a $^ -o $@ opam-file-format.cmxs: $(addsuffix .cmx,$(MODULES)) ocamlopt -shared $^ -o $@ META: META.in ../opam-file-format.opam $(wildcard *.cm*) sed -e 's/VERSION/$(shell sed -ne "s/^version: //p" ../opam-file-format.opam)/' \ $(if $(wildcard *.cmx*),,-e '/archive(native)/d') \ $(if $(wildcard *.cma),,-e '/archive(byte)/d') $< > $@ .PHONY: clean clean: rm -f *.cm* *.o *.a $(GENERATED) .depend .merlin .depend: *.ml *.mli $(GENERATED) ocamldep $(PP) *.mli *.ml > .depend -include .depend opam-file-format-2.1.6/src/dune000066400000000000000000000010201440615251300163160ustar00rootroot00000000000000(library (name opam_file_format) (public_name opam-file-format) (synopsis "Parser and printer for the opam file syntax") (wrapped false) (modules :standard \ flags) (flags :standard (:include flags.sexp))) (rule (with-stdout-to flags.ml (echo "print_string (if String.sub Sys.ocaml_version 0 5 = \"4.02.\" then \"(-w -50)\" else \"()\")"))) (rule (with-stdout-to flags.sexp (run ocaml %{dep:flags.ml}))) (ocamlyacc opamBaseParser) (ocamllex opamLexer) (env (dev (flags (:standard -warn-error -A)))) opam-file-format-2.1.6/src/opamBaseParser.mly000066400000000000000000000247251440615251300211100ustar00rootroot00000000000000/**************************************************************************/ /* */ /* Copyright 2012-2017 OCamlPro */ /* Copyright 2012 INRIA */ /* */ /* All rights reserved. This file is distributed under the terms of the */ /* GNU Lesser General Public License version 2.1, with the special */ /* exception on linking described in the file LICENSE. */ /* */ /**************************************************************************/ %{ open OpamParserTypes.FullPos (** Opam config file generic type parser *) let pos_of_lexing_pos spos epos = Lexing.({ filename = spos.pos_fname; start = spos.pos_lnum, spos.pos_cnum - spos.pos_bol; stop = epos.pos_lnum, epos.pos_cnum - epos.pos_bol; }) let get_pos_full ?(s=1) n = pos_of_lexing_pos (Parsing.rhs_start_pos s) (Parsing.rhs_end_pos n) let get_pos n = get_pos_full ~s:n n (* This must match up with the package's version; checked by the build system *) let version = (2, 1) %} %token STRING IDENT %token BOOL %token EOF %token LBRACKET RBRACKET %token LPAR RPAR %token LBRACE RBRACE %token COLON %token INT %token RELOP %token AND %token OR %token PFXOP %token ENVOP %left COLON %left ATOM %left OR %left AND %nonassoc ENVOP %nonassoc PFXOP %left LBRACE RBRACE %nonassoc RELOP %nonassoc URELOP %start main value %type OpamParserTypes.FullPos.opamfile> main %type value %type values %type item %% main: | items EOF { fun file_name -> { file_contents = $1; file_name } } ; items: | item items { $1 :: $2 } | { [] } ; item: | IDENT COLON value { { pos = get_pos_full 3; pelem = Variable ({ pos = get_pos 1; pelem = $1 }, $3); } } | IDENT LBRACE items RBRACE { { pos = get_pos_full 4; pelem = Section ({section_kind = { pos = get_pos 1; pelem = $1 }; section_name = None; section_items = { pos = get_pos_full ~s:2 4; pelem = $3 }; }) } } | IDENT STRING LBRACE items RBRACE { { pos = get_pos_full 5; pelem = Section ({section_kind = { pos = get_pos 1; pelem = $1 }; section_name = Some { pos = get_pos 2; pelem = $2 }; section_items = { pos = get_pos_full ~s:3 5; pelem = $4 }; }) } } ; value: | atom %prec ATOM { $1 } | LPAR values RPAR {{ pos = get_pos_full 3 ; pelem = Group { pos = get_pos_full ~s:1 3; pelem = $2 } }} | LBRACKET values RBRACKET {{ pos = get_pos_full 3 ; pelem = List { pos = get_pos_full ~s:1 3; pelem = $2 } }} | value LBRACE values RBRACE {{ pos = get_pos_full 4 ; pelem = Option ($1, { pos = get_pos_full ~s:2 4; pelem = $3 }) }} | value AND value {{ pos = get_pos_full 3 ; pelem = Logop ({ pos = get_pos 2 ; pelem = `And },$1,$3) }} | value OR value {{ pos = get_pos_full 3 ; pelem = Logop ({ pos = get_pos 2 ; pelem = `Or },$1,$3) }} | atom RELOP atom {{ pos = get_pos_full 3 ; pelem = Relop ({ pos = get_pos 2 ; pelem = $2 },$1,$3) }} | atom ENVOP atom {{ pos = get_pos_full 3 ; pelem = Env_binding ($1,{ pos = get_pos 2 ; pelem = $2 },$3) }} | PFXOP value {{ pos = get_pos_full 2 ; pelem = Pfxop ({ pos = get_pos 1 ; pelem = $1 },$2) }} | RELOP atom {{ pos = get_pos_full 2 ; pelem = Prefix_relop ({ pos = get_pos 1 ; pelem = $1 },$2) }} ; values: | { [] } | value values { $1 :: $2 } ; atom: | IDENT {{ pos = get_pos 1 ; pelem = Ident $1 }} | BOOL {{ pos = get_pos 1 ; pelem = Bool $1 }} | INT {{ pos = get_pos 1 ; pelem = Int $1 }} | STRING {{ pos = get_pos 1 ; pelem = String $1 }} ; %% let nopatch v = let s = try let i = String.index v '.' in let i = String.index_from v (i+1) '.' in (String.sub v 0 i) with Not_found -> let rec f i = if i >= String.length v then v else match String.get v i with | '0'..'9' | '.' -> f (i+1) | _ -> String.sub v 0 i in f 0 in try Scanf.sscanf s "%u.%u%!" (fun maj min -> (maj, min)) with Scanf.Scan_failure _ | Failure _ | End_of_file -> try Scanf.sscanf s "%u%!" (fun maj -> (maj, 0)) with Scanf.Scan_failure _ | Failure _ | End_of_file -> (0, 0) let with_clear_parser f x = try let r = f x in Parsing.clear_parser (); r with e -> Parsing.clear_parser (); raise e (* Update a lexbuf with position information prior to raising an exception *) let reset_lexbuf_and_abort l file_name (start_line, start_col) (end_line, end_col) exn = let open Lexing in l.lex_start_p <- {pos_fname = file_name; pos_lnum = start_line; pos_bol = 0; pos_cnum = start_col}; l.lex_curr_p <- {pos_fname = file_name; pos_lnum = end_line; pos_bol = 0; pos_cnum = end_col}; exn () (* cf. OpamStd.fatal - always allow standard exceptions to propagate. *) let not_fatal = function | Sys.Break | Assert_failure _ | Match_failure _ -> false | _ -> true let get_three_tokens lexer lexbuf = let open Lexing in try let p0 = lexbuf.lex_start_p, lexbuf.lex_curr_p in let t1 = lexer lexbuf in let p1 = lexbuf.lex_start_p, lexbuf.lex_curr_p in let t2 = lexer lexbuf in let p2 = lexbuf.lex_start_p, lexbuf.lex_curr_p in let t3 = lexer lexbuf in let p3 = lexbuf.lex_start_p, lexbuf.lex_curr_p in ((p0, p1, p2, p3), (t1, t2, t3)) with | e when not_fatal e -> raise Parsing.Parse_error (* Wrap the ocamlyacc parser *) let main lexer lexbuf file_name = (* Extract the exceptions for opam-version not at the top of the file and opam-version duplicated. OpamLexer has special cases for these two constants. If OpamLexer.token isn't used, raise Parse_error instead. *) let exn_not_first () = let _ = lexer (Lexing.from_string "version: \"42\"\nopam-version: \"2.1\"") in raise Parsing.Parse_error and exn_duplicate () = let _ = lexer (Lexing.from_string "opam-version: \"2.1\"\nopam-version: \"z\"") in raise Parsing.Parse_error and restore_pos (start, curr) = let open Lexing in lexbuf.lex_start_p <- start; lexbuf.lex_curr_p <- curr in (* Raises the exn_not_first or exn_duplicate exceptions if an invalid opam-version variable is found in the result. *) let scan_opam_version_variable format_2_1_or_greater = function | {pelem = Variable({pelem = "opam-version"; _}, {pelem = String ver; _}); pos = {start; stop; _}} -> if format_2_1_or_greater then (* [opam-version] can only appear once for 2.1+ *) reset_lexbuf_and_abort lexbuf file_name start stop exn_duplicate else if nopatch ver > (2, 0) then (* Only [opam-version: "2.0"] can appear after the first non-comment/whitespace line of the file *) reset_lexbuf_and_abort lexbuf file_name start stop exn_not_first else () | _ -> () in (* Now parse the header of the file manually. The smallest valid opam file is `ident: atom`, so if we can't read three tokens we have a parse error *) let ((((_, p0) as initial_pos), ((_, p1) as pos1), ((_, p2) as pos2), ((_, p3) as pos3)), (t1, t2, t3)) = get_three_tokens lexer lexbuf in (* Parse those three tokens if they are [opam-version: ver] *) let (header, format_2_1_or_greater, trap_exceptions) = match (t1, t2, t3) with | (IDENT "opam-version", COLON, STRING ver) -> let header = (* Parsing or lexing errors immediate following opam-version may cause an exception to be raised before the element has been fully parsed. In this case, we generate a single opam-version Variable to return. *) {pelem = Variable({pelem = "opam-version"; pos = pos_of_lexing_pos p0 p1}, {pelem = String ver; pos = pos_of_lexing_pos p2 p3}); pos = pos_of_lexing_pos p0 p3} in (header, (nopatch ver >= (2, 1)), (nopatch ver > version)) | _ -> (* Default is [opam-version: "2.0"] *) let pos = {filename = ""; start = (0, 0); stop = (0, 0)} in ({pelem = Variable ({pelem = ""; pos}, {pelem = Int 42; pos}); pos}, false, false) in (* The parser will use position information from the lexbuf, so replay the positions, even if we're not actually reading anything. *) restore_pos initial_pos; (* Wrap the lexer to simulate reading those three tokens a second time *) let lexer = let tokens = ref [t1, pos1; t2, pos2; t3, pos3] in fun lexbuf -> match tokens with | {contents = (t, p)::rest} -> tokens := rest; restore_pos p; t | {contents = []} -> lexer lexbuf in let result = try with_clear_parser (main lexer lexbuf) file_name with e when trap_exceptions && not_fatal e -> (* Append a syntactically invalid sentinel section "#" to the version header which was manually parsed. That is then sufficient information for a client to determine that the file was invalid. If OpamBaseParser.version = (2, 1), this would allow `opam-version: "2.2"`, containing no lexer or parser changes, still to report syntax errors in opam 2.2, by using this sentinel group to detect the parsing error. *) let sentinel = let pos = Lexing.(pos_of_lexing_pos lexbuf.lex_start_p lexbuf.lex_curr_p) in let section = {section_kind = {pelem = "#"; pos}; section_name = None; section_items = {pelem = []; pos}} in {pelem = Section section; pos} in {file_contents = [header; sentinel]; file_name} in begin match result with | {file_contents = _::items; _} -> (* Ensure that there are no `opam-version` fields with a value >= "2.1" further down the file. *) List.iter (scan_opam_version_variable format_2_1_or_greater) items | _ -> () end; result let value t l = with_clear_parser (value t) l opam-file-format-2.1.6/src/opamLexer.mli000066400000000000000000000035111440615251300201060ustar00rootroot00000000000000(**************************************************************************) (* *) (* Copyright 2012-2018 OCamlPro *) (* Copyright 2012 INRIA *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) (** opam format lexer *) open OpamParserTypes exception Error of string (** Raised on any lexing error with a description of the fault. Note that [Failure "lexing: empty token"] is never raised by the lexer. *) val token: Lexing.lexbuf -> OpamBaseParser.token (** [OpamLexer] transitional module with full position types *) module FullPos : sig open OpamParserTypes.FullPos val relop: string -> relop_kind (** Inverse of {!OpamPrinter.relop} *) val logop: string -> logop_kind (** Inverse of {!OpamPrinter.logop} *) val pfxop: string -> pfxop_kind (** Inverse of {!OpamPrinter.pfxop} *) val env_update_op: string -> env_update_op_kind (** Inverse of {!OpamPrinter.env_update_op} *) end val relop: string -> relop [@@ocaml.deprecated "Use OpamLexer.FullPos.relop instead."] val logop: string -> logop [@@ocaml.deprecated "Use OpamLexer.FullPos.logop instead."] val pfxop: string -> pfxop [@@ocaml.deprecated "Use OpamLexer.FullPos.pfxop instead."] val env_update_op: string -> env_update_op [@@ocaml.deprecated "Use OpamLexer.FullPos.env_update_op instead."] opam-file-format-2.1.6/src/opamLexer.mll000066400000000000000000000136261440615251300201210ustar00rootroot00000000000000(**************************************************************************) (* *) (* Copyright 2012-2019 OCamlPro *) (* Copyright 2012 INRIA *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) { open OpamParserTypes open OpamBaseParser exception Error of string let newline lexbuf = Lexing.new_line lexbuf let error fmt = Printf.ksprintf (fun msg -> raise (Error msg)) fmt let relop = function | "=" -> `Eq | "!=" -> `Neq | ">=" -> `Geq | ">" -> `Gt | "<=" -> `Leq | "<" -> `Lt | "~" -> `Geq | x -> error "%S is not a valid comparison operator" x let logop = function | "&" -> `And | "|" -> `Or | x -> error "%S is not a valid logical operator" x let pfxop = function | "!" -> `Not | "?" -> `Defined | x -> error "%S is not a valid prefix operator" x let env_update_op : string -> env_update_op = function | "=" -> Eq | "+=" -> PlusEq | "=+" -> EqPlus | "=+=" -> EqPlusEq | ":=" -> ColonEq | "=:" -> EqColon | x -> error "%S is not a valid environment update operator" x module FullPos = struct let relop = relop let logop = logop let pfxop = pfxop let env_update_op = env_update_op end let char_for_backslash = function | 'n' -> '\010' | 'r' -> '\013' | 'b' -> '\008' | 't' -> '\009' | c -> c let char_for_decimal_code lexbuf i = let c = 100 * (Char.code(Lexing.lexeme_char lexbuf i) - 48) + 10 * (Char.code(Lexing.lexeme_char lexbuf (i+1)) - 48) + (Char.code(Lexing.lexeme_char lexbuf (i+2)) - 48) in if (c < 0 || c > 255) then error "illegal escape sequence" ; Char.chr c let char_for_hexadecimal_code lexbuf i = let d1 = Char.code (Lexing.lexeme_char lexbuf i) in let val1 = if d1 >= 97 then d1 - 87 else if d1 >= 65 then d1 - 55 else d1 - 48 in let d2 = Char.code (Lexing.lexeme_char lexbuf (i+1)) in let val2 = if d2 >= 97 then d2 - 87 else if d2 >= 65 then d2 - 55 else d2 - 48 in Char.chr (val1 * 16 + val2) (* Some hash-consing for strings *) module HS = Weak.Make(struct include String let hash = Hashtbl.hash let equal = (=) end) let hm = HS.create 317 let buffer_rule r lb = let pos = lb.Lexing.lex_start_p in let b = Buffer.create 64 in r b lb ; (* buffer start position, instead of last lexem position *) lb.Lexing.lex_start_p <- pos; HS.merge hm (Buffer.contents b) } let eol = '\r'? '\n' let space = [' ' '\t'] let alpha = ['a'-'z' 'A'-'Z'] let digit = ['0'-'9'] let ichar = alpha | digit | ['_' '-'] let id = ichar* alpha ichar* let ident = (id | '_') ('+' (id | '_'))* (':' id)? let relop = ('!'? '=' | [ '<' '>' ] '='? | '~') let pfxop = '!' | '?' let envop_char = [ '+' ':' ] let envop = (envop_char '=' | '=' envop_char '='?) let int = ('-'? ['0'-'9' '_']+) rule token = parse | space { token lexbuf } | eol { newline lexbuf; token lexbuf } | ":" { COLON } | "{" { LBRACE } | "}" { RBRACE } | "[" { LBRACKET } | "]" { RBRACKET } | "(" { LPAR } | ")" { RPAR } | '\"' { STRING (buffer_rule string lexbuf) } | "\"\"\"" { STRING (buffer_rule string_triple lexbuf) } | "(*" { comment 1 lexbuf; token lexbuf } | '#' [^'\n']* { token lexbuf } | "true" { BOOL true } | "false"{ BOOL false } | int { INT (int_of_string (Lexing.lexeme lexbuf)) } | ident { IDENT (HS.merge hm (Lexing.lexeme lexbuf)) } | relop { RELOP (FullPos.relop (Lexing.lexeme lexbuf)) } | '&' { AND } | '|' { OR } | pfxop { PFXOP (FullPos.pfxop (Lexing.lexeme lexbuf)) } | envop { ENVOP (FullPos.env_update_op (Lexing.lexeme lexbuf)) } | eof { EOF } (* OpamBaseParser can't directly access OpamLexer.Error so it uses these constants (which would parse that way) to extract the exception values. *) | "opam-version: \"2.1\"\nopam-version: \"z\"" eof { error "opam-version cannot be repeated" } | "version: \"42\"\nopam-version: \"2.1\"" eof { error "opam-version must be the first non-comment line" } | _ { let token = Lexing.lexeme lexbuf in error "'%s' is not a valid token" token } and string b = parse | '\"' { () } | eol { newline lexbuf ; Buffer.add_char b '\n' ; string b lexbuf } | '\\' { (match escape lexbuf with | Some c -> Buffer.add_char b c | None -> ()); string b lexbuf } | _ as c { Buffer.add_char b c ; string b lexbuf } | eof { error "unterminated string" } and string_triple b = parse | "\"\"\"" { () } | eol { newline lexbuf ; Buffer.add_char b '\n' ; string_triple b lexbuf } | '\\' { (match escape lexbuf with | Some c -> Buffer.add_char b c | None -> ()); string_triple b lexbuf } | _ as c { Buffer.add_char b c ; string_triple b lexbuf } | eof { error "unterminated string" } and escape = parse | eol space * { newline lexbuf; None } | ['\\' '\"' ''' 'n' 'r' 't' 'b' ' '] as c { Some (char_for_backslash c) } | digit digit digit { Some (char_for_decimal_code lexbuf 0) } | 'x' ['0'-'9''a'-'f''A'-'F'] ['0'-'9''a'-'f''A'-'F'] { Some (char_for_hexadecimal_code lexbuf 1) } | "" { error "illegal escape sequence" } and comment n = parse | "*)" { if n > 1 then comment (n-1) lexbuf } | "(*" { comment (n+1)lexbuf } | eof { error "unterminated comment" } | '\n' { newline lexbuf; comment n lexbuf } | _ { comment n lexbuf } opam-file-format-2.1.6/src/opamParser.ml000066400000000000000000000077021440615251300201200ustar00rootroot00000000000000(**************************************************************************) (* *) (* Copyright 2016-2018 OCamlPro *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) (** Generic glue functions *) let parse_from_string parse_fun str filename = let lexbuf = Lexing.from_string str in lexbuf.Lexing.lex_curr_p <- { lexbuf.Lexing.lex_curr_p with Lexing.pos_fname = filename }; parse_fun OpamLexer.token lexbuf let parse_from_channel parse_fun ic filename = let lexbuf = Lexing.from_channel ic in lexbuf.Lexing.lex_curr_p <- { lexbuf.Lexing.lex_curr_p with Lexing.pos_fname = filename }; parse_fun OpamLexer.token lexbuf let parse_from_file parse_fun filename = let ic = open_in_bin filename in try let r = parse_from_channel parse_fun ic filename in close_in ic; r with e -> close_in ic; raise e (** file parsers *) let main' main filename lexer lexbuf = main lexer lexbuf filename let string main str filename = parse_from_string (main' main filename) str filename let channel main ic filename = parse_from_channel (main' main filename) ic filename let file main filename = parse_from_file (main' main filename) filename module FullPos = struct open OpamParserTypes.FullPos (** raw parser entry points *) let main = OpamBaseParser.main let value = OpamBaseParser.value (** file parsers *) let string = string main let channel = channel main let file = file main (** value parsers *) let value_from_string = parse_from_string value let value_from_channel = parse_from_channel value let value_from_file = parse_from_file value (* Functions to transform simple pos to full pos *) module S = OpamParserTypes let to_pos e = (e.pos.filename, fst e.pos.start, snd e.pos.start) let rec to_value v = match v.pelem with | Bool b -> S.Bool (to_pos v, b) | Int i -> S.Int (to_pos v, i) | String s -> S.String (to_pos v, s) | Relop (r,v,v') -> S.Relop (to_pos r, r.pelem, to_value v, to_value v') | Prefix_relop (r,v) -> S.Prefix_relop (to_pos r, r.pelem, to_value v) | Logop (l,v,v') -> S.Logop (to_pos l, l.pelem, to_value v, to_value v') | Pfxop (p,v) -> S.Pfxop (to_pos p, p.pelem, to_value v) | Ident s -> S.Ident (to_pos v, s) | List l -> S.List (to_pos l, List.map to_value l.pelem) | Group g -> S.Group (to_pos g, List.map to_value g.pelem) | Option (v,vl) -> S.Option (to_pos vl, to_value v, List.map to_value vl.pelem) | Env_binding (v,o,v') -> S.Env_binding (to_pos o, to_value v, o.pelem, to_value v') let rec to_section s = { S.section_kind = s.section_kind.pelem; S.section_name = (match s.section_name with | Some n -> Some n.pelem | None -> None); S.section_items = List.map to_item s.section_items.pelem } and to_item i = match i.pelem with | Section s -> S.Section (to_pos s.section_kind, to_section s) | Variable (s, v) -> S.Variable (to_pos s, s.pelem, to_value v) let to_opamfile o = { S.file_contents = List.map to_item o.file_contents; S.file_name = o.file_name } end (** raw parser entry points *) let main f l fd = FullPos.to_opamfile (OpamBaseParser.main f l fd) let value f l = FullPos.to_value (OpamBaseParser.value f l) (** file parsers *) let string = string main let channel = channel main let file = file main (** value parsers *) let value_from_string = parse_from_string value let value_from_channel = parse_from_channel value let value_from_file = parse_from_file value opam-file-format-2.1.6/src/opamParser.mli000066400000000000000000000100661440615251300202660ustar00rootroot00000000000000(**************************************************************************) (* *) (* Copyright 2016-2020 OCamlPro *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) (** opam format parser *) open OpamParserTypes (** [OpamParser] transitional module with full position types *) module FullPos : sig open OpamParserTypes.FullPos (** {2 Raw OpamBaseParser entry points } *) (** Providing a custom [lexbuf] argument allows you, for example, to set the initial lexing position. For the first argument, you may use the {!OpamLexer.token} lexing function: {[ let lexbuf = Lexing.from_string input in lexbuf.Lexing.lex_curr_p <- current_position; OpamParser.value OpamLexer.token lexbuf ]} *) val main: (Lexing.lexbuf -> OpamBaseParser.token) -> Lexing.lexbuf -> file_name -> opamfile (** Principal parser: given a lexbuf and the filename it was read from, returns an {!OpamParserTypes.FullPos.opamfile} record parsed from it. *) val value: (Lexing.lexbuf -> OpamBaseParser.token) -> Lexing.lexbuf -> value (** Lower-level function just returning a single {!OpamParserTypes.FullPos.value} from a given lexer. *) (** {2 File parsers } *) val string: string -> file_name -> opamfile (** Parse the content of a file already read to a string. Note that for CRLF-detection to work on Windows, it is necessary to read the original file using binary mode on Windows! *) val channel: in_channel -> file_name -> opamfile (** Parse the content of a file from an already-opened channel. Note that for CRLF-detection to work on Windows, it is necessary for the channel to be in binary mode! *) val file: file_name -> opamfile (** Parse the content of a file. The file is opened in binary mode, so CRLF-detection works on all platforms. *) (** {2 [value] parsers } *) val value_from_string: string -> file_name -> value (** Parse the first value in the given string. [file_name] is used for lexer positions. *) val value_from_channel: in_channel -> file_name -> value (** Parse the first value from the given channel. [file_name] is used for lexer positions. *) val value_from_file: file_name -> value (** Parse the first value from the given file. *) (** {2 Conversion functions, from full position to simple position (legacy)} *) val to_value: value -> OpamParserTypes.value val to_section: opamfile_section -> OpamParserTypes.opamfile_section val to_item: opamfile_item -> OpamParserTypes.opamfile_item val to_opamfile: opamfile -> OpamParserTypes.opamfile end val main: (Lexing.lexbuf -> OpamBaseParser.token) -> Lexing.lexbuf -> file_name -> opamfile [@@ocaml.deprecated "Use OpamParser.FullPos.main instead."] val value: (Lexing.lexbuf -> OpamBaseParser.token) -> Lexing.lexbuf -> value [@@ocaml.deprecated "Use OpamParser.FullPos.value instead."] val string: string -> file_name -> opamfile [@@ocaml.deprecated "Use OpamParser.FullPos.string instead."] val channel: in_channel -> file_name -> opamfile [@@ocaml.deprecated "Use OpamParser.FullPos.channel instead."] val file: file_name -> opamfile [@@ocaml.deprecated "Use OpamParser.FullPos.file instead."] val value_from_string: string -> file_name -> value [@@ocaml.deprecated "Use OpamParser.FullPos.value_from_string instead."] val value_from_channel: in_channel -> file_name -> value [@@ocaml.deprecated "Use OpamParser.FullPos.value_from_channel instead."] val value_from_file: file_name -> value [@@ocaml.deprecated "Use OpamParser.FullPos.value_from_file instead."] opam-file-format-2.1.6/src/opamParserTypes.ml000066400000000000000000000120661440615251300211440ustar00rootroot00000000000000(**************************************************************************) (* *) (* Copyright 2012-2020 OCamlPro *) (* Copyright 2012 INRIA *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) (** Defines the types for the opam format lexer and parser *) (** Type definitions used by the legacy and the new full position modules *) (** Relational operators *) type relop = [ `Eq (** [=] *) | `Neq (** [!=] *) | `Geq (** [>=] *) | `Gt (** [>] *) | `Leq (** [<=] *) | `Lt (** [<] *) ] (** Logical operators *) type logop = [ `And (** [&] *) | `Or (** [|] *) ] (** Prefix operators *) type pfxop = [ `Not (** [!] *) | `Defined (** [?] *) ] type file_name = string (** Source file positions: [(filename, line, column)] *) type pos = file_name * int * int (** Environment variable update operators *) type env_update_op = Eq (** [=] *) | PlusEq (** [+=] *) | EqPlus (** [=+] *) | ColonEq (** [:=] *) | EqColon (** [=:] *) | EqPlusEq (** [=+=] *) (** [OpamParserTypes] transitional module with full position types *) module FullPos = struct (** Source file positions *) type file_name = string (** Full position *) type pos = { filename: file_name; start: int * int; (* line, column *) stop: int * int; (* line, column *) } (** [with_pos] type, used for all units, embedding the element [pelem] ans its position [pos] *) type 'a with_pos = { pelem : 'a; pos : pos } type relop_kind = relop type relop = relop_kind with_pos type logop_kind = logop type logop = logop_kind with_pos type pfxop_kind = pfxop type pfxop = pfxop_kind with_pos type env_update_op_kind = env_update_op type env_update_op = env_update_op_kind with_pos (** Base values *) type value_kind = | Bool of bool (** [bool] atoms *) | Int of int (** [int] atoms *) | String of string (** [string] atoms *) | Relop of relop * value * value (** Relational operators with two values (e.g. [os != "win32"]) *) | Prefix_relop of relop * value (** Relational operators in prefix position (e.g. [< "4.07.0"]) *) | Logop of logop * value * value (** Logical operators *) | Pfxop of pfxop * value (** Prefix operators *) | Ident of string (** Identifiers *) | List of value list with_pos (** Lists of values ([[x1 x2 ... x3]]) *) | Group of value list with_pos (** Groups of values ([(x1 x2 ... x3)]) *) | Option of value * value list with_pos (** Value with optional list ([x1 {x2 x3 x4}]) *) | Env_binding of value * env_update_op * value (** Environment variable binding ([FOO += "bar"]) *) and value = value_kind with_pos (** An opamfile section *) type opamfile_section = { section_kind : string with_pos; (** Section kind (e.g. [extra-source]) *) section_name : string with_pos option; (** Section name (e.g. ["myfork.patch"]) *) section_items : opamfile_item list with_pos; (** Content of the section *) } (** An opamfile is composed of sections and variable definitions *) and opamfile_item_kind = | Section of opamfile_section (** e.g. [kind ["name"] { ... }] *) | Variable of string with_pos * value (** e.g. [opam-version: "2.0"] *) and opamfile_item = opamfile_item_kind with_pos (** A file is a list of items and the filename *) type opamfile = { file_contents: opamfile_item list; (** Content of the file *) file_name : file_name; (** Name of the disk file this record was loaded from *) } end type value = | Bool of pos * bool | Int of pos * int | String of pos * string | Relop of pos * relop * value * value | Prefix_relop of pos * relop * value | Logop of pos * logop * value * value | Pfxop of pos * pfxop * value | Ident of pos * string | List of pos * value list | Group of pos * value list | Option of pos * value * value list | Env_binding of pos * value * env_update_op * value type opamfile_section = { section_kind : string; section_name : string option; section_items : opamfile_item list } and opamfile_item = | Section of pos * opamfile_section | Variable of pos * string * value type opamfile = { file_contents: opamfile_item list; file_name : file_name; } opam-file-format-2.1.6/src/opamPrinter.ml000066400000000000000000000626051440615251300203120ustar00rootroot00000000000000(**************************************************************************) (* *) (* Copyright 2012-2020 OCamlPro *) (* Copyright 2012 INRIA *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) open OpamParserTypes (* The code duplication with OpamBaseParser is irritating, but can't be solved without introducing another module. *) let nopatch v = let s = try let i = String.index v '.' in let i = String.index_from v (i+1) '.' in (String.sub v 0 i) with Not_found -> let rec f i = if i >= String.length v then v else match String.get v i with | '0'..'9' | '.' -> f (i+1) | _ -> String.sub v 0 i in f 0 in try Scanf.sscanf s "%u.%u%!" (fun maj min -> (maj, min)) with Scanf.Scan_failure _ | Failure _ | End_of_file -> try Scanf.sscanf s "%u%!" (fun maj -> (maj, 0)) with Scanf.Scan_failure _ | Failure _ | End_of_file -> (0, 0) let valid_opamfile_contents = function | (Variable (_, "opam-version", String (_, ver)))::items when nopatch ver >= (2, 1) -> let opam_version_field = function | Variable (_, "opam-version", _) -> true | _ -> false in not (List.exists opam_version_field items) | _::items -> let greater_2_0_opam_version_field = function | Variable (_, "opam-version", String (_, ver)) when nopatch ver >= (2, 1) -> true | _ -> false in not (List.exists greater_2_0_opam_version_field items) | [] -> true let relop = function | `Eq -> "=" | `Neq -> "!=" | `Geq -> ">=" | `Gt -> ">" | `Leq -> "<=" | `Lt -> "<" | `Sem -> "~" let logop = function | `And -> "&" | `Or -> "|" let pfxop = function | `Not -> "!" | `Defined -> "?" let env_update_op = function | Eq -> "=" | PlusEq -> "+=" | EqPlus -> "=+" | EqPlusEq -> "=+=" | ColonEq -> ":=" | EqColon -> "=:" let escape_string ?(triple=false) s = let len = String.length s in let buf = Buffer.create (len * 2) in for i = 0 to len -1 do let c = s.[i] in (match c with | '"' when not triple || (i < len - 2 && s.[i+1] = '"' && s.[i+2] = '"') || i = len - 1 -> Buffer.add_char buf '\\' | '\\' -> Buffer.add_char buf '\\' | _ -> ()); Buffer.add_char buf c done; Buffer.contents buf let rec format_value fmt = function | Relop (_,op,l,r) -> Format.fprintf fmt "@[%a %s@ %a@]" format_value l (relop op) format_value r | Logop (_,op,l,r) -> Format.fprintf fmt "@[%a %s@ %a@]" format_value l (logop op) format_value r | Pfxop (_,op,r) -> Format.fprintf fmt "@[%s%a@]" (pfxop op) format_value r | Prefix_relop (_,op,r) -> Format.fprintf fmt "@[%s@ %a@]" (relop op) format_value r | Ident (_,s) -> Format.fprintf fmt "%s" s | Int (_,i) -> Format.fprintf fmt "%d" i | Bool (_,b) -> Format.fprintf fmt "%b" b | String (_,s) -> if String.contains s '\n' then Format.fprintf fmt "\"\"\"%s%s\"\"\"" (if s.[0] = '\n' then "" else "\\\n") (escape_string ~triple:true s) else Format.fprintf fmt "\"%s\"" (escape_string s) | List (_, l) -> Format.fprintf fmt "@[[@;<0 2>@[%a@]@,]@]" format_values l | Group (_,g) -> Format.fprintf fmt "@[(%a)@]" format_values g | Option(_,v,l) -> Format.fprintf fmt "@[%a@ {@[%a@]}@]" format_value v format_values l | Env_binding (_,id,op,v) -> Format.fprintf fmt "@[%a %s@ %a@]" format_value id (env_update_op op) format_value v and format_values fmt = function | [] -> () | [v] -> format_value fmt v | v::r -> format_value fmt v; Format.pp_print_space fmt (); format_values fmt r let value v = format_value Format.str_formatter v; Format.flush_str_formatter () let value_list vl = Format.fprintf Format.str_formatter "@[%a@]" format_values vl; Format.flush_str_formatter () let rec format_item fmt = function | Variable (_, _, List (_,[])) -> () | Variable (_, _, List (_,[List(_,[])])) -> () | Variable (_, i, List (_,l)) -> if List.exists (function List _ | Option (_,_,_::_) -> true | _ -> false) l then Format.fprintf fmt "@[%s: [@;<0 2>@[%a@]@,]@]" i format_values l else Format.fprintf fmt "@[%s: [@;<0 2>@[%a@]@,]@]" i format_values l | Variable (_, i, (String (_,s) as v)) when String.contains s '\n' -> Format.fprintf fmt "@[%s: %a@]" i format_value v | Variable (_, i, v) -> Format.fprintf fmt "@[%s:@ %a@]" i format_value v | Section (_,s) -> Format.fprintf fmt "@[%s %s{@;<0 2>@[%a@]@,}@]" s.section_kind (match s.section_name with | Some s -> Printf.sprintf "\"%s\" " (escape_string s) | None -> "") format_items s.section_items and format_items fmt is = Format.pp_open_vbox fmt 0; (match is with | [] -> () | i::r -> format_item fmt i; List.iter (fun i -> Format.pp_print_cut fmt (); format_item fmt i) r); Format.pp_close_box fmt () let format_opamfile fmt f = format_items fmt f.file_contents; Format.pp_print_newline fmt () let items l = if not (valid_opamfile_contents l) then invalid_arg "OpamPrinter.items"; format_items Format.str_formatter l; Format.flush_str_formatter () let opamfile f = items f.file_contents let rec value_equals v1 v2 = match v1, v2 with | Bool (_, b1), Bool (_, b2) -> b1 = b2 | Int (_, i1), Int (_, i2) -> i1 = i2 | String (_, s1), String (_, s2) -> s1 = s2 | Relop (_, r1, va1, vb1), Relop (_, r2, va2, vb2) -> r1 = r2 && value_equals va1 va2 && value_equals vb1 vb2 | Prefix_relop (_, r1, v1), Prefix_relop (_, r2, v2) -> r1 = r2 && value_equals v1 v2 | Logop (_, l1, va1, vb1), Logop (_, l2, va2, vb2) -> l1 = l2 && value_equals va1 va2 && value_equals vb1 vb2 | Pfxop (_, p1, v1), Pfxop (_, p2, v2) -> p1 = p2 && value_equals v1 v2 | Ident (_, s1), Ident (_, s2) -> s1 = s2 | List (_, vl1), List (_, vl2) -> (try List.for_all2 value_equals vl1 vl2 with Invalid_argument _ -> false) | Group (_, vl1), Group (_, vl2) -> (try List.for_all2 value_equals vl1 vl2 with Invalid_argument _ -> false) | Option (_, v1, vl1), Option (_, v2, vl2) -> value_equals v1 v2 && (try List.for_all2 value_equals vl1 vl2 with Invalid_argument _ -> false) | Env_binding (_, v1, op1, vx1), Env_binding (_, v2, op2, vx2) -> op1 = op2 && value_equals v1 v2 && value_equals vx1 vx2 | _ -> false let rec opamfile_item_equals i1 i2 = match i1, i2 with | Variable (_, n1, v1), Variable (_, n2, v2) -> n1 = n2 && value_equals v1 v2 | Section (_, s1), Section (_, s2) -> s1.section_kind = s2.section_kind && s1.section_name = s2.section_name && (try List.for_all2 opamfile_item_equals s1.section_items s2.section_items with Invalid_argument _ -> false) | _ -> false module Normalise = struct let escape_string s = let len = String.length s in let buf = Buffer.create (len * 2) in Buffer.add_char buf '"'; for i = 0 to len -1 do match s.[i] with | '\\' | '"' as c -> Buffer.add_char buf '\\'; Buffer.add_char buf c | '\n' -> Buffer.add_string buf "\\n" | c -> Buffer.add_char buf c done; Buffer.add_char buf '"'; Buffer.contents buf let rec value = function | Relop (_,op,l,r) -> String.concat " " [value l; relop op; value r] | Logop (_,op,l,r) -> String.concat " " [value l; logop op; value r] | Pfxop (_,op,r) -> String.concat " " [pfxop op; value r] | Prefix_relop (_,op,r) -> String.concat " " [relop op; value r] | Ident (_,s) -> s | Int (_,i) -> string_of_int i | Bool (_,b) -> string_of_bool b | String (_,s) -> escape_string s | List (_, l) -> Printf.sprintf "[%s]" (String.concat " " (List.map value l)) | Group (_,g) -> Printf.sprintf "(%s)" (String.concat " " (List.map value g)) | Option(_,v,l) -> Printf.sprintf "%s {%s}" (value v) (String.concat " " (List.map value l)) | Env_binding (_,id,op,v) -> String.concat " " [value id; env_update_op op; value v] let rec item = function | Variable (_, _, List (_,([]|[List(_,[])]))) -> "" | Variable (_, i, List (_,l)) -> Printf.sprintf "%s: [%s]" i (String.concat " " (List.map value l)) | Variable (_, i, v) -> String.concat ": " [i; value v] | Section (_,s) -> Printf.sprintf "%s %s{\n%s\n}" s.section_kind (match s.section_name with | Some s -> escape_string s ^ " " | None -> "") (String.concat "\n" (List.map item s.section_items)) let item_order a b = match a,b with | Variable (_, "opam-version", String (_, ver)), _ when nopatch ver >= (2, 1) -> -1 | _, Variable (_, "opam-version", String (_, ver)) when nopatch ver >= (2, 1) -> 1 | Section _, Variable _ -> 1 | Variable _, Section _ -> -1 | Variable (_,i,_), Variable (_,j,_) -> String.compare i j | Section (_,s), Section (_,t) -> let r = String.compare s.section_kind t.section_kind in if r <> 0 then r else compare s.section_name t.section_name let items its = if not (valid_opamfile_contents its) then invalid_arg "OpamPrinter.Normalise.items"; let its = List.sort item_order its in String.concat "\n" (List.map item its) ^ "\n" let opamfile f = items f.file_contents end module Preserved = struct let items txt orig f = if not (valid_opamfile_contents f) then invalid_arg "OpamPrinter.Preserved.items"; let pos_index = let lines_index = let rec aux acc s = let until = try Some (String.index_from s (List.hd acc) '\n') with Not_found -> None in match until with | Some until -> aux (until+1 :: acc) s | None -> Array.of_list (List.rev acc) in aux [0] txt in fun (_file, li, col) -> lines_index.(li - 1) + col in let get_substring start_pos rest = let start = pos_index start_pos in let stop = match rest with | (Section (pos,_) | Variable (pos,_,_)) :: _ -> pos_index pos | [] -> String.length txt in if stop < start then raise Exit else String.sub txt start (stop - start) in let list_take f l = let rec aux acc = function | [] -> None, List.rev acc | x::r -> if f x then Some x, List.rev_append acc r else aux (x::acc) r in aux [] l in let is_variable name = function | Variable (_, name1, _v1) -> name = name1 | _ -> false in let is_section kind name = function | Section (_, {section_kind; section_name; _}) -> kind = section_kind && name = section_name | _ -> false in let rec aux acc f = function | Variable (pos, name, v) :: r -> (match list_take (is_variable name) f with | Some (Variable (_, _, v1)), f when value_equals v v1 -> aux (get_substring pos r :: acc) f r | Some item, f -> aux ((items [item] ^ "\n") :: acc) f r | None, f -> aux acc f r) | Section (pos, {section_kind; section_name; _}) as sec :: r -> (match list_take (is_section section_kind section_name) f with | Some s, f when opamfile_item_equals sec s -> aux (get_substring pos r :: acc) f r | Some item, f -> aux ((items [item] ^ "\n") :: acc) f r | None, f -> aux acc f r) | [] -> let remaining = match f with | [] -> [] | f -> [items f ^ "\n"] in List.rev_append acc remaining in let header = [get_substring ("",1,0) orig] in String.concat "" (aux header f orig) let opamfile ?format_from f = let orig_file = match format_from with | Some name -> name | None -> f.file_name in let txt = let b = Buffer.create 4096 in let ic = open_in orig_file in try while true do Buffer.add_channel b ic 4096 done; assert false with | End_of_file -> close_in ic; Buffer.contents b | e -> close_in ic; raise e in let[@ocaml.warning "-3"] orig = OpamParser.string txt orig_file in items txt orig.file_contents f.file_contents end module FullPos = struct open OpamParserTypes.FullPos let valid_opamfile_contents = function | {pelem = Variable ({pelem = "opam-version"; _}, {pelem = String ver; _}); _}::items when nopatch ver >= (2, 1) -> let opam_version_field = function | {pelem = Variable ({pelem = "opam-version"; _}, _); _} -> true | _ -> false in not (List.exists opam_version_field items) | _::items -> let greater_2_0_opam_version_field = function | {pelem = Variable ({pelem = "opam-version"; _}, {pelem = String ver; _}); _} when nopatch ver >= (2, 1) -> true | _ -> false in not (List.exists greater_2_0_opam_version_field items) | [] -> true let relop_kind = relop let relop r = relop_kind r.pelem let logop_kind = logop let logop r = logop_kind r.pelem let pfxop_kind = pfxop let pfxop r = pfxop_kind r.pelem let env_update_op_kind = env_update_op let env_update_op r = env_update_op_kind r.pelem let rec format_value fmt v = match v.pelem with | Relop (op,l,r) -> Format.fprintf fmt "@[%a %s@ %a@]" format_value l (relop op) format_value r | Logop (op,l,r) -> Format.fprintf fmt "@[%a %s@ %a@]" format_value l (logop op) format_value r | Pfxop (op,r) -> Format.fprintf fmt "@[%s%a@]" (pfxop op) format_value r | Prefix_relop (op,r) -> Format.fprintf fmt "@[%s@ %a@]" (relop op) format_value r | Ident s -> Format.fprintf fmt "%s" s | Int i -> Format.fprintf fmt "%d" i | Bool b -> Format.fprintf fmt "%b" b | String s -> if String.contains s '\n' then Format.fprintf fmt "\"\"\"%s%s\"\"\"" (if s.[0] = '\n' then "" else "\\\n") (escape_string ~triple:true s) else Format.fprintf fmt "\"%s\"" (escape_string s) | List l -> Format.fprintf fmt "@[[@;<0 2>@[%a@]@,]@]" format_values l.pelem | Group g -> Format.fprintf fmt "@[(%a)@]" format_values g.pelem | Option (v,l) -> Format.fprintf fmt "@[%a@ {@[%a@]}@]" format_value v format_values l.pelem | Env_binding (id,op,v) -> Format.fprintf fmt "@[%a %s@ %a@]" format_value id (env_update_op op) format_value v and format_values fmt = function | [] -> () | [v] -> format_value fmt v | v::r -> format_value fmt v; Format.pp_print_space fmt (); format_values fmt r let value v = format_value Format.str_formatter v; Format.flush_str_formatter () let value_list vl = Format.fprintf Format.str_formatter "@[%a@]" format_values vl.pelem; Format.flush_str_formatter () let format_sstring fmt s = Format.fprintf fmt "%s" s.pelem let rec format_item fmt i = match i.pelem with | Variable (_, { pelem = List { pelem = []; _}; _}) -> () | Variable (_, { pelem = List { pelem = [{ pelem = List { pelem = []; _}; _}]; _}; _}) -> () | Variable (i, { pelem = List { pelem = l; _}; _}) -> if List.exists (fun v -> match v.pelem with List _ | Option (_,{ pelem = _::_; _}) -> true | _ -> false) l then Format.fprintf fmt "@[%a: [@;<0 2>@[%a@]@,]@]" format_sstring i format_values l else Format.fprintf fmt "@[%a: [@;<0 2>@[%a@]@,]@]" format_sstring i format_values l | Variable (i, ({ pelem = String s ; _} as v)) when String.contains s '\n' -> Format.fprintf fmt "@[%a: %a@]" format_sstring i format_value v | Variable (i, v) -> Format.fprintf fmt "@[%a:@ %a@]" format_sstring i format_value v | Section s -> Format.fprintf fmt "@[%a %s{@;<0 2>@[%a@]@,}@]" format_sstring s.section_kind (match s.section_name with | Some s -> Printf.sprintf "\"%s\" " (escape_string s.pelem) | None -> "") format_items s.section_items.pelem and format_items fmt is = Format.pp_open_vbox fmt 0; (match is with | [] -> () | i::r -> format_item fmt i; List.iter (fun i -> Format.pp_print_cut fmt (); format_item fmt i) r); Format.pp_close_box fmt () let format_opamfile fmt f = format_items fmt f.file_contents; Format.pp_print_newline fmt () let items l = if not (valid_opamfile_contents l) then invalid_arg "OpamPrinter.FullPos.items"; format_items Format.str_formatter l; Format.flush_str_formatter () let opamfile f = items f.file_contents let relop_equals r1 r2 = r1.pelem = r2.pelem let logop_equals r1 r2 = r1.pelem = r2.pelem let pfxop_equals r1 r2 = r1.pelem = r2.pelem let env_update_op_equals r1 r2 = r1.pelem = r2.pelem let rec value_equals v1 v2 = match v1.pelem, v2.pelem with | Bool (b1), Bool (b2) -> b1 = b2 | Int (i1), Int (i2) -> i1 = i2 | String (s1), String (s2) -> s1 = s2 | Relop (r1, va1, vb1), Relop (r2, va2, vb2) -> relop_equals r1 r2 && value_equals va1 va2 && value_equals vb1 vb2 | Prefix_relop (r1, v1), Prefix_relop (r2, v2) -> relop_equals r1 r2 && value_equals v1 v2 | Logop (l1, va1, vb1), Logop (l2, va2, vb2) -> logop_equals l1 l2 && value_equals va1 va2 && value_equals vb1 vb2 | Pfxop (p1, v1), Pfxop (p2, v2) -> pfxop_equals p1 p2 && value_equals v1 v2 | Ident (s1), Ident (s2) -> s1 = s2 | List (vl1), List (vl2) -> (try List.for_all2 value_equals vl1.pelem vl2.pelem with Invalid_argument _ -> false) | Group (vl1), Group (vl2) -> (try List.for_all2 value_equals vl1.pelem vl2.pelem with Invalid_argument _ -> false) | Option (v1, vl1), Option (v2, vl2) -> value_equals v1 v2 && (try List.for_all2 value_equals vl1.pelem vl2.pelem with Invalid_argument _ -> false) | Env_binding (v1, op1, vx1), Env_binding (v2, op2, vx2) -> env_update_op_equals op1 op2 && value_equals v1 v2 && value_equals vx1 vx2 | _ -> false let sstring_equals s1 s2 = s1.pelem = s2.pelem let rec opamfile_item_equals i1 i2 = match i1.pelem , i2.pelem with | Variable (n1, v1), Variable (n2, v2) -> sstring_equals n1 n2 && value_equals v1 v2 | Section (s1), Section (s2) -> sstring_equals s1.section_kind s2.section_kind && (match s1.section_name, s2.section_name with | None, None -> true | Some s1, Some s2 -> sstring_equals s1 s2 | _,_ -> false) && (try List.for_all2 opamfile_item_equals s1.section_items.pelem s2.section_items.pelem with Invalid_argument _ -> false) | _ -> false module Normalise = struct let escape_string s = let len = String.length s in let buf = Buffer.create (len * 2) in Buffer.add_char buf '"'; for i = 0 to len -1 do match s.[i] with | '\\' | '"' as c -> Buffer.add_char buf '\\'; Buffer.add_char buf c | '\n' -> Buffer.add_string buf "\\n" | c -> Buffer.add_char buf c done; Buffer.add_char buf '"'; Buffer.contents buf let rec value v = match v.pelem with | Relop (op,l,r) -> String.concat " " [value l; relop op; value r] | Logop (op,l,r) -> String.concat " " [value l; logop op; value r] | Pfxop (op,r) -> String.concat " " [pfxop op; value r] | Prefix_relop (op,r) -> String.concat " " [relop op; value r] | Ident s -> s | Int i -> string_of_int i | Bool b -> string_of_bool b | String s -> escape_string s | List l -> Printf.sprintf "[%s]" (String.concat " " (List.map value l.pelem)) | Group g -> Printf.sprintf "(%s)" (String.concat " " (List.map value g.pelem)) | Option(v,l) -> Printf.sprintf "%s {%s}" (value v) (String.concat " " (List.map value l.pelem)) | Env_binding (id,op,v) -> String.concat " " [value id; env_update_op op; value v] let rec item i = match i.pelem with | Variable (_, { pelem = List { pelem = []; _}; _}) | Variable (_, { pelem = List { pelem = [{ pelem = List { pelem = []; _}; _}]; _}; _}) -> "" | Variable (i, { pelem = List { pelem = l; _}; _}) -> Printf.sprintf "%s: [%s]" i.pelem (String.concat " " (List.map value l)) | Variable (i, v) -> String.concat ": " [i.pelem; value v] | Section s -> Printf.sprintf "%s %s{\n%s\n}" s.section_kind.pelem (match s.section_name with | Some s -> escape_string s.pelem ^ " " | None -> "") (String.concat "\n" (List.map item s.section_items.pelem)) let item_order a b = match a.pelem ,b.pelem with | Variable ({pelem = "opam-version"; _}, {pelem = String ver; _}), _ when nopatch ver >= (2, 1) -> -1 | _, Variable ({pelem = "opam-version"; _}, {pelem = String ver; _}) when nopatch ver >= (2, 1) -> 1 | Section _, Variable _ -> 1 | Variable _, Section _ -> -1 | Variable (i,_), Variable (j,_) -> String.compare i.pelem j.pelem | Section s, Section t -> let r = String.compare s.section_kind.pelem t.section_kind.pelem in if r <> 0 then r else compare s.section_name t.section_name let items its = if not (valid_opamfile_contents its) then invalid_arg "OpamPrinter.Normalise.items"; let its = List.sort item_order its in String.concat "\n" (List.map item its) ^ "\n" let opamfile f = items f.file_contents end module Preserved = struct let items txt orig f = if not (valid_opamfile_contents f) then invalid_arg "OpamPrinter.Preserved.items"; let pos_index = let lines_index = let rec aux acc s = let until = try Some (String.index_from s (List.hd acc) '\n') with Not_found -> None in match until with | Some until -> aux (until+1 :: acc) s | None -> Array.of_list (List.rev acc) in aux [0] txt in fun p -> let sli, scol = p.start in let eli, ecol = p.stop in lines_index.(sli - 1) + scol, lines_index.(eli -1) + ecol in let get_substring pos = let start, stop = pos_index pos in if stop < start then raise Exit else String.sub txt start (stop - start) in let list_take f l = let rec aux acc = function | [] -> None, List.rev acc | x::r -> if f x then Some x, List.rev_append acc r else aux (x::acc) r in aux [] l in let is_variable name = function | { pelem = Variable (name1, _v1); _} -> sstring_equals name name1 | _ -> false in let is_section kind name = function | { pelem = Section ({section_kind; section_name; _}); _} -> sstring_equals kind section_kind && (match name, section_name with | None, None -> true | Some s1, Some s2 -> sstring_equals s1 s2 | _,_ -> false) | _ -> false in let rec aux acc f = function | { pos; pelem = Variable ( name, v)} :: r -> (match list_take (is_variable name) f with | Some {pelem = Variable (_, v1); _}, f when value_equals v v1 -> aux (get_substring pos :: acc) f r | Some item, f -> aux (items [item] :: acc) f r | None, f -> aux acc f r) | {pos; pelem = Section {section_kind; section_name; _}} as sec :: r -> (match list_take (is_section section_kind section_name) f with | Some s, f when opamfile_item_equals sec s -> aux (get_substring pos :: acc) f r | Some item, f -> aux (items [item] :: acc) f r | None, f -> aux acc f r) | [] -> let remaining = match f with | [] -> [""] | f -> [items f; ""] in List.rev_append acc remaining in let body = String.concat "\n" (aux [] f orig) in let header = match orig with | [] -> "" | h::_ -> get_substring {filename=""; start=(1,0); stop=h.pos.start} in header ^ body let opamfile ?format_from f = let orig_file = match format_from with | Some name -> name | None -> f.file_name in let txt = let b = Buffer.create 4096 in let ic = open_in orig_file in try while true do Buffer.add_channel b ic 4096 done; assert false with | End_of_file -> close_in ic; Buffer.contents b | e -> close_in ic; raise e in let orig = OpamParser.FullPos.string txt orig_file in items txt orig.file_contents f.file_contents end end opam-file-format-2.1.6/src/opamPrinter.mli000066400000000000000000000171121440615251300204540ustar00rootroot00000000000000(**************************************************************************) (* *) (* Copyright 2012-2020 OCamlPro *) (* Copyright 2012 INRIA *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) (** Functions for converting parsed opam files back to strings *) (** [OpamPrinter] transitional module with full position types *) module FullPos : sig open OpamParserTypes.FullPos (** {2 Printers for the [value] and [opamfile] formats} *) val relop_kind: [< relop_kind ] -> string (** Converts {!OpamParserTypes.FullPos.relop_kind} to its string representation ([=], [!=], ..., [~]). *) val logop_kind: [< logop_kind ] -> string (** Converts {!OpamParserTypes.FullPos.logop_kind} to its string representation ([&] and [|]). *) val pfxop_kind: [< pfxop_kind ] -> string (** Converts {!OpamParserTypes.FullPos.logop_kind} to its string representation ([&] and [|]). *) val env_update_op_kind: env_update_op_kind -> string (** Converts {!OpamParserTypes.FullPos.env_update_op_kind} to its string representation ([=], [+=], ..., [=:]). *) val relop: relop -> string (** Converts {!OpamParserTypes.FullPos.relop} to its string representation ([=], [!=], ..., [~]). *) val logop: logop -> string (** Converts {!OpamParserTypes.FullPos.logop} to its string representation ([&] and [|]). *) val pfxop: pfxop -> string (** Converts {!OpamParserTypes.FullPos.pfxop} to its string representation ([!] and [?]). *) val env_update_op: env_update_op -> string (** Converts {!OpamParserTypes.FullPos.env_update_op} to its string representation ([=], [+=], ..., [=:]). *) val value : value -> string (** Converts {!value} to a string {b always using LF-encoding of newlines}. *) val value_list: value list with_pos -> string (** Converts a list of {!value}s to a string {b always using LF-encoding of newlines}. *) val items: opamfile_item list -> string (** Converts a list of opam field/sections to a string. @raise Invalid_argument if ["opam-version"] is greater than "2.0" and not solely the first item. *) val opamfile: opamfile -> string (** Converts an {!opamfile} to a string. @raise Invalid_argument if ["opam-version"] is greater than "2.0" and not solely the first item. *) val format_opamfile: Format.formatter -> opamfile -> unit (** Writes an {!opamfile} to a [Format.formatter]. The function ensures that all newlines are sent using [Format]'s break instructions (and so ultimately are processed with the [out_newline] function of the formatter) but it is the responsibility of the caller to ensure that the formatter is configured for the required output, if necessary. @raise Invalid_argument if ["opam-version"] is greater than "2.0" and not solely the first item. *) (** {2 Normalised output for opam syntax files} *) (** opam normalised file format, for signatures. - each top-level field on a single line - newlines are LF-encoded (including on Windows) - file ends with a newline - spaces only after [fieldname:], between elements in lists, before braced options, between operators and their operands - fields are sorted lexicographically by field name (using [String.compare]) - newlines in strings turned to ['\n'], backslashes and double quotes escaped - no comments (they don't appear in the internal file format anyway) - fields containing an empty list, or a singleton list containing an empty list, are not printed at all *) module Normalise : sig val escape_string : string -> string val value : value -> string val item : opamfile_item -> string val item_order : opamfile_item -> opamfile_item -> int val items : opamfile_item list -> string val opamfile : opamfile -> string end (** {2 Format-preserving reprinter} *) module Preserved : sig val items: string -> opamfile_item list -> opamfile_item list -> string (** [items str orig_its its] converts [its] to string, while attempting to preserve the layout and comments of the original [str] for unmodified elements. The function assumes that [str] parses to the items [orig_its]. @raise Invalid_argument if ["opam-version"] is greater than "2.0" and not solely the first item in either list. *) val opamfile: ?format_from:file_name -> opamfile -> string (** [opamfile f] converts [f] to string, respecting the layout and comments in the corresponding on-disk file for unmodified items. [format_from] can be specified instead of using the filename specified in [f]. @raise Invalid_argument if ["opam-version"] is greater than "2.0" and not solely the first item in the list. Note that any errors in the file raise {!OpamLexer.Error} as normal. *) end (** {2 Random utility functions} *) val value_equals: value -> value -> bool (** Compares structurally, without considering file positions *) val opamfile_item_equals: opamfile_item -> opamfile_item -> bool (** Compares structurally, without considering file positions *) end open OpamParserTypes val relop: [< relop ] -> string [@@ocaml.deprecated "Use OpamPrinter.FullPos.relop instead."] val logop: [< logop ] -> string [@@ocaml.deprecated "Use OpamPrinter.FullPos.logop instead."] val pfxop: [< pfxop ] -> string [@@ocaml.deprecated "Use OpamPrinter.FullPos.pfxop instead."] val env_update_op: env_update_op -> string [@@ocaml.deprecated "Use OpamPrinter.FullPos.env_update_op instead."] val value : value -> string [@@ocaml.deprecated "Use OpamPrinter.FullPos.value instead."] val value_list: value list -> string [@@ocaml.deprecated "Use OpamPrinter.FullPos.value_list instead."] val items: opamfile_item list -> string [@@ocaml.deprecated "Use OpamPrinter.FullPos.items instead."] val opamfile: opamfile -> string [@@ocaml.deprecated "Use OpamPrinter.FullPos.opamfile instead."] val format_opamfile: Format.formatter -> opamfile -> unit [@@ocaml.deprecated "Use OpamPrinter.FullPos.format_opamfile instead."] module Normalise : sig val escape_string : string -> string val value : value -> string val item : opamfile_item -> string val item_order : opamfile_item -> opamfile_item -> int val items : opamfile_item list -> string val opamfile : opamfile -> string end [@@ocaml.deprecated "Use OpamPrinter.FullPos.Normalise instead."] module Preserved : sig val items: string -> opamfile_item list -> opamfile_item list -> string val opamfile: ?format_from:file_name -> opamfile -> string end [@@ocaml.deprecated "Use OpamPrinter.FullPos.Preserved instead."] val value_equals: value -> value -> bool [@@ocaml.deprecated "Use OpamPrinter.FullPos.value_equals instead."] val opamfile_item_equals: opamfile_item -> opamfile_item -> bool [@@ocaml.deprecated "Use OpamPrinter.FullPos.opamfile_item_equals instead."] opam-file-format-2.1.6/tests/000077500000000000000000000000001440615251300160225ustar00rootroot00000000000000opam-file-format-2.1.6/tests/Makefile000066400000000000000000000003061440615251300174610ustar00rootroot00000000000000all: tests tests: ocamlfind ocamlc tests.ml -o tests -linkpkg -package alcotest -package opam-file-format run: tests ./tests .PHONY: clean clean: rm -f tests rm -f *.cmi *.cmo rm -rf _build opam-file-format-2.1.6/tests/dune000066400000000000000000000001721440615251300167000ustar00rootroot00000000000000(test (name tests) (deps sample.opam) (libraries alcotest opam-file-format)) (rule (copy sample-opam sample.opam)) opam-file-format-2.1.6/tests/fullpos.ml000066400000000000000000000412741440615251300200500ustar00rootroot00000000000000(**************************************************************************) (* *) (* Copyright 2020 OCamlPro *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) open OpamParserTypes.FullPos open Utils module A = Alcotest (* utils *) let fd = "" let np pelem = { pos = { filename = fd; start = (0,0); stop = (0,0) }; pelem } let nullify_list l = List.map (fun (n,s,v) -> n,s,np v) l module Value = struct let int0 = np @@ Int 0 let intmax = np @@ Int max_int let sfoo = np @@ String "foo" let sbar = np @@ String "bar" let sempty = np @@ String "" let btrue = np @@ Bool true let bfalse = np @@ Bool false let a = np @@ Ident "a" let b = np @@ Ident "b" let c = np @@ Ident "c" let d = np @@ Ident "d" let simple = [ "int", "0", int0; "max_int", (Printf.sprintf "%d" max_int), intmax; "string", "\"foo\"", sfoo; "string", "\"bar\"", sbar; "empty string", "\"\"", sempty; "true", "true", btrue; "false", "false", bfalse; "ident", "a", a; "ident", "b", b; ] let relop = [ (* printed with a space *) "equal", "=", `Eq; "not-equal", "!=", `Neq; "greater-or-equal", ">=", `Geq; "greater-than", ">", `Gt; "lesser-or-equal", "<=", `Leq; "lesser-than", "<", `Lt; ] let logop = [ "disj", "&", `And; "conj", "|", `Or; ] let pfxop = [ "not", "!", `Not; "defined", "?", `Defined; ] let env_update_op : (string * string * env_update_op_kind ) list = [ (* "equal", "=", Eq; *) "plus-equal", "+=", PlusEq; "equal-plus", "=+", EqPlus; "colon-equal", ":=", ColonEq; "equal-colon", "=:", EqColon; "equal-plus-equal", "=+=", EqPlusEq; ] let unop ?(space=false) () = let (^^) a b = if space then a^" "^b else a^b in let args = simple in let fold unop f = List.fold_left (fun acc op -> acc @ List.map (fun arg -> f op arg) args) [] unop in ((fold pfxop @@ fun (n,sop,op) (n', sarg, arg) -> (n^" "^n', sop^sarg, Pfxop (np op, arg))) @ (fold relop @@ fun (n,sop,op) (n', sarg, arg) -> (n^" "^n', sop^^sarg, Prefix_relop (np op, arg)))) |> nullify_list let binop ?(space=false) () = let (^^) a b = if space then a^" "^b else a^b in let args = List.fold_left (fun acc x -> acc @ List.map (fun y -> (x,y)) simple) [] simple in let fold binop f = List.fold_left (fun acc op -> acc @ List.map (fun (arg1,arg2) -> f op arg1 arg2) args) [] binop in ((fold relop @@ fun (n,sop,op) (n1, sarg1, arg1) (n2, sarg2, arg2) -> (n1^" "^n^" "^n2, sarg1^^sop^^sarg2, Relop (np op, arg1, arg2))) @ (fold logop @@ fun (n,sop,op) (n1, sarg1, arg1) (n2, sarg2, arg2) -> (n1^" "^n^" "^n2, sarg1^^sop^^sarg2, Logop (np op, arg1, arg2))) @ (fold env_update_op @@ fun (n,sop,op) (n1, sarg1, arg1) (n2, sarg2, arg2) -> (n1^" "^n^" "^n2, sarg1^^sop^^sarg2, Env_binding (arg1, np op, arg2)))) |> nullify_list let lists ?(space=false) () = let s = if space then " " else "" in let slist, list = List.(split (map (fun (_,a,b) -> a,b) simple)) in [ "list", Printf.sprintf "[%s%s%s]" s (String.concat " " slist) s, np @@ List (np list); "group", Printf.sprintf "(%s%s%s)" s (String.concat " " slist) s, np @@ Group (np list); ] @ (List.map (fun (n,sarg,arg) -> "option "^n, Printf.sprintf "%s {%s%s%s}" sarg s (String.concat " " slist) s, np @@ Option (arg, np list)) simple) let and_or () = [ "and-or", "a & (b | c)", Logop (np `And, a, np @@ Group (np [np @@ Logop (np `Or, b, c)])); "or-and", "a | b & c", Logop (np `Or, a, np @@ Logop (np `And, b, c)); "or-and", "a & b | c", Logop (np `Or, np @@ Logop (np `And, a, b), c); "or-and-and", "a & b | c & d", Logop (np `Or, np @@ Logop (np `And, a, b), np @@ Logop (np `And, c, d)); "or-and-and", "(a & b) | (c & d)", Logop (np `Or, np @@ Group (np [np @@ Logop (np `And, a, b)]), np @@ Group (np [np @@ Logop (np `And, c, d)])); "or-or-and", "a | b & c | d", Logop (np `Or, np @@ Logop (np `Or, a, np @@ Logop (np `And, b, c)), d); "and-or-or", "(a | b) & (c | d)", Logop (np `And, np @@ Group (np [np @@ Logop (np `Or, a, b)]), np @@ Group (np [np @@ Logop (np `Or, c, d)])); ] |> nullify_list let print_value v = OpamPrinter.FullPos.value v |> split_on_char '\n' |> List.map (fun s -> try if s.[0] = ' ' then String.sub s 1 (String.length s - 1) else s with Invalid_argument _ -> s) |> String.concat "" let parse_value s = OpamParser.FullPos.value_from_string s fd let value_testable = let value_fmt : value Fmt.t = fun ppf v -> Format.fprintf ppf "%s" (OpamPrinter.FullPos.value v) in A.testable value_fmt OpamPrinter.FullPos.value_equals let test_printer t () = List.iter (fun (name, str, value) -> A.check A.string name str (print_value value)) t let test_parser t () = List.iter (fun (name, str, value) -> A.check value_testable name value (parse_value str)) t let test_parser_printer t () = List.iter (fun (name, str, _) -> A.check A.string name str (print_value (parse_value str))) t let space = true let printer = [ "simple", test_printer simple; "unop", test_printer @@ unop ~space (); "binop", test_printer @@ binop ~space (); "lists", test_printer @@ lists (); "and_or", test_printer @@ and_or (); ] let parser = [ "simple", test_parser simple; "unop", test_parser @@ unop (); "binop", test_parser @@ binop (); "lists", test_parser @@ lists ~space (); "and_or", test_parser @@ and_or (); ] let parser_printer = [ "simple", test_parser_printer simple; "unop", test_parser_printer @@ unop ~space (); "binop", test_parser_printer @@ binop ~space (); "lists", test_parser_printer @@ lists (); "and_or", test_parser_printer @@ and_or (); ] let tests = List.fold_left (fun acc (n, t) -> (List.map (fun (n', t') -> n^" "^n', t') t) @ acc) [] [ "printer", printer; "parser", parser; "parser-printer", parser_printer; ] end module Item = struct let variables = let space = true in let get_name pre n = String.map (fun c -> if c = ' ' then '-' else c) (pre^"-"^n) in [ List.map (fun (n,s,v) -> let name = get_name "simple" n in name, Printf.sprintf "%s: %s" name s, Variable (np name, v)) Value.simple; List.map (fun (n,s,v) -> let name = get_name "unop" n in name, Printf.sprintf "%s: %s" name s, Variable (np name, v)) (Value.unop ~space ()); List.map (fun (n,s,v) -> let name = get_name "binop" n in name, Printf.sprintf "%s: %s" name s, Variable (np name, v)) (Value.binop ~space ()); List.map (fun (n,s,v) -> let name = get_name "lists" n in name, Printf.sprintf "%s: %s" name s, Variable (np name, v)) (Value.lists ()); ] |> List.flatten |> nullify_list let sections = let section_wname = function | { pelem = Section sec; _} -> np @@ Section ({ sec with section_name = Some (np "a-name") }) | _ -> raise (Invalid_argument "section_wname") in let str_section_wname = add_after_first ' ' "\"a-name\" " in let sec ?(inner=false) kind items str_items = let padding = if inner then " " else "" in kind, Printf.sprintf "%s {\n %s%s\n%s}" kind padding str_items padding , np @@ Section ({ section_kind = np kind; section_name = None; section_items = np items }) in let v1,s1, v2,s2, v3,s3 = match variables with | (_,s1,v1)::_::(_,s2,v2)::_::_::(_,s3,v3)::_ -> v1,s1, v2,s2, v3,s3 | _ -> assert false in let empty ?inner () = sec ?inner "section-empty" [] "" in let one_item ?inner () = sec ?inner "section-with-one-item" [v1] s1 in let more_items ?inner () = sec ?inner "section-with-more-items" [ v1; v2; v3 ] (let padding = if inner = Some true then " " else "" in Printf.sprintf "%s\n %s%s\n %s%s" s1 padding s2 padding s3) in let sec_w_esec = let _, estr, esec = empty ~inner:true () in sec "section-w-empty-section" [esec] estr in let sec_w_osec = let _, ostr, osec = one_item ~inner:true () in sec "section-w-1item-section" [osec] ostr in let sec_w_item_sec = let _, ostr, osec = one_item ~inner:true () in sec "section-w-item--asection" [v1; osec] (Printf.sprintf "%s\n %s" s1 ostr) in let sec_w_sec_item = let _, ostr, osec = one_item ~inner:true () in sec "section-w-section-a-item" [osec; v2] (Printf.sprintf "%s\n %s" ostr s2) in let sec_w_secs_and_items = let _, estr, esec = empty ~inner:true () in let _, ostr, osec = one_item ~inner:true () in let _, mstr, msec = more_items ~inner:true () in sec "section-w-sections-a-items" [ v1; esec; section_wname osec; v2; v3; msec ] (String.concat "\n " [ s1; estr; str_section_wname ostr; s2; s3; mstr ]) in List.fold_left (fun acc (n,s,i as section) -> (n^"-with-name", str_section_wname s, section_wname i)::section::acc) [] [ empty (); one_item (); more_items (); sec_w_esec; sec_w_osec; sec_w_item_sec; sec_w_sec_item; sec_w_secs_and_items; ] |> List.rev let newline = add_after_first ~cond:(fun s -> String.length s > 78 (* ??? *)) ':' "\n " let parse_item item = match (OpamParser.FullPos.string item fd).file_contents with | [x] -> x | _ -> failwith "irrelevant" let print_item item = OpamPrinter.FullPos.items [item] let item_testable = let item_fmt : opamfile_item Fmt.t = fun ppf i -> Format.fprintf ppf "%s" (OpamPrinter.FullPos.items [i]) in A.testable item_fmt OpamPrinter.FullPos.opamfile_item_equals let test_printer ?nl t () = let newline = if nl <> None then newline else fun s -> s in List.iter (fun (name, str, item) -> A.check A.string name (newline str) (print_item item)) t let test_parser t () = List.iter (fun (name, str, item) -> A.check item_testable name item (parse_item str)) t let test_parser_printer ?nl t () = let newline = if nl <> None then newline else fun s -> s in List.iter (fun (name, str, _) -> A.check A.string name (newline str) (print_item (parse_item str))) t let tests = [ "variable printer", test_printer ~nl:true variables; "variable parser", test_parser variables; "variable parser-printer", test_parser_printer ~nl:true variables; "section printer", test_printer sections; "section parser", test_parser sections; "section parser-printer", test_parser_printer sections; ] end module Opamfile = struct let opamfiles, opamfiles_comment = let ofile contents = { file_contents = contents; file_name = fd } in let empty = "empty", "", ofile [] in let one_item = let _, str, item = match Item.variables with | x::_ -> x | _ -> assert false in "one-item", str, ofile [item] in let one_section = let _, str, section = match Item.sections with | _::x::_ -> x | _ -> assert false in "one-section", str, ofile [section] in let full = let all = Item.((List.map (fun (n,s,v) -> n, newline s, v) variables) @ sections) in let str = String.concat "\n" (List.map (fun (_,s,_) -> s) all) in let items = List.map (fun (_,_,i) -> i) all in "all", str, ofile items in let add_comment before (name, str, it) = name, (if before then "#tautological comment\n"^str else str^"\n#tautological comment"), it in [ empty; one_item; one_section; full; ], [ add_comment true empty; add_comment true one_item; add_comment false one_section; ] let print_ofile = OpamPrinter.FullPos.opamfile let parse_ofile s = OpamParser.FullPos.string s fd let ofile_testable = let opamfile_fmt : opamfile Fmt.t = fun ppf f -> Format.fprintf ppf "%s" (OpamPrinter.FullPos.opamfile f) in let opamfile_equals o1 o2 = let rec aux o1 o2 = match o1, o2 with | i1::l1, i2::l2 -> OpamPrinter.FullPos.opamfile_item_equals i1 i2 || aux l1 l2 | [], [] -> true | _, _ -> false in aux o1.file_contents o2.file_contents in A.testable opamfile_fmt opamfile_equals let ofile_pos_testable = let opamfile_fmt : opamfile Fmt.t = fun ppf f -> Format.fprintf ppf "%s" (OpamPrinter.FullPos.opamfile f) in let opamfile_equals o1 o2 = o1.file_contents = o2.file_contents in A.testable opamfile_fmt opamfile_equals let test_printer t () = List.iter (fun (name, str, ofile) -> A.check A.string name str (print_ofile ofile)) t let test_parser t () = List.iter (fun (name, str, ofile) -> A.check ofile_testable name ofile (parse_ofile str)) t let test_parser_printer t () = List.iter (fun (name, str, _) -> A.check A.string name str (print_ofile (parse_ofile str))) t let test_printer_preserved t () = let write_tmp content ~f = let file, oc = Filename.open_temp_file "opam-test-" ".opam" in output_string oc content; close_out oc; let res = f file in Sys.remove file; res in let opamfile = OpamPrinter.FullPos.Preserved.opamfile in List.iter (fun (name, str, _) -> let file = parse_ofile str in let content1 = write_tmp str ~f:(fun tmp -> opamfile ~format_from:tmp file) in let content2 = write_tmp content1 ~f:(fun tmp -> opamfile ~format_from:tmp file) in A.check A.string name content1 content2 ) t let positions () = let filename = Sys.getcwd () ^ "/sample.opam" in let spos start stop = {filename; start; stop } in let file_contents = [ { pos = spos (1, 0) (1, 6); pelem = Variable ({ pos = spos (1, 0) (1, 3); pelem = "int" }, { pos = spos (1, 5) (1, 6); pelem = Int 0 }); }; { pos = spos (2, 0) (2, 13); pelem = Variable ({ pos = spos (2, 0) (2, 6); pelem = "string" }, { pos = spos (2, 8) (2, 13); pelem = String "foo" }); }; { pos = spos (4, 0) (6, 1); pelem = Section { section_kind = { pos = spos (4, 0) (4, 7); pelem = "section" }; section_name = Some { pos = spos (4, 8) (4, 15); pelem = "thing" }; section_items = { pos = spos (4, 16) (6, 1); pelem = [{ pos = spos (5, 2) (5, 29); pelem = Variable ({ pos = spos (5, 2) (5, 5); pelem = "url"}, { pos = spos (5, 7) (5, 29); pelem = String "https://theinter.net" }); }]; } }; } ]; in let content = {file_contents; file_name = filename} in A.check ofile_pos_testable "sample" content (OpamParser.FullPos.file filename) let tests = [ "parser", test_parser (opamfiles @ opamfiles_comment); "printer", test_printer opamfiles; "parser-printer", test_parser_printer opamfiles; "printer-preserved", test_printer_preserved opamfiles_comment; "positions-file", positions; ] end let tests = [ "values", Value.tests; "items", Item.tests; "opamfile", Opamfile.tests; ] |> List.map (fun (n,t) -> "fullpos "^n, t) opam-file-format-2.1.6/tests/hygiene/000077500000000000000000000000001440615251300174525ustar00rootroot00000000000000opam-file-format-2.1.6/tests/hygiene/dune000066400000000000000000000013171440615251300203320ustar00rootroot00000000000000(copy_files ../../src/opamParserTypes.ml) (test (name opamBaseParser) (modules OpamParserTypes OpamBaseParser) (flags :standard (:include flags.sexp)) (action (run %{test} %{version:opam-file-format}))) (ocamlyacc OpamBaseParser) (rule (with-stdout-to OpamBaseParser.mly (progn (cat ../../src/opamBaseParser.mly) ; If this assertion fails, OpamBaseParser.version is wrong (echo "let () = assert (Scanf.sscanf Sys.argv.(1) \"%u.%u\" (fun x y -> (x, y)) = version)")))) (rule (with-stdout-to flags.ml (echo "print_string (if String.sub Sys.ocaml_version 0 5 = \"4.02.\" then \"(-w -50)\" else \"()\")"))) (rule (with-stdout-to flags.sexp (run ocaml %{dep:flags.ml}))) opam-file-format-2.1.6/tests/legacy/000077500000000000000000000000001440615251300172665ustar00rootroot00000000000000opam-file-format-2.1.6/tests/legacy/Makefile000066400000000000000000000004351440615251300207300ustar00rootroot00000000000000.PHONY: test test:: legacy.byte ifneq "$(shell ocamlopt -vnum 2>/dev/null)" "" test:: legacy.native endif src/%: $(MAKE) -C src $* legacy.byte: src/opam-file-format.cma legacy.ml ocamlc -o $@ -I src $^ legacy.native: src/opam-file-format.cmxa legacy.ml ocamlopt -o $@ -I src $^ opam-file-format-2.1.6/tests/legacy/dune000066400000000000000000000003511440615251300201430ustar00rootroot00000000000000; This test (driven by Dune) ensures that the old build system works (copy_files ../../opam-file-format.opam) (alias (name runtest) (deps Makefile legacy.ml opam-file-format.opam (glob_files src/*)) (action (run make test))) opam-file-format-2.1.6/tests/legacy/legacy.ml000066400000000000000000000003371440615251300210670ustar00rootroot00000000000000(* This "program" is used to verify that the library is linkable - see #40 *) let file = OpamParser.FullPos.file "../opam-file-format.opam" in Printf.printf "Successfully loaded %s\n" file.OpamParserTypes.FullPos.file_name opam-file-format-2.1.6/tests/legacy/src/000077500000000000000000000000001440615251300200555ustar00rootroot00000000000000opam-file-format-2.1.6/tests/legacy/src/dune000066400000000000000000000002061440615251300207310ustar00rootroot00000000000000; We mustn't copy the dune file, but Dune's globbing has no syntax for that (copy_files ../../../src/o*) (copy_files ../../../src/M*) opam-file-format-2.1.6/tests/oldpos.ml000066400000000000000000000350101440615251300176530ustar00rootroot00000000000000(**************************************************************************) (* *) (* Copyright 2020 OCamlPro *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) [@@@ocaml.warning "-3"] open OpamParserTypes open Utils module A = Alcotest (* utils *) let null = ("", 0, 0) let fd = "" module Value = struct let int0 = Int (null, 0) let intmax = Int (null, max_int) let sfoo = String (null, "foo") let sbar = String (null, "bar") let sempty = String (null, "") let btrue = Bool (null, true) let bfalse = Bool (null, false) let a = Ident (null, "a") let b = Ident (null, "b") let c = Ident (null, "c") let d = Ident (null, "d") let simple = [ "int", "0", int0; "max_int", (Printf.sprintf "%d" max_int), intmax; "string", "\"foo\"", sfoo; "string", "\"bar\"", sbar; "empty string", "\"\"", sempty; "true", "true", btrue; "false", "false", bfalse; "ident", "a", a; "ident", "b", b; ] let relop = [ (* printed with a space *) "equal", "=", `Eq; "not-equal", "!=", `Neq; "greater-or-equal", ">=", `Geq; "greater-than", ">", `Gt; "lesser-or-equal", "<=", `Leq; "lesser-than", "<", `Lt; ] let logop = [ "disj", "&", `And; "conj", "|", `Or; ] let pfxop = [ "not", "!", `Not; "defined", "?", `Defined; ] let env_update_op = [ (* "equal", "=", Eq; *) "plus-equal", "+=", PlusEq; "equal-plus", "=+", EqPlus; "colon-equal", ":=", ColonEq; "equal-colon", "=:", EqColon; "equal-plus-equal", "=+=", EqPlusEq; ] let unop ?(space=false) () = let (^^) a b = if space then a^" "^b else a^b in let args = simple in let fold unop f = List.fold_left (fun acc op -> acc @ List.map (fun arg -> f op arg) args) [] unop in (fold pfxop @@ fun (n,sop,op) (n', sarg, arg) -> (n^" "^n', sop^sarg, Pfxop (null, op, arg))) @ (fold relop @@ fun (n,sop,op) (n', sarg, arg) -> (n^" "^n', sop^^sarg, Prefix_relop (null, op, arg))) let binop ?(space=false) () = let (^^) a b = if space then a^" "^b else a^b in let args = List.fold_left (fun acc x -> acc @ List.map (fun y -> (x,y)) simple) [] simple in let fold binop f = List.fold_left (fun acc op -> acc @ List.map (fun (arg1,arg2) -> f op arg1 arg2) args) [] binop in (fold relop @@ fun (n,sop,op) (n1, sarg1, arg1) (n2, sarg2, arg2) -> (n1^" "^n^" "^n2, sarg1^^sop^^sarg2, Relop (null, op, arg1, arg2))) @ (fold logop @@ fun (n,sop,op) (n1, sarg1, arg1) (n2, sarg2, arg2) -> (n1^" "^n^" "^n2, sarg1^^sop^^sarg2, Logop (null, op, arg1, arg2))) @ (fold env_update_op @@ fun (n,sop,op) (n1, sarg1, arg1) (n2, sarg2, arg2) -> (n1^" "^n^" "^n2, sarg1^^sop^^sarg2, Env_binding (null, arg1, op, arg2))) let lists ?(space=false) () = let s = if space then " " else "" in let slist, list = List.(split (map (fun (_,a,b) -> a,b) simple)) in [ "list", Printf.sprintf "[%s%s%s]" s (String.concat " " slist) s, List (null, list); "group", Printf.sprintf "(%s%s%s)" s (String.concat " " slist) s, Group (null, list); ] @ (List.map (fun (n,sarg,arg) -> "option "^n, Printf.sprintf "%s {%s%s%s}" sarg s (String.concat " " slist) s, Option (null, arg, list)) simple) let and_or () = [ "and-or", "a & (b | c)", Logop (null,`And, a, Group (null, [Logop (null, `Or, b, c)])); "or-and", "a | b & c", Logop (null, `Or, a, Logop (null, `And, b, c)); "or-and", "a & b | c", Logop (null, `Or, Logop (null, `And, a, b), c); "or-and-and", "a & b | c & d", Logop (null, `Or, Logop (null, `And, a, b), Logop (null, `And, c, d)); "or-and-and", "(a & b) | (c & d)", Logop (null, `Or, Group (null, [Logop (null, `And, a, b)]), Group (null, [Logop (null, `And, c, d)])); "or-or-and", "a | b & c | d", Logop (null, `Or, Logop (null, `Or, a, Logop (null, `And, b, c)), d); "and-or-or", "(a | b) & (c | d)", Logop (null, `And, Group (null, [Logop (null, `Or, a, b)]), Group (null, [Logop (null, `Or, c, d)])); ] let print_value v = OpamPrinter.value v |> split_on_char '\n' |> List.map (fun s -> try if s.[0] = ' ' then String.sub s 1 (String.length s - 1) else s with Invalid_argument _ -> s) |> String.concat "" let parse_value s = OpamParser.value_from_string s fd let value_testable = let value_fmt : value Fmt.t = fun ppf v -> Format.fprintf ppf "%s" (OpamPrinter.value v) in A.testable value_fmt OpamPrinter.value_equals let test_printer t () = List.iter (fun (name, str, value) -> A.check A.string name str (print_value value)) t let test_parser t () = List.iter (fun (name, str, value) -> A.check value_testable name value (parse_value str)) t let test_parser_printer t () = List.iter (fun (name, str, _) -> A.check A.string name str (print_value (parse_value str))) t let space = true let printer = [ "simple", test_printer simple; "unop", test_printer @@ unop ~space (); "binop", test_printer @@ binop ~space (); "lists", test_printer @@ lists (); "and_or", test_printer @@ and_or (); ] let parser = [ "simple", test_parser simple; "unop", test_parser @@ unop (); "binop", test_parser @@ binop (); "lists", test_parser @@ lists ~space (); "and_or", test_parser @@ and_or (); ] let parser_printer = [ "simple", test_parser_printer simple; "unop", test_parser_printer @@ unop ~space (); "binop", test_parser_printer @@ binop ~space (); "lists", test_parser_printer @@ lists (); "and_or", test_parser_printer @@ and_or (); ] let tests = List.fold_left (fun acc (n, t) -> (List.map (fun (n', t') -> n^" "^n', t') t) @ acc) [] [ "printer", printer; "parser", parser; "parser-printer", parser_printer; ] end module Item = struct let variables = let space = true in let get_name pre n = String.map (fun c -> if c = ' ' then '-' else c) (pre^"-"^n) in [ List.map (fun (n,s,v) -> let name = get_name "simple" n in name, Printf.sprintf "%s: %s" name s, Variable (null, name, v)) Value.simple; List.map (fun (n,s,v) -> let name = get_name "unop" n in name, Printf.sprintf "%s: %s" name s, Variable (null, name, v)) (Value.unop ~space ()); List.map (fun (n,s,v) -> let name = get_name "binop" n in name, Printf.sprintf "%s: %s" name s, Variable (null, name, v)) (Value.binop ~space ()); List.map (fun (n,s,v) -> let name = get_name "lists" n in name, Printf.sprintf "%s: %s" name s, Variable (null, name, v)) (Value.lists ()); ] |> List.flatten let sections = let section_wname = function | Section (_, sec) -> Section (null, { sec with section_name = Some "a-name" }) | Variable _ -> raise (Invalid_argument "section_wname") in let str_section_wname = add_after_first ' ' "\"a-name\" " in let sec ?(inner=false) kind items str_items = let padding = if inner then " " else "" in kind, Printf.sprintf "%s {\n %s%s\n%s}" kind padding str_items padding , Section (null, { section_kind = kind; section_name = None; section_items = items }) in let v1,s1, v2,s2, v3,s3 = match variables with | (_,s1,v1)::_::(_,s2,v2)::_::_::(_,s3,v3)::_ -> v1,s1, v2,s2, v3,s3 | _ -> assert false in let empty ?inner () = sec ?inner "section-empty" [] "" in let one_item ?inner () = sec ?inner "section-with-one-item" [v1] s1 in let more_items ?inner () = sec ?inner "section-with-more-items" [ v1; v2; v3 ] (let padding = if inner = Some true then " " else "" in Printf.sprintf "%s\n %s%s\n %s%s" s1 padding s2 padding s3) in let sec_w_esec = let _, estr, esec = empty ~inner:true () in sec "section-w-empty-section" [esec] estr in let sec_w_osec = let _, ostr, osec = one_item ~inner:true () in sec "section-w-1item-section" [osec] ostr in let sec_w_item_sec = let _, ostr, osec = one_item ~inner:true () in sec "section-w-item--asection" [v1; osec] (Printf.sprintf "%s\n %s" s1 ostr) in let sec_w_sec_item = let _, ostr, osec = one_item ~inner:true () in sec "section-w-section-a-item" [osec; v2] (Printf.sprintf "%s\n %s" ostr s2) in let sec_w_secs_and_items = let _, estr, esec = empty ~inner:true () in let _, ostr, osec = one_item ~inner:true () in let _, mstr, msec = more_items ~inner:true () in sec "section-w-sections-a-items" [ v1; esec; section_wname osec; v2; v3; msec ] (String.concat "\n " [ s1; estr; str_section_wname ostr; s2; s3; mstr ]) in List.fold_left (fun acc (n,s,i as section) -> (n^"-with-name", str_section_wname s, section_wname i)::section::acc) [] [ empty (); one_item (); more_items (); sec_w_esec; sec_w_osec; sec_w_item_sec; sec_w_sec_item; sec_w_secs_and_items; ] |> List.rev let newline = add_after_first ~cond:(fun s -> String.length s > 78 (* ??? *)) ':' "\n " let parse_item item = match (OpamParser.string item fd).file_contents with | [x] -> x | _ -> failwith "irrelevant" let print_item item = OpamPrinter.items [item] let item_testable = let item_fmt : opamfile_item Fmt.t = fun ppf i -> Format.fprintf ppf "%s" (OpamPrinter.items [i]) in A.testable item_fmt OpamPrinter.opamfile_item_equals let test_printer ?nl t () = let newline = if nl <> None then newline else fun s -> s in List.iter (fun (name, str, item) -> A.check A.string name (newline str) (print_item item)) t let test_parser t () = List.iter (fun (name, str, item) -> A.check item_testable name item (parse_item str)) t let test_parser_printer ?nl t () = let newline = if nl <> None then newline else fun s -> s in List.iter (fun (name, str, _) -> A.check A.string name (newline str) (print_item (parse_item str))) t let tests = [ "variable printer", test_printer ~nl:true variables; "variable parser", test_parser variables; "variable parser-printer", test_parser_printer ~nl:true variables; "section printer", test_printer sections; "section parser", test_parser sections; "section parser-printer", test_parser_printer sections; ] end module Opamfile = struct let opamfiles, opamfiles_comment = let ofile contents = { file_contents = contents; file_name = fd } in let empty = "empty", "", ofile [] in let one_item = let _, str, item = match Item.variables with | x::_ -> x | _ -> assert false in "one-item", str, ofile [item] in let one_section = let _, str, section = match Item.sections with | _::x::_ -> x | _ -> assert false in "one-section", str, ofile [section] in let full = let all = Item.((List.map (fun (n,s,v) -> n, newline s, v) variables) @ sections) in let str = String.concat "\n" (List.map (fun (_,s,_) -> s) all) in let items = List.map (fun (_,_,i) -> i) all in "all", str, ofile items in let add_comment before (name, str, it) = name, (if before then "#tautological comment\n"^str else str^"\n#tautological comment"), it in [ empty; one_item; one_section; full; ], [ add_comment true empty; add_comment true one_item; add_comment false one_section; ] let print_ofile = OpamPrinter.opamfile let parse_ofile s = OpamParser.string s fd let ofile_testable = let opamfile_fmt : opamfile Fmt.t = fun ppf f -> Format.fprintf ppf "%s" (OpamPrinter.opamfile f) in let opamfile_equals o1 o2 = let rec aux o1 o2 = match o1, o2 with | i1::l1, i2::l2 -> OpamPrinter.opamfile_item_equals i1 i2 || aux l1 l2 | [], [] -> true | _, _ -> false in aux o1.file_contents o2.file_contents in A.testable opamfile_fmt opamfile_equals let test_printer t () = List.iter (fun (name, str, ofile) -> A.check A.string name str (print_ofile ofile)) t let test_parser t () = List.iter (fun (name, str, ofile) -> A.check ofile_testable name ofile (parse_ofile str)) t let test_parser_printer t () = List.iter (fun (name, str, _) -> A.check A.string name str (print_ofile (parse_ofile str))) t let positions () = let filename = Sys.getcwd () ^ "/sample.opam" in let content = { file_contents = [Variable ((filename, 1, 0), "int", Int ((filename, 1, 5), 0)); Variable ((filename, 2, 0), "string", String ((filename, 2, 8), "foo")); Section ((filename, 4, 0), {section_kind = "section"; section_name = Some "thing"; section_items = [Variable ((filename, 5, 2), "url", String ((filename, 5, 7), "https://theinter.net")) ] }) ]; file_name = filename} in A.check ofile_testable "sample" content (OpamParser.file filename) let tests = [ "parser", test_parser (opamfiles @ opamfiles_comment); "printer", test_printer opamfiles; "parser-printer", test_parser_printer opamfiles; "positions-file", positions; ] end let tests = [ "values", Value.tests; "items", Item.tests; "opamfile", Opamfile.tests; ] |> List.map (fun (n,t) -> "oldpos "^n, t) opam-file-format-2.1.6/tests/sample-opam000066400000000000000000000001211440615251300201520ustar00rootroot00000000000000int: 0 string: "foo" #Identity section "thing" { url: "https://theinter.net" } opam-file-format-2.1.6/tests/tests.ml000066400000000000000000000016121440615251300175160ustar00rootroot00000000000000(**************************************************************************) (* *) (* Copyright 2020 OCamlPro *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) module A = Alcotest let _ = let tests = Oldpos.tests @ Fullpos.tests @ Versions.tests |> List.map (fun (n,t) -> n, List.map (fun (n,t) -> n, `Quick, t) t) in A.run "opam-file-format" tests opam-file-format-2.1.6/tests/utils.ml000066400000000000000000000025201440615251300175130ustar00rootroot00000000000000(**************************************************************************) (* *) (* Copyright 2020 OCamlPro *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) (* Common test functions *) let add_after_first ?(cond=fun _ -> true) c sep str = try let length = String.length str in if not (cond str) then str else let split = String.index str c in let fst = String.sub str 0 (split+1) in let snd = String.sub str (split+1) (length - split -1) in fst ^ sep ^ snd with _ -> failwith (Printf.sprintf "error with '%c' on %s" c str) let split_on_char sep s = let r = ref [] in let j = ref (String.length s) in for i = String.length s - 1 downto 0 do if String.get s i = sep then begin r := String.sub s (i + 1) (!j - i - 1) :: !r; j := i end done; String.sub s 0 !j :: !r opam-file-format-2.1.6/tests/versions.ml000066400000000000000000000060561440615251300202330ustar00rootroot00000000000000(**************************************************************************) (* *) (* Copyright 2021 David Allsopp Ltd. *) (* *) (* All rights reserved. This file is distributed under the terms of the *) (* GNU Lesser General Public License version 2.1, with the special *) (* exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) module A = Alcotest exception IA let tests_corrupt = let minimal = {| opam-version: "2.1" version: "2.1" |} in let opamfile = OpamParser.FullPos.string minimal "corrupt.opam" in let corrupt = OpamParserTypes.FullPos.({opamfile with file_contents = List.rev opamfile.file_contents}) in [ "OpamPrinter.FullPos.opamfile", OpamPrinter.FullPos.opamfile; "OpamPrinter.FullPos.Normalise.opamfile", OpamPrinter.FullPos.Normalise.opamfile ] |> List.map (fun (name, f) -> name, (fun () -> A.check_raises name IA (fun () -> try ignore (f corrupt) with Invalid_argument _ -> raise IA))) let tests_exn = [ "opam-version > 2.0 not at start 1", OpamLexer.Error("opam-version must be the first non-comment line"), {| version: "2.1" opam-version: "2.1" |}; "opam-version > 2.1 repeated", OpamLexer.Error("opam-version cannot be repeated"), {| opam-version: "2.1" opam-version: "2.1" |}; "no opam-version and parsing error", Parsing.Parse_error, {| build: [ "echo" |}; "opam-version 2.1 and lexing error", OpamLexer.Error "'@' is not a valid token", {| opam-version: "2.1" @ |}; "opam-version 2.1 and parsing error", Parsing.Parse_error, {| opam-version: "2.1" build: [ "echo" |}; "opam-version 2.1 and immediate parsing error", Parsing.Parse_error, {| opam-version: "2.1" !! |}; ] |> List.map (fun (name, exn, content) -> name, (fun () -> A.check_raises name exn (fun () -> OpamParser.FullPos.string content "broken.opam" |> ignore))) let has_sentinel = let open OpamParserTypes.FullPos in fun {file_contents; _} -> match List.rev file_contents with | {pelem = Section {section_kind = {pelem = "#"; _}; _}; _}::_ -> true | _ -> false let tests_noexn = [ "opam-version 4 and parsing error", {| opam-version: "4" !! |}; "opam-version 42.0 and parsing error", {| opam-version: "42.0" version: "42.0" !! |}; "opam-version 42.0 and evil parsing error", {| opam-version: "42.0" < |}; "opam-version 42.0 and immediate parsing error", {| opam-version: "42.0" !! |}; "opam-version 42.0 and lexing error", {| opam-version: "42.0" @ |}; ] |> List.map (fun (name, content) -> name, (fun () -> A.check A.bool name true (OpamParser.FullPos.string content "broken.opam" |> has_sentinel))) let tests = ["opam-version", tests_corrupt @ tests_exn @ tests_noexn]