Pino Toscano
2019-Dec-16 15:57 UTC
[Libguestfs] [PATCH 0/2] Move ocaml-augeas copy to libguestfs repo
ocaml-augeas is used only by virtlibguestfs, so move it to this repository, instead of having it around in the common submodule. The removal from common will happen later. Pino Toscano (2): Bundle the ocaml-augeas library for use by libguestfs build: switch embedded copy of ocaml-augeas .gitignore | 1 + 3rdparty/ocaml-augeas/COPYING.LIB | 515 +++++++++++++++++++++++++ 3rdparty/ocaml-augeas/Makefile.am | 82 ++++ 3rdparty/ocaml-augeas/augeas-c.c | 579 ++++++++++++++++++++++++++++ 3rdparty/ocaml-augeas/augeas.README | 8 + 3rdparty/ocaml-augeas/augeas.ml | 99 +++++ 3rdparty/ocaml-augeas/augeas.mli | 164 ++++++++ Makefile.am | 6 +- configure.ac | 2 +- daemon/Makefile.am | 4 +- docs/guestfs-hacking.pod | 19 +- ocaml-dep.sh.in | 2 +- 12 files changed, 1469 insertions(+), 12 deletions(-) create mode 100644 3rdparty/ocaml-augeas/COPYING.LIB create mode 100644 3rdparty/ocaml-augeas/Makefile.am create mode 100644 3rdparty/ocaml-augeas/augeas-c.c create mode 100644 3rdparty/ocaml-augeas/augeas.README create mode 100644 3rdparty/ocaml-augeas/augeas.ml create mode 100644 3rdparty/ocaml-augeas/augeas.mli -- 2.23.0
Pino Toscano
2019-Dec-16 15:57 UTC
[Libguestfs] [PATCH 1/2] Bundle the ocaml-augeas library for use by libguestfs
Add a copy of the libvirt-ocaml library, currently available at: http://git.annexia.org/?p=ocaml-augeas.git;a=summary This is a snapshot at commit 1cf5aef99b26a46529ca797547c0b49627fffe78, which has all the features we need (and that builds fine). It is expected to stay synchronized with upstream, until there is a new upstream release, and it will be widespread enough. --- 3rdparty/ocaml-augeas/COPYING.LIB | 515 +++++++++++++++++++++++++ 3rdparty/ocaml-augeas/Makefile.am | 82 ++++ 3rdparty/ocaml-augeas/augeas-c.c | 579 ++++++++++++++++++++++++++++ 3rdparty/ocaml-augeas/augeas.README | 8 + 3rdparty/ocaml-augeas/augeas.ml | 99 +++++ 3rdparty/ocaml-augeas/augeas.mli | 164 ++++++++ 6 files changed, 1447 insertions(+) create mode 100644 3rdparty/ocaml-augeas/COPYING.LIB create mode 100644 3rdparty/ocaml-augeas/Makefile.am create mode 100644 3rdparty/ocaml-augeas/augeas-c.c create mode 100644 3rdparty/ocaml-augeas/augeas.README create mode 100644 3rdparty/ocaml-augeas/augeas.ml create mode 100644 3rdparty/ocaml-augeas/augeas.mli diff --git a/3rdparty/ocaml-augeas/COPYING.LIB b/3rdparty/ocaml-augeas/COPYING.LIB new file mode 100644 index 000000000..ba2be481c --- /dev/null +++ b/3rdparty/ocaml-augeas/COPYING.LIB @@ -0,0 +1,515 @@ + + 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. +^L + 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. +^L + GNU LESSER GENERAL PUBLIC LICENSE + 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. +^L + 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. +^L + 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. +^L + 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. +^L + 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. +^L + 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 +^L + 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 a brief 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 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! + + diff --git a/3rdparty/ocaml-augeas/Makefile.am b/3rdparty/ocaml-augeas/Makefile.am new file mode 100644 index 000000000..af9759c5c --- /dev/null +++ b/3rdparty/ocaml-augeas/Makefile.am @@ -0,0 +1,82 @@ +# libguestfs OCaml tools common code +# Copyright (C) 2011-2019 Red Hat Inc. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +include $(top_srcdir)/subdir-rules.mk + +EXTRA_DIST = \ + $(SOURCES_MLI) \ + $(SOURCES_ML) \ + $(SOURCES_C) \ + augeas.README + +SOURCES_MLI = \ + augeas.mli + +SOURCES_ML = \ + augeas.ml + +SOURCES_C = \ + augeas-c.c + +# We pretend that we're building a C library. automake handles the +# compilation of the C sources for us. At the end we take the C +# objects and OCaml objects and link them into the OCaml library. +# This C library is never used. + +noinst_LIBRARIES = libmlaugeas.a + +if !HAVE_OCAMLOPT +MLAUGEAS_CMA = mlaugeas.cma +else +MLAUGEAS_CMA = mlaugeas.cmxa +endif + +noinst_DATA = $(MLAUGEAS_CMA) + +libmlaugeas_a_SOURCES = $(SOURCES_C) +libmlaugeas_a_CPPFLAGS = \ + -DCAML_NAME_SPACE \ + -I. \ + -I$(top_builddir) \ + -I$(shell $(OCAMLC) -where) +libmlaugeas_a_CFLAGS = \ + $(WARN_CFLAGS) $(NO_SNV_CFLAGS) $(NO_UM_CFLAGS) $(WERROR_CFLAGS) \ + $(AUGEAS_CFLAGS) $(LIBXML2_CFLAGS) \ + -fPIC + +BOBJECTS = $(SOURCES_ML:.ml=.cmo) +XOBJECTS = $(BOBJECTS:.cmo=.cmx) + +OCAMLPACKAGES +OCAMLFLAGS = $(OCAML_FLAGS) $(OCAML_WARN_ERROR) -ccopt '$(CFLAGS)' + +if !HAVE_OCAMLOPT +OBJECTS = $(BOBJECTS) +else +OBJECTS = $(XOBJECTS) +endif + +libmlaugeas_a_DEPENDENCIES = $(OBJECTS) + +$(MLAUGEAS_CMA): $(OBJECTS) libmlaugeas.a + $(OCAMLFIND) mklib $(OCAMLPACKAGES) \ + $(OBJECTS) $(libmlaugeas_a_OBJECTS) -cclib -laugeas -o mlaugeas + +# Dependencies. +.depend: $(srcdir)/*.mli $(srcdir)/*.ml + $(top_builddir)/ocaml-dep.sh $^ +-include .depend diff --git a/3rdparty/ocaml-augeas/augeas-c.c b/3rdparty/ocaml-augeas/augeas-c.c new file mode 100644 index 000000000..679bcb50b --- /dev/null +++ b/3rdparty/ocaml-augeas/augeas-c.c @@ -0,0 +1,579 @@ +/* Augeas OCaml bindings + * Copyright (C) 2008-2017 Red Hat Inc., Richard W.M. Jones + * + * 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 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 + * + * $Id: augeas_c.c,v 1.1 2008/05/06 10:48:20 rjones Exp $ + */ + +#include "config.h" + +#include <augeas.h> + +#include <caml/alloc.h> +#include <caml/memory.h> +#include <caml/mlvalues.h> +#include <caml/fail.h> +#include <caml/callback.h> +#include <caml/custom.h> + +#include <stdbool.h> + +#ifdef __GNUC__ + #define NORETURN __attribute__ ((noreturn)) +#else + #define NORETURN +#endif + +extern CAMLprim value ocaml_augeas_create (value rootv, value loadpathv, value flagsv); +extern CAMLprim value ocaml_augeas_close (value tv); +extern CAMLprim value ocaml_augeas_defnode (value tv, value namev, value exprv, value valv); +extern CAMLprim value ocaml_augeas_defvar (value tv, value namev, value exprv); +extern CAMLprim value ocaml_augeas_get (value tv, value pathv); +extern CAMLprim value ocaml_augeas_exists (value tv, value pathv); +extern CAMLprim value ocaml_augeas_insert (value tv, value beforev, value pathv, value labelv); +extern CAMLprim value ocaml_augeas_label (value tv, value pathv); +extern CAMLprim value ocaml_augeas_mv (value tv, value srcv, value destv); +extern CAMLprim value ocaml_augeas_rm (value tv, value pathv); +extern CAMLprim value ocaml_augeas_match (value tv, value pathv); +extern CAMLprim value ocaml_augeas_count_matches (value tv, value pathv); +extern CAMLprim value ocaml_augeas_save (value tv); +extern CAMLprim value ocaml_augeas_load (value tv); +extern CAMLprim value ocaml_augeas_set (value tv, value pathv, value valuev); +extern CAMLprim value ocaml_augeas_setm (value tv, value basev, value subv, value valv); +extern CAMLprim value ocaml_augeas_transform (value tv, value lensv, value filev, value modev); +extern CAMLprim value ocaml_augeas_source (value tv, value pathv) +#ifndef HAVE_AUG_SOURCE + NORETURN +#endif +; + +typedef augeas *augeas_t; + +/* Map C aug_errcode_t to OCaml error_code. */ +static const int error_map[] = { + /* AugErrInternal */ AUG_EINTERNAL, + /* AugErrPathX */ AUG_EPATHX, + /* AugErrNoMatch */ AUG_ENOMATCH, + /* AugErrMMatch */ AUG_EMMATCH, + /* AugErrSyntax */ AUG_ESYNTAX, + /* AugErrNoLens */ AUG_ENOLENS, + /* AugErrMXfm */ AUG_EMXFM, + /* AugErrNoSpan */ AUG_ENOSPAN, + /* AugErrMvDesc */ AUG_EMVDESC, + /* AugErrCmdRun */ AUG_ECMDRUN, + /* AugErrBadArg */ AUG_EBADARG, + /* AugErrLabel */ AUG_ELABEL, + /* AugErrCpDesc */ AUG_ECPDESC, +}; +static const int error_map_len = sizeof error_map / sizeof error_map[0]; + +/* Raise an Augeas.Error exception, and optionally close the + * specified handle. + */ +static void +raise_error_and_maybe_close (augeas_t t, const char *msg, bool close_handle) +{ + const value *exn = caml_named_value ("Augeas.Error"); + value args[5]; + const int code = aug_error (t); + const char *aug_err_msg; + const char *aug_err_minor; + const char *aug_err_details; + int ocaml_code = -1; + int i; + + if (code == AUG_ENOMEM) { + if (close_handle) + aug_close (t); + caml_raise_out_of_memory (); + } + + aug_err_msg = aug_error_message (t); + aug_err_minor = aug_error_minor_message (t); + aug_err_details = aug_error_details (t); + + for (i = 0; i < error_map_len; ++i) + if (error_map[i] == code) { + ocaml_code = i; + break; + } + + if (ocaml_code != -1) + args[0] = Val_int (ocaml_code); + else { + args[0] = caml_alloc (1, 0); + Store_field (args[0], 0, Val_int (code)); + } + args[1] = caml_copy_string (msg); + args[2] = caml_copy_string (aug_err_msg); + args[3] = caml_copy_string (aug_err_minor ? : ""); + args[4] = caml_copy_string (aug_err_details ? : ""); + + if (close_handle) + aug_close (t); + + caml_raise_with_args (*exn, 5, args); +} +#define raise_error(t, msg) raise_error_and_maybe_close(t, msg, false) + +static void +raise_init_error (const char *msg) +{ + const value *exn = caml_named_value ("Augeas.Error"); + value args[5]; + + args[0] = caml_alloc (1, 0); + Store_field (args[0], 0, Val_int (-1)); + args[1] = caml_copy_string (msg); + args[2] = caml_copy_string ("aug_init failed"); + args[3] = caml_copy_string ("augeas initialization failed"); + args[4] = caml_copy_string (""); + + caml_raise_with_args (*exn, 5, args); +} + +static const char * +Optstring_val (value strv) +{ + if (strv == Val_int (0)) /* None */ + return NULL; + else /* Some string */ + return String_val (Field (strv, 0)); +} + +/* Map OCaml flags to C flags. */ +static const int flag_map[] = { + /* AugSaveBackup */ AUG_SAVE_BACKUP, + /* AugSaveNewFile */ AUG_SAVE_NEWFILE, + /* AugTypeCheck */ AUG_TYPE_CHECK, + /* AugNoStdinc */ AUG_NO_STDINC, + /* AugSaveNoop */ AUG_SAVE_NOOP, + /* AugNoLoad */ AUG_NO_LOAD, + /* AugNoModlAutoload */ AUG_NO_MODL_AUTOLOAD, + /* AugEnableSpan */ AUG_ENABLE_SPAN, + /* AugNoErrClose */ AUG_NO_ERR_CLOSE, + /* AugTraceModuleLoading */ AUG_TRACE_MODULE_LOADING, +}; + +/* Wrap and unwrap augeas_t handles, with a finalizer. */ +#define Augeas_t_val(rv) (*(augeas_t *)Data_custom_val(rv)) + +static void +augeas_t_finalize (value tv) +{ + augeas_t t = Augeas_t_val (tv); + if (t) aug_close (t); +} + +static struct custom_operations custom_operations = { + (char *) "augeas_t_custom_operations", + augeas_t_finalize, + custom_compare_default, + custom_hash_default, + custom_serialize_default, + custom_deserialize_default, + custom_compare_ext_default, +}; + +static value Val_augeas_t (augeas_t t) +{ + CAMLparam0 (); + CAMLlocal1 (rv); + /* We could choose these so that the GC can make better decisions. + * See 18.9.2 of the OCaml manual. + */ + const int used = 0; + const int max = 1; + + rv = caml_alloc_custom (&custom_operations, + sizeof (augeas_t), used, max); + Augeas_t_val(rv) = t; + + CAMLreturn (rv); +} + +#pragma GCC diagnostic ignored "-Wmissing-prototypes" + +/* val create : string -> string option -> flag list -> t */ +CAMLprim value +ocaml_augeas_create (value rootv, value loadpathv, value flagsv) +{ + CAMLparam1 (rootv); + const char *root = String_val (rootv); + const char *loadpath = Optstring_val (loadpathv); + int flags = 0, i; + augeas_t t; + + /* Convert list of flags to C. */ + for (; flagsv != Val_int (0); flagsv = Field (flagsv, 1)) { + i = Int_val (Field (flagsv, 0)); + flags |= flag_map[i]; + } + + /* Pass AUG_NO_ERR_CLOSE so we raise a detailed Augeas.Error. */ + t = aug_init (root, loadpath, flags | AUG_NO_ERR_CLOSE); + + if (t == NULL) + raise_init_error ("Augeas.create"); + + if (aug_error (t) != AUG_NOERROR) { + raise_error_and_maybe_close (t, "Augeas.init", true); + } + + CAMLreturn (Val_augeas_t (t)); +} + +/* val close : t -> unit */ +CAMLprim value +ocaml_augeas_close (value tv) +{ + CAMLparam1 (tv); + augeas_t t = Augeas_t_val (tv); + + if (t) { + aug_close (t); + Augeas_t_val(tv) = NULL; /* So the finalizer doesn't double-free. */ + } + + CAMLreturn (Val_unit); +} + +/* val defnode : t -> string -> string -> string option -> int * bool */ +CAMLprim value +ocaml_augeas_defnode (value tv, value namev, value exprv, value valv) +{ + CAMLparam4 (tv, namev, exprv, valv); + CAMLlocal2 (optv, v); + augeas_t t = Augeas_t_val (tv); + const char *name = String_val (namev); + const char *expr = String_val (exprv); + const char *val = Optstring_val (valv); + int r, created; + + r = aug_defnode (t, name, expr, val, &created); + if (r == -1) { + raise_error (t, "Augeas.defnode"); + } + + v = caml_alloc (2, 0); + Store_field (v, 0, Val_int (r)); + Store_field (v, 1, Val_bool (created)); + + CAMLreturn (v); +} + +/* val defvar : t -> string -> string option -> int option */ +CAMLprim value +ocaml_augeas_defvar (value tv, value namev, value exprv) +{ + CAMLparam3 (tv, namev, exprv); + CAMLlocal2 (optv, v); + augeas_t t = Augeas_t_val (tv); + const char *name = String_val (namev); + const char *expr = Optstring_val (exprv); + int r; + + r = aug_defvar (t, name, expr); + if (r > 0) { /* Return Some val */ + v = Val_int (r); + optv = caml_alloc (1, 0); + Field (optv, 0) = v; + } else if (r == 0) /* Return None */ + optv = Val_int (0); + else if (r == -1) /* Error or multiple matches */ + raise_error (t, "Augeas.defvar"); + else + caml_failwith ("Augeas.defvar: bad return value"); + + CAMLreturn (optv); +} + +/* val get : t -> path -> value option */ +CAMLprim value +ocaml_augeas_get (value tv, value pathv) +{ + CAMLparam2 (tv, pathv); + CAMLlocal2 (optv, v); + augeas_t t = Augeas_t_val (tv); + const char *path = String_val (pathv); + const char *val; + int r; + + r = aug_get (t, path, &val); + if (r == 1 && val) { /* Return Some val */ + v = caml_copy_string (val); + optv = caml_alloc (1, 0); + Field (optv, 0) = v; + } else if (r == 0 || !val) /* Return None */ + optv = Val_int (0); + else if (r == -1) /* Error or multiple matches */ + raise_error (t, "Augeas.get"); + else + caml_failwith ("Augeas.get: bad return value"); + + CAMLreturn (optv); +} + +/* val exists : t -> path -> bool */ +CAMLprim value +ocaml_augeas_exists (value tv, value pathv) +{ + CAMLparam2 (tv, pathv); + CAMLlocal1 (v); + augeas_t t = Augeas_t_val (tv); + const char *path = String_val (pathv); + int r; + + r = aug_get (t, path, NULL); + if (r == 1) /* Return true. */ + v = Val_int (1); + else if (r == 0) /* Return false */ + v = Val_int (0); + else if (r == -1) /* Error or multiple matches */ + raise_error (t, "Augeas.exists"); + else + caml_failwith ("Augeas.exists: bad return value"); + + CAMLreturn (v); +} + +/* val insert : t -> ?before:bool -> path -> string -> unit */ +CAMLprim value +ocaml_augeas_insert (value tv, value beforev, value pathv, value labelv) +{ + CAMLparam4 (tv, beforev, pathv, labelv); + augeas_t t = Augeas_t_val (tv); + const char *path = String_val (pathv); + const char *label = String_val (labelv); + int before; + + before = beforev == Val_int (0) ? 0 : Int_val (Field (beforev, 0)); + + if (aug_insert (t, path, label, before) == -1) + raise_error (t, "Augeas.insert"); + + CAMLreturn (Val_unit); +} + +/* val label : t -> path -> string option */ +CAMLprim value +ocaml_augeas_label (value tv, value pathv) +{ + CAMLparam2 (tv, pathv); + CAMLlocal2 (optv, v); + augeas_t t = Augeas_t_val (tv); + const char *path = String_val (pathv); + const char *val; + int r; + + r = aug_label (t, path, &val); + if (r == 1 && val) { /* Return Some val */ + v = caml_copy_string (val); + optv = caml_alloc (1, 0); + Field (optv, 0) = v; + } else if (r == 0 || !val) /* Return None */ + optv = Val_int (0); + else if (r == -1) /* Error or multiple matches */ + raise_error (t, "Augeas.label"); + else + caml_failwith ("Augeas.label: bad return value"); + + CAMLreturn (optv); +} + +/* val mv : t -> path -> path -> unit */ +CAMLprim value +ocaml_augeas_mv (value tv, value srcv, value destv) +{ + CAMLparam3 (tv, srcv, destv); + augeas_t t = Augeas_t_val (tv); + const char *src = String_val (srcv); + const char *dest = String_val (destv); + + if (aug_mv (t, src, dest) == -1) + raise_error (t, "Augeas.mv"); + + CAMLreturn (Val_unit); +} + +/* val rm : t -> path -> int */ +CAMLprim value +ocaml_augeas_rm (value tv, value pathv) +{ + CAMLparam2 (tv, pathv); + augeas_t t = Augeas_t_val (tv); + const char *path = String_val (pathv); + int r; + + r = aug_rm (t, path); + if (r == -1) + raise_error (t, "Augeas.rm"); + + CAMLreturn (Val_int (r)); +} + +/* val matches : t -> path -> path list */ +CAMLprim value +ocaml_augeas_match (value tv, value pathv) +{ + CAMLparam2 (tv, pathv); + CAMLlocal3 (rv, v, cons); + augeas_t t = Augeas_t_val (tv); + const char *path = String_val (pathv); + char **matches; + int r, i; + + r = aug_match (t, path, &matches); + if (r == -1) + raise_error (t, "Augeas.matches"); + + /* Copy the paths to a list. */ + rv = Val_int (0); + for (i = 0; i < r; ++i) { + v = caml_copy_string (matches[i]); + free (matches[i]); + cons = caml_alloc (2, 0); + Field (cons, 1) = rv; + Field (cons, 0) = v; + rv = cons; + } + + free (matches); + + CAMLreturn (rv); +} + +/* val count_matches : t -> path -> int */ +CAMLprim value +ocaml_augeas_count_matches (value tv, value pathv) +{ + CAMLparam2 (tv, pathv); + augeas_t t = Augeas_t_val (tv); + const char *path = String_val (pathv); + int r; + + r = aug_match (t, path, NULL); + if (r == -1) + raise_error (t, "Augeas.count_matches"); + + CAMLreturn (Val_int (r)); +} + +/* val save : t -> unit */ +CAMLprim value +ocaml_augeas_save (value tv) +{ + CAMLparam1 (tv); + augeas_t t = Augeas_t_val (tv); + + if (aug_save (t) == -1) + raise_error (t, "Augeas.save"); + + CAMLreturn (Val_unit); +} + +/* val load : t -> unit */ +CAMLprim value +ocaml_augeas_load (value tv) +{ + CAMLparam1 (tv); + augeas_t t = Augeas_t_val (tv); + + if (aug_load (t) == -1) + raise_error (t, "Augeas.load"); + + CAMLreturn (Val_unit); +} + +/* val set : t -> -> path -> value option -> unit */ +CAMLprim value +ocaml_augeas_set (value tv, value pathv, value valuev) +{ + CAMLparam3 (tv, pathv, valuev); + augeas_t t = Augeas_t_val (tv); + const char *path = String_val (pathv); + const char *val = Optstring_val (valuev); + + if (aug_set (t, path, val) == -1) + raise_error (t, "Augeas.set"); + + CAMLreturn (Val_unit); +} + +/* val setm : t -> path -> string option -> value option -> int */ +CAMLprim value +ocaml_augeas_setm (value tv, value basev, value subv, value valv) +{ + CAMLparam4 (tv, basev, subv, valv); + augeas_t t = Augeas_t_val (tv); + const char *base = String_val (basev); + const char *sub = Optstring_val (subv); + const char *val = Optstring_val (valv); + int r; + + r = aug_setm (t, base, sub, val); + if (r == -1) + raise_error (t, "Augeas.setm"); + + CAMLreturn (Val_int (r)); +} + +/* val transform : t -> string -> string -> transform_mode -> unit */ +CAMLprim value +ocaml_augeas_transform (value tv, value lensv, value filev, value modev) +{ + CAMLparam4 (tv, lensv, filev, modev); + augeas_t t = Augeas_t_val (tv); + const char *lens = String_val (lensv); + const char *file = String_val (filev); + const int excl = Int_val (modev) == 1 ? 1 : 0; + + if (aug_transform (t, lens, file, excl) == -1) + raise_error (t, "Augeas.transform"); + + CAMLreturn (Val_unit); +} + +/* val source : t -> path -> path option */ +CAMLprim value +ocaml_augeas_source (value tv, value pathv) +{ +#ifdef HAVE_AUG_SOURCE + CAMLparam2 (tv, pathv); + CAMLlocal2 (optv, v); + augeas_t t = Augeas_t_val (tv); + const char *path = String_val (pathv); + char *file_path; + int r; + + r = aug_source (t, path, &file_path); + if (r == 0) { + if (file_path) { /* Return Some file_path */ + v = caml_copy_string (file_path); + optv = caml_alloc (1, 0); + Field (optv, 0) = v; + free (file_path); + } else /* Return None */ + optv = Val_int (0); + } + else /* Error */ + raise_error (t, "Augeas.source"); + + CAMLreturn (optv); +#else + caml_failwith ("Augeas.source: function not implemented"); +#endif +} diff --git a/3rdparty/ocaml-augeas/augeas.README b/3rdparty/ocaml-augeas/augeas.README new file mode 100644 index 000000000..938dfd255 --- /dev/null +++ b/3rdparty/ocaml-augeas/augeas.README @@ -0,0 +1,8 @@ +The files augeas-c.c, augeas.ml and augeas.mli come from the +ocaml-augeas library: + + http://git.annexia.org/?p=ocaml-augeas.git + +which is released under a compatible license. We try to keep them +identical, so if you make changes to these files then you must also +submit the changes to ocaml-augeas, and vice versa. \ No newline at end of file diff --git a/3rdparty/ocaml-augeas/augeas.ml b/3rdparty/ocaml-augeas/augeas.ml new file mode 100644 index 000000000..aa5a18226 --- /dev/null +++ b/3rdparty/ocaml-augeas/augeas.ml @@ -0,0 +1,99 @@ +(* Augeas OCaml bindings + * Copyright (C) 2008 Red Hat Inc., Richard W.M. Jones + * + * 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 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 + * + * $Id: augeas.ml,v 1.2 2008/05/06 10:48:20 rjones Exp $ + *) + +type t + +type flag + | AugSaveBackup + | AugSaveNewFile + | AugTypeCheck + | AugNoStdinc + | AugSaveNoop + | AugNoLoad + | AugNoModlAutoload + | AugEnableSpan + | AugNoErrClose + | AugTraceModuleLoading + +type error_code + | AugErrInternal + | AugErrPathX + | AugErrNoMatch + | AugErrMMatch + | AugErrSyntax + | AugErrNoLens + | AugErrMXfm + | AugErrNoSpan + | AugErrMvDesc + | AugErrCmdRun + | AugErrBadArg + | AugErrLabel + | AugErrCpDesc + | AugErrUnknown of int + +type transform_mode + | Include + | Exclude + +exception Error of error_code * string * string * string * string + +type path = string + +type value = string + +external create : string -> string option -> flag list -> t + = "ocaml_augeas_create" +external close : t -> unit + = "ocaml_augeas_close" +external defnode : t -> string -> string -> string option -> int * bool + = "ocaml_augeas_defnode" +external defvar : t -> string -> string option -> int option + = "ocaml_augeas_defvar" +external get : t -> path -> value option + = "ocaml_augeas_get" +external exists : t -> path -> bool + = "ocaml_augeas_exists" +external insert : t -> ?before:bool -> path -> string -> unit + = "ocaml_augeas_insert" +external label : t -> path -> string option + = "ocaml_augeas_label" +external rm : t -> path -> int + = "ocaml_augeas_rm" +external matches : t -> path -> path list + = "ocaml_augeas_match" +external count_matches : t -> path -> int + = "ocaml_augeas_count_matches" +external save : t -> unit + = "ocaml_augeas_save" +external load : t -> unit + = "ocaml_augeas_load" +external mv : t -> path -> path -> unit + = "ocaml_augeas_mv" +external set : t -> path -> value option -> unit + = "ocaml_augeas_set" +external setm : t -> path -> string option -> value option -> int + = "ocaml_augeas_setm" +external transform : t -> string -> string -> transform_mode -> unit + = "ocaml_augeas_transform" +external source : t -> path -> path option + = "ocaml_augeas_source" + +let () + Callback.register_exception "Augeas.Error" (Error (AugErrInternal, "", "", "", "")) diff --git a/3rdparty/ocaml-augeas/augeas.mli b/3rdparty/ocaml-augeas/augeas.mli new file mode 100644 index 000000000..8cbeae188 --- /dev/null +++ b/3rdparty/ocaml-augeas/augeas.mli @@ -0,0 +1,164 @@ +(** Augeas OCaml bindings *) +(* Copyright (C) 2008 Red Hat Inc., Richard W.M. Jones + * + * 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 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 + * + * $Id: augeas.mli,v 1.2 2008/05/06 10:48:20 rjones Exp $ + *) + +type t + (** Augeas library handle. *) + +type flag + | AugSaveBackup (** Rename original with .augsave *) + | AugSaveNewFile (** Save changes to .augnew *) + | AugTypeCheck (** Type-check lenses *) + | AugNoStdinc + | AugSaveNoop + | AugNoLoad + | AugNoModlAutoload + | AugEnableSpan + | AugNoErrClose + | AugTraceModuleLoading + (** Flags passed to the {!create} function. *) + +type error_code + | AugErrInternal (** Internal error (bug) *) + | AugErrPathX (** Invalid path expression *) + | AugErrNoMatch (** No match for path expression *) + | AugErrMMatch (** Too many matches for path expression *) + | AugErrSyntax (** Syntax error in lens file *) + | AugErrNoLens (** Lens lookup failed *) + | AugErrMXfm (** Multiple transforms *) + | AugErrNoSpan (** No span for this node *) + | AugErrMvDesc (** Cannot move node into its descendant *) + | AugErrCmdRun (** Failed to execute command *) + | AugErrBadArg (** Invalid argument in funcion call *) + | AugErrLabel (** Invalid label *) + | AugErrCpDesc (** Cannot copy node into its descendant *) + | AugErrUnknown of int + (** Possible error codes. *) + +type transform_mode + | Include + | Exclude + (** The operation mode for the {!transform} function. *) + +exception Error of error_code * string * string * string * string + (** This exception is thrown when the underlying Augeas library + returns an error. The tuple represents: + - the Augeas error code + - the ocaml-augeas error string + - the Augeas error message + - the human-readable explanation of the Augeas error, if available + - a string with details of the Augeas error + *) + +type path = string + (** A path expression. + + Note in future we may replace this with a type-safe path constructor. *) + +type value = string + (** A value. *) + +val create : string -> string option -> flag list -> t + (** [create root loadpath flags] creates an Augeas handle. + + [root] is a file system path describing the location + of the configuration files. + + [loadpath] is an optional colon-separated list of directories + which are searched for schema definitions. + + [flags] is a list of flags. *) + +val close : t -> unit + (** [close handle] closes the handle. + + You don't need to close handles explicitly with this function: + they will be finalized eventually by the garbage collector. + However calling this function frees up any resources used by the + underlying Augeas library immediately. + + Do not use the handle after closing it. *) + +val defnode : t -> string -> string -> string option -> int * bool + (** [defnode t name expr value] defines [name] whose value is the + result of evaluating [expr], which is a nodeset. *) + +val defvar : t -> string -> string option -> int option + (** [defvar t name expr] defines [name] whose value is the result + of evaluating [expr], replacing the old value if existing. + [None] as [expr] removes the variable [name]. *) + +val get : t -> path -> value option + (** [get t path] returns the value at [path], or [None] if there + is no value. *) + +val exists : t -> path -> bool + (** [exists t path] returns true iff there is a value at [path]. *) + +val insert : t -> ?before:bool -> path -> string -> unit + (** [insert t ?before path label] inserts [label] as a sibling + of [path]. By default it is inserted after [path], unless + [~before:true] is specified. *) + +val label : t -> path -> string option + (** [label t path] gets the label of [path]. + + Returns [Some value] when [path] matches only one node, and + that has an associated label. *) + +val rm : t -> path -> int + (** [rm t path] removes all nodes matching [path]. + + Returns the number of nodes removed (which may be 0). *) + +val matches : t -> path -> path list + (** [matches t path] returns a list of path expressions + of all nodes matching [path]. *) + +val mv : t -> path -> path -> unit + (** [mv t src dest] moves a node. *) + +val count_matches : t -> path -> int + (** [count_matches t path] counts the number of nodes matching + [path] but does not return them (see {!matches}). *) + +val save : t -> unit + (** [save t] saves all pending changes to disk. *) + +val load : t -> unit + (** [load t] loads files into the tree. *) + +val set : t -> path -> value option -> unit + (** [set t path] sets [value] as new value at [path]. *) + +val setm : t -> path -> string option -> value option -> int + (** [setm t base sub value] sets [value] as new value for all the + nodes under [base] that match [sub] (or all, if [sub] is + [None]). + + Returns the number of nodes modified. *) + +val transform : t -> string -> string -> transform_mode -> unit + (** [transform t lens file mode] adds or removes (depending on + [mode]) the transformation of the specified [lens] for [file]. *) + +val source : t -> path -> path option + (** [source t path] returns the path to the node representing the + file to which [path] belongs, or [None] if [path] does not + represent any file. *) -- 2.23.0
Pino Toscano
2019-Dec-16 15:57 UTC
[Libguestfs] [PATCH 2/2] build: switch embedded copy of ocaml-augeas
Use the newer copy shipped locally as 3rdparty, instead of the one in the common submodule, as the latter copy will go away soon. --- .gitignore | 1 + Makefile.am | 6 +++--- configure.ac | 2 +- daemon/Makefile.am | 4 ++-- docs/guestfs-hacking.pod | 19 ++++++++++++++----- ocaml-dep.sh.in | 2 +- 6 files changed, 22 insertions(+), 12 deletions(-) diff --git a/.gitignore b/.gitignore index 8dfd2895c..3409782af 100644 --- a/.gitignore +++ b/.gitignore @@ -34,6 +34,7 @@ Makefile.in /.sc-* +/3rdparty/ocaml-augeas/.depend /aclocal.m4 /align/stamp-virt-alignment-scan.pod /align/virt-alignment-scan diff --git a/Makefile.am b/Makefile.am index 65106369e..0c52806bd 100644 --- a/Makefile.am +++ b/Makefile.am @@ -45,7 +45,7 @@ SUBDIRS += lib docs examples # The daemon and the appliance. SUBDIRS += common/mlutils -SUBDIRS += common/mlaugeas +SUBDIRS += 3rdparty/ocaml-augeas SUBDIRS += common/mlpcre if ENABLE_DAEMON SUBDIRS += daemon @@ -316,7 +316,7 @@ ChangeLog: configure.ac docs/C_SOURCE_FILES: configure.ac rm -f $@ $@-t find $(DIST_SUBDIRS) -name '*.[ch]' | \ - grep -v -E '^(builder/index-parse\.|builder/index-scan\.|common/mllibvirt/libvirt_c\.c|examples/|gnulib/|gobject/|java/com_redhat_et_libguestfs|perl/|php/extension/config\.h|ruby/ext/guestfs/extconf\.h|tests/|test-data/)' | \ + grep -v -E '^(builder/index-parse\.|builder/index-scan\.|common/mllibvirt/libvirt_c\.c|examples/|gnulib/|gobject/|java/com_redhat_et_libguestfs|perl/|php/extension/config\.h|ruby/ext/guestfs/extconf\.h|tests/|test-data/|3rdparty/)' | \ grep -v -E '/(guestfs|rc)_protocol\.' | \ grep -v -E '.*/errnostring\.' | \ grep -v -E '.*-gperf\.' | \ @@ -328,7 +328,7 @@ po/POTFILES: configure.ac rm -f $@ $@-t cd $(srcdir); \ find $(DIST_SUBDIRS) -name '*.c' -o -name '*.pl' -o -name '*.pm' | \ - grep -v -E '^(examples|gnulib|perl/(blib|examples)|po-docs|tests|test-data)/' | \ + grep -v -E '^(examples|gnulib|perl/(blib|examples)|po-docs|tests|test-data|3rdparty)/' | \ grep -v -E '/((guestfs|rc)_protocol\.c)$$' | \ grep -v -E '^python/utils\.c$$' | \ grep -v -E '^perl/lib/Sys/Guestfs\.c$$' | \ diff --git a/configure.ac b/configure.ac index 64f352323..e72c46709 100644 --- a/configure.ac +++ b/configure.ac @@ -213,6 +213,7 @@ AC_CONFIG_FILES([run], [chmod +x,-w run]) AC_CONFIG_FILES([Makefile + 3rdparty/ocaml-augeas/Makefile align/Makefile appliance/Makefile bash/Makefile @@ -226,7 +227,6 @@ AC_CONFIG_FILES([Makefile cat/Makefile common/errnostring/Makefile common/edit/Makefile - common/mlaugeas/Makefile common/mlcustomize/Makefile common/mlgettext/Makefile common/mlpcre/Makefile diff --git a/daemon/Makefile.am b/daemon/Makefile.am index 20440aaee..f6852fcb5 100644 --- a/daemon/Makefile.am +++ b/daemon/Makefile.am @@ -214,7 +214,7 @@ guestfsd_LDFLAGS = \ -L$(shell $(OCAMLC) -where)/hivex \ -L../common/mlutils \ -L../common/mlstdutils \ - -L../common/mlaugeas \ + -L../3rdparty/ocaml-augeas \ -L../common/mlpcre guestfsd_LDADD = \ ../common/errnostring/liberrnostring.la \ @@ -341,7 +341,7 @@ XOBJECTS = $(BOBJECTS:.cmo=.cmx) OCAMLPACKAGES = \ -package str,unix,hivex \ - -I $(top_builddir)/common/mlaugeas \ + -I $(top_builddir)/3rdparty/ocaml-augeas \ -I $(top_builddir)/common/mlstdutils \ -I $(top_builddir)/common/mlutils \ -I $(top_builddir)/common/utils/.libs \ diff --git a/docs/guestfs-hacking.pod b/docs/guestfs-hacking.pod index 9ee448d57..26874384f 100644 --- a/docs/guestfs-hacking.pod +++ b/docs/guestfs-hacking.pod @@ -51,6 +51,20 @@ then you may find files which appear to be missing. =over 4 +=item F<3rdparty> + +Embedded copies of other libraries, mostly for convenience (and the embedded +library is not widespread enough). + +=over 4 + +=item F<3rdparty/ocaml-augeas> + +Bindings for the Augeas library. These come from the ocaml-augeas +library L<http://git.annexia.org/?p=ocaml-augeas.git> + +=back + =item F<align> L<virt-alignment-scan(1)> command and documentation. @@ -94,11 +108,6 @@ The communication protocol used between the library and the daemon running inside the appliance has to encode errnos as strings, which is handled by this library. -=item F<common/mlaugeas> - -Bindings for the Augeas library. These come from the ocaml-augeas -library L<http://git.annexia.org/?p=ocaml-augeas.git> - =item F<common/mlcustomize> Library code associated with C<virt-customize> but also used in other diff --git a/ocaml-dep.sh.in b/ocaml-dep.sh.in index 9de8497fd..a68631fff 100755 --- a/ocaml-dep.sh.in +++ b/ocaml-dep.sh.in @@ -33,7 +33,7 @@ set -e # directories must have unique names (eg. not ‘Utils’) else # dependencies don't get built right. include_dirs=" -common/mlaugeas +3rdparty/ocaml-augeas common/mlgettext common/mlpcre common/mlprogress -- 2.23.0
Richard W.M. Jones
2019-Dec-16 16:42 UTC
Re: [Libguestfs] [PATCH 0/2] Move ocaml-augeas copy to libguestfs repo
On Mon, Dec 16, 2019 at 04:57:32PM +0100, Pino Toscano wrote:> ocaml-augeas is used only by virtlibguestfs, so move it to this"by libguestfs"?> repository, instead of having it around in the common submodule. > > The removal from common will happen later. > > Pino Toscano (2): > Bundle the ocaml-augeas library for use by libguestfs > build: switch embedded copy of ocaml-augeas > > .gitignore | 1 + > 3rdparty/ocaml-augeas/COPYING.LIB | 515 +++++++++++++++++++++++++ > 3rdparty/ocaml-augeas/Makefile.am | 82 ++++ > 3rdparty/ocaml-augeas/augeas-c.c | 579 ++++++++++++++++++++++++++++ > 3rdparty/ocaml-augeas/augeas.README | 8 + > 3rdparty/ocaml-augeas/augeas.ml | 99 +++++ > 3rdparty/ocaml-augeas/augeas.mli | 164 ++++++++ > Makefile.am | 6 +- > configure.ac | 2 +- > daemon/Makefile.am | 4 +- > docs/guestfs-hacking.pod | 19 +- > ocaml-dep.sh.in | 2 +- > 12 files changed, 1469 insertions(+), 12 deletions(-) > create mode 100644 3rdparty/ocaml-augeas/COPYING.LIB > create mode 100644 3rdparty/ocaml-augeas/Makefile.am > create mode 100644 3rdparty/ocaml-augeas/augeas-c.c > create mode 100644 3rdparty/ocaml-augeas/augeas.README > create mode 100644 3rdparty/ocaml-augeas/augeas.ml > create mode 100644 3rdparty/ocaml-augeas/augeas.mli > > -- > 2.23.0 > > _______________________________________________ > Libguestfs mailing list > Libguestfs@redhat.com > https://www.redhat.com/mailman/listinfo/libguestfs-- Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~rjones Read my programming and virtualization blog: http://rwmj.wordpress.com virt-builder quickly builds VMs from scratch http://libguestfs.org/virt-builder.1.html
Richard W.M. Jones
2019-Dec-16 16:43 UTC
Re: [Libguestfs] [PATCH 2/2] build: switch embedded copy of ocaml-augeas
Sorry my previous email was about the cover letter ... Yes, it's all good, ACK series. Rich. -- Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~rjones Read my programming and virtualization blog: http://rwmj.wordpress.com virt-builder quickly builds VMs from scratch http://libguestfs.org/virt-builder.1.html
Possibly Parallel Threads
- [PATCH 0/5] RFC: switch augeas APIs to OCaml
- [PATCH] UNFINISHED daemon: Reimplement most inspection APIs in the daemon.
- [v2v PATCH 0/2] Move libvirt-ocaml copy to v2v repo
- [PATCH v10 00/10] Reimplement inspection in the daemon.
- [PATCH v9 00/11] Reimplement inspection in the daemon.