augeas (empty) → 0.1
raw patch · 5 files changed
+1576/−0 lines, 5 filesdep +HUnitdep +basedep +bytestringbuild-type:Customsetup-changed
Dependencies added: HUnit, base, bytestring, haskell98, unix
Files
- HUnitAug.hs +324/−0
- LICENSE +674/−0
- Setup.hs +55/−0
- System/Augeas.hs +499/−0
- augeas.cabal +24/−0
+ HUnitAug.hs view
@@ -0,0 +1,324 @@+-- file: HUnitAug.hs++-- Haskell bindings for the Augeas library+-- Copyright (c) 2009, Jude Nagurney+--+-- 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., 59 Temple Place, Suite 330, Boston,+-- MA 02111-1307 USA+--+-- Contact the author at+-- jude@pwan.org++module Main where++import Test.HUnit+import System.Augeas+-- import AugeasHsc+import Data.ByteString.Char8++import Foreign+import Foreign.ForeignPtr++import Directory+import Data.List (isInfixOf)+import IO++-- constants+bs_BadPath = (Data.ByteString.Char8.pack "/files/bad/path")++-- testBadRoot :: Test+-- testBadRoot = TestCase (do+-- aug_ptr <- aug_init (Data.ByteString.Char8.pack "./bad_testroot") empty []+-- assertEqual "Should get Nothing after a bad root" Nothing aug_ptr)++with_augptr func = do cwd <- getCurrentDirectory+ maybe_aug_ptr <- aug_init (Data.ByteString.Char8.pack (cwd++"/testroot")) empty [save_newfile]+ case maybe_aug_ptr of+ Nothing -> assertFailure "aug_ptr shouldn't be nothing in with_augptr"+ Just aug_fp -> (withForeignPtr aug_fp $ \aug_ptr -> func aug_ptr)++-- -------------+-- aug_get tests+-- -------------++testGetBadPath :: Test+testGetBadPath = TestCase ( with_augptr $ \aug_ptr -> do+ ret_get <- aug_get aug_ptr bs_BadPath+ assertEqual "Bad path in get" (Left no_match) ret_get+ )++testGetPartialPath :: Test+testGetPartialPath = TestCase ( with_augptr $ \aug_ptr -> do+ ret_get <- aug_get aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts")+ assertEqual "Partial path returns none" (Right Nothing) ret_get+ )++testGetStillPartialPath :: Test+testGetStillPartialPath = TestCase ( with_augptr $ \aug_ptr -> do+ ret_get <- aug_get aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1")+ assertEqual "Partial path returns none" (Right Nothing) ret_get+ )++testGetBadLabel :: Test+testGetBadLabel = TestCase ( with_augptr $ \aug_ptr -> do+ ret_get <- aug_get aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1/invalid")+ assertEqual "Bad label in get" (Left no_match) ret_get+ )++testGetGoodLabel :: Test+testGetGoodLabel = TestCase ( with_augptr $ \aug_ptr -> do+ ret_get <- aug_get aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1/canonical")+ assertEqual "Should have gotten localhost" (Right (Just "localhost")) ret_get+ )++testGetMultipleLabel :: Test+testGetMultipleLabel = TestCase ( with_augptr $ \aug_ptr -> do+ ret_get <- aug_get aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/*/canonical")+ assertEqual "Get should return a negative on multiple matches" (Left invalid_match) ret_get+ )++testGetBadMultipleLabel :: Test+testGetBadMultipleLabel = TestCase ( with_augptr $ \aug_ptr -> do+ ret_get <- aug_get aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/*/invalid")+ assertEqual "Get should return a negative on multiple matches" (Left invalid_match) ret_get+ )++-- -------------+-- aug_set tests+-- -------------++testSetLabel :: Test+testSetLabel = TestCase ( with_augptr $ \aug_ptr -> do+ ret_set <- aug_set aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/canonical") (Data.ByteString.Char8.pack "haskell-augeas.org")+ assertEqual "set OK" success ret_set+ ret_get <- aug_get aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/canonical")+ assertEqual "set OK" (Right (Just "haskell-augeas.org")) ret_get+ )++testSetMultiMatch :: Test+testSetMultiMatch = TestCase ( with_augptr $ \aug_ptr -> do+ ret_set <- aug_set aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/*/canonical") (Data.ByteString.Char8.pack "haskell-augeas.org")+ assertEqual "set OK" System.Augeas.error ret_set+ )++-- ----------------+-- aug_insert tests+-- ----------------+testInsertBadPath :: Test+testInsertBadPath = TestCase ( with_augptr $ \aug_ptr -> do+ ret_insert <- aug_insert aug_ptr bs_BadPath (Data.ByteString.Char8.pack "label") just_after+ assertEqual "Bad path in insert" System.Augeas.error ret_insert+ )++testInsertMultiMatch :: Test+testInsertMultiMatch = TestCase ( with_augptr $ \aug_ptr -> do+ ret_insert <- aug_insert aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/*/canonical") (Data.ByteString.Char8.pack "label") just_after+ assertEqual "No multimatches on insert" System.Augeas.error ret_insert+ )++testInsertBeforeAfter :: Test+testInsertBeforeAfter = TestCase ( with_augptr $ \aug_ptr -> do+ ret_set <- aug_set aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/canonical") (Data.ByteString.Char8.pack "haskell-augeas.org")+ assertEqual "set OK" success ret_set++ ret_insert <- aug_insert aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/canonical") (Data.ByteString.Char8.pack "after") just_after+ assertEqual "Insert after success" success ret_insert++ ret_insert <- aug_insert aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/canonical") (Data.ByteString.Char8.pack "before") just_before+ assertEqual "Insert before success" success ret_insert++ (match_count, (Just matches)) <- aug_match aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/*")+ assertEqual "Should be 3 matches" 3 match_count+ assertEqual "insert matches" ["/files/etc/hosts/1000/before","/files/etc/hosts/1000/canonical","/files/etc/hosts/1000/after"] matches+ )++-- ------------+-- aug_rm tests+-- ------------+testRmBadPath :: Test+testRmBadPath = TestCase ( with_augptr $ \aug_ptr -> do+ ret_rm <- aug_rm aug_ptr bs_BadPath+ assertEqual "Bad path in rm" 0 ret_rm+ )++testRmOne :: Test+testRmOne = TestCase ( with_augptr $ \aug_ptr -> do+ ret_set <- aug_set aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/canonical") (Data.ByteString.Char8.pack "haskell-augeas.org")+ assertEqual "set OK" success ret_set++ ret_rm <- aug_rm aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/canonical")+ assertEqual "rm 1" 1 ret_rm+ )++testRmTwo :: Test+testRmTwo = TestCase ( with_augptr $ \aug_ptr -> do+ ret_set <- aug_set aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/canonical") (Data.ByteString.Char8.pack "haskell-augeas.org")+ assertEqual "set success" success ret_set++ ret_insert <- aug_insert aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/canonical") (Data.ByteString.Char8.pack "after") just_after+ assertEqual "insert success" success ret_insert++ ret_rm <- aug_rm aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/*")+ assertEqual "rm 2" 2 ret_rm+ )++-- ------------+-- aug_mv tests+-- ------------+testMvBadSrc :: Test+testMvBadSrc = TestCase ( with_augptr $ \aug_ptr -> do+ ret_mv <- aug_mv aug_ptr bs_BadPath (Data.ByteString.Char8.pack "/files/etc/hosts/1/badpath")+ assertEqual "mv bad src" System.Augeas.error ret_mv+ )++testMvNewDest :: Test+testMvNewDest = TestCase ( with_augptr $ \aug_ptr -> do+ ret_set <- aug_set aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/canonical") (Data.ByteString.Char8.pack "haskell-augeas.org")+ assertEqual "set OK" success ret_set++ ret_mv <- aug_mv aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/canonical") (Data.ByteString.Char8.pack "/files/etc/hosts/1001/canonical")+ assertEqual "mv 1000-> 1001 OK" success ret_mv++ ret_get <- aug_get aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1001/canonical")+ assertEqual "get 1001 OK" (Right (Just "haskell-augeas.org")) ret_get++ ret_get <- aug_get aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/canonical")+ assertEqual "get 1000 OK" (Left no_match) ret_get+ )++-- ---------------+-- aug_match tests+-- ---------------+testMatchBadSrc :: Test+testMatchBadSrc = TestCase ( with_augptr $ \aug_ptr -> do+ (match_count, matches) <- aug_match aug_ptr bs_BadPath + assertEqual "match count bad src" 0 match_count+ assertEqual "matches bad src" (Just []) matches+ )++testMatchOne :: Test+testMatchOne = TestCase ( with_augptr $ \aug_ptr -> do+ (match_count, matches) <- aug_match aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1/canonical")+ assertEqual "match count good label" 1 match_count+ assertEqual "match good label" (Just ["/files/etc/hosts/1/canonical"]) matches+ )++testMatchMultiple :: Test+testMatchMultiple = TestCase ( with_augptr $ \aug_ptr -> do+ (match_count, matches) <- aug_match aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/*/canonical")+ assertEqual "match count good label" 9 match_count+ )+-- TODO: Test that forces -1 return value from aug_match++-- --------+-- aug_save+-- --------+testSave :: Test+testSave = TestCase ( with_augptr $ \aug_ptr -> do+ ret_save <- aug_save aug_ptr + assertEqual "save good" success ret_save+ )++testSaveNewLabel = TestCase ( with_augptr $ \aug_ptr -> do++ ret_set <- aug_set aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/ipaddr") (Data.ByteString.Char8.pack "192.168.1.234")+ assertEqual "set OK" success ret_set++ ret_set <- aug_set aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000/canonical") (Data.ByteString.Char8.pack "haskell-augeas.org")+ assertEqual "set OK" success ret_set++ ret_save <- aug_save aug_ptr + assertEqual "save good" success ret_save++ cwd <- getCurrentDirectory+ contents <- Prelude.readFile (cwd++"/testroot/etc/hosts.augnew")+ assertEqual "Check augnew" (Data.List.isInfixOf "192.168.1.234\thaskell-augeas.org" contents) True++ ret_rm <- aug_rm aug_ptr (Data.ByteString.Char8.pack "/files/etc/hosts/1000")+ assertEqual "Bad path in rm" 3 ret_rm++ ret_save <- aug_save aug_ptr + assertEqual "save good" success ret_save++ contents <- Prelude.readFile (cwd++"/testroot/etc/hosts.augnew")+ assertEqual "Check augnew" (Data.List.isInfixOf "192.168.1.234\thaskell-augeas.org" contents) False+ + )++-- ---------+-- aug_print+-- ---------+testPrint :: Test+testPrint = TestCase ( with_augptr $ \aug_ptr -> do + cwd <- getCurrentDirectory++ fptr_Output <- openFile (cwd++"/HUnitAug.txt") WriteMode+ ret_print <- aug_print aug_ptr fptr_Output (Data.ByteString.Char8.pack "/files/etc/hosts")+ IO.hPutStr fptr_Output "That's all folks"+ hFlush fptr_Output+ hClose fptr_Output+ + contents <- IO.readFile (cwd++"/HUnitAug.txt")+ assertEqual ("check aug_print") (Data.List.isInfixOf "/files/etc/hosts\n" contents) True+ assertEqual ("check after aug_print") (Data.List.isInfixOf "That's all folks" contents) True+ removeFile (cwd++"/HUnitAug.txt")++ )++main :: IO Counts+main = runTestTT $ TestList [+ -- testBadRoot,++ -- aug_get tests+ testGetBadPath,+ testGetPartialPath,+ testGetStillPartialPath,+ testGetBadLabel,+ testGetGoodLabel,+ testGetMultipleLabel,+ testGetBadMultipleLabel,++ -- aug_set tests+ testSetLabel,+ testSetMultiMatch,++ -- aug_insert tests+ testInsertBadPath,+ testInsertMultiMatch,+ testInsertBeforeAfter,++ -- aug_rm tests+ testRmBadPath,+ testRmOne,+ testRmTwo,++ -- aug_mv tests+ testMvBadSrc,+ testMvNewDest,++ -- aug_match tests+ testMatchBadSrc,+ testMatchOne,+ testMatchMultiple,++ -- aug_save tests+ testSave,+ testSaveNewLabel,++ -- aug_print tests+ testPrint++ -- aug_close already handled in ForeignPtr, so there's no need to surface it to Haskell users at all.+++ ]
+ LICENSE view
@@ -0,0 +1,674 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The GNU General Public License is a free, copyleft license for+software and other kinds of works.++ The licenses for most software and other practical works are designed+to take away your freedom to share and change the works. By contrast,+the GNU General Public License is intended to guarantee your freedom to+share and change all versions of a program--to make sure it remains free+software for all its users. We, the Free Software Foundation, use the+GNU General Public License for most of our software; it applies also to+any other work released this way by its authors. You can apply it to+your programs, too.++ When we speak of free software, we are referring to freedom, 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+them if you wish), that you receive source code or can get it if you+want it, that you can change the software or use pieces of it in new+free programs, and that you know you can do these things.++ To protect your rights, we need to prevent others from denying you+these rights or asking you to surrender the rights. Therefore, you have+certain responsibilities if you distribute copies of the software, or if+you modify it: responsibilities to respect the freedom of others.++ For example, if you distribute copies of such a program, whether+gratis or for a fee, you must pass on to the recipients the same+freedoms that you received. You must make sure that they, too, receive+or can get the source code. And you must show them these terms so they+know their rights.++ Developers that use the GNU GPL protect your rights with two steps:+(1) assert copyright on the software, and (2) offer you this License+giving you legal permission to copy, distribute and/or modify it.++ For the developers' and authors' protection, the GPL clearly explains+that there is no warranty for this free software. For both users' and+authors' sake, the GPL requires that modified versions be marked as+changed, so that their problems will not be attributed erroneously to+authors of previous versions.++ Some devices are designed to deny users access to install or run+modified versions of the software inside them, although the manufacturer+can do so. This is fundamentally incompatible with the aim of+protecting users' freedom to change the software. The systematic+pattern of such abuse occurs in the area of products for individuals to+use, which is precisely where it is most unacceptable. Therefore, we+have designed this version of the GPL to prohibit the practice for those+products. If such problems arise substantially in other domains, we+stand ready to extend this provision to those domains in future versions+of the GPL, as needed to protect the freedom of users.++ Finally, every program is threatened constantly by software patents.+States should not allow patents to restrict development and use of+software on general-purpose computers, but in those that do, we wish to+avoid the special danger that patents applied to a free program could+make it effectively proprietary. To prevent this, the GPL assures that+patents cannot be used to render the program non-free.++ The precise terms and conditions for copying, distribution and+modification follow.++ TERMS AND CONDITIONS++ 0. Definitions.++ "This License" refers to version 3 of the GNU General Public License.++ "Copyright" also means copyright-like laws that apply to other kinds of+works, such as semiconductor masks.++ "The Program" refers to any copyrightable work licensed under this+License. Each licensee is addressed as "you". "Licensees" and+"recipients" may be individuals or organizations.++ To "modify" a work means to copy from or adapt all or part of the work+in a fashion requiring copyright permission, other than the making of an+exact copy. The resulting work is called a "modified version" of the+earlier work or a work "based on" the earlier work.++ A "covered work" means either the unmodified Program or a work based+on the Program.++ To "propagate" a work means to do anything with it that, without+permission, would make you directly or secondarily liable for+infringement under applicable copyright law, except executing it on a+computer or modifying a private copy. Propagation includes copying,+distribution (with or without modification), making available to the+public, and in some countries other activities as well.++ To "convey" a work means any kind of propagation that enables other+parties to make or receive copies. Mere interaction with a user through+a computer network, with no transfer of a copy, is not conveying.++ An interactive user interface displays "Appropriate Legal Notices"+to the extent that it includes a convenient and prominently visible+feature that (1) displays an appropriate copyright notice, and (2)+tells the user that there is no warranty for the work (except to the+extent that warranties are provided), that licensees may convey the+work under this License, and how to view a copy of this License. If+the interface presents a list of user commands or options, such as a+menu, a prominent item in the list meets this criterion.++ 1. Source Code.++ The "source code" for a work means the preferred form of the work+for making modifications to it. "Object code" means any non-source+form of a work.++ A "Standard Interface" means an interface that either is an official+standard defined by a recognized standards body, or, in the case of+interfaces specified for a particular programming language, one that+is widely used among developers working in that language.++ The "System Libraries" of an executable work include anything, other+than the work as a whole, that (a) is included in the normal form of+packaging a Major Component, but which is not part of that Major+Component, and (b) serves only to enable use of the work with that+Major Component, or to implement a Standard Interface for which an+implementation is available to the public in source code form. A+"Major Component", in this context, means a major essential component+(kernel, window system, and so on) of the specific operating system+(if any) on which the executable work runs, or a compiler used to+produce the work, or an object code interpreter used to run it.++ The "Corresponding Source" for a work in object code form means all+the source code needed to generate, install, and (for an executable+work) run the object code and to modify the work, including scripts to+control those activities. However, it does not include the work's+System Libraries, or general-purpose tools or generally available free+programs which are used unmodified in performing those activities but+which are not part of the work. For example, Corresponding Source+includes interface definition files associated with source files for+the work, and the source code for shared libraries and dynamically+linked subprograms that the work is specifically designed to require,+such as by intimate data communication or control flow between those+subprograms and other parts of the work.++ The Corresponding Source need not include anything that users+can regenerate automatically from other parts of the Corresponding+Source.++ The Corresponding Source for a work in source code form is that+same work.++ 2. Basic Permissions.++ All rights granted under this License are granted for the term of+copyright on the Program, and are irrevocable provided the stated+conditions are met. This License explicitly affirms your unlimited+permission to run the unmodified Program. The output from running a+covered work is covered by this License only if the output, given its+content, constitutes a covered work. This License acknowledges your+rights of fair use or other equivalent, as provided by copyright law.++ You may make, run and propagate covered works that you do not+convey, without conditions so long as your license otherwise remains+in force. You may convey covered works to others for the sole purpose+of having them make modifications exclusively for you, or provide you+with facilities for running those works, provided that you comply with+the terms of this License in conveying all material for which you do+not control copyright. Those thus making or running the covered works+for you must do so exclusively on your behalf, under your direction+and control, on terms that prohibit them from making any copies of+your copyrighted material outside their relationship with you.++ Conveying under any other circumstances is permitted solely under+the conditions stated below. Sublicensing is not allowed; section 10+makes it unnecessary.++ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.++ No covered work shall be deemed part of an effective technological+measure under any applicable law fulfilling obligations under article+11 of the WIPO copyright treaty adopted on 20 December 1996, or+similar laws prohibiting or restricting circumvention of such+measures.++ When you convey a covered work, you waive any legal power to forbid+circumvention of technological measures to the extent such circumvention+is effected by exercising rights under this License with respect to+the covered work, and you disclaim any intention to limit operation or+modification of the work as a means of enforcing, against the work's+users, your or third parties' legal rights to forbid circumvention of+technological measures.++ 4. Conveying Verbatim Copies.++ You may convey verbatim copies of the Program's source code as you+receive it, in any medium, provided that you conspicuously and+appropriately publish on each copy an appropriate copyright notice;+keep intact all notices stating that this License and any+non-permissive terms added in accord with section 7 apply to the code;+keep intact all notices of the absence of any warranty; and give all+recipients a copy of this License along with the Program.++ You may charge any price or no price for each copy that you convey,+and you may offer support or warranty protection for a fee.++ 5. Conveying Modified Source Versions.++ You may convey a work based on the Program, or the modifications to+produce it from the Program, in the form of source code under the+terms of section 4, provided that you also meet all of these conditions:++ a) The work must carry prominent notices stating that you modified+ it, and giving a relevant date.++ b) The work must carry prominent notices stating that it is+ released under this License and any conditions added under section+ 7. This requirement modifies the requirement in section 4 to+ "keep intact all notices".++ c) You must license the entire work, as a whole, under this+ License to anyone who comes into possession of a copy. This+ License will therefore apply, along with any applicable section 7+ additional terms, to the whole of the work, and all its parts,+ regardless of how they are packaged. This License gives no+ permission to license the work in any other way, but it does not+ invalidate such permission if you have separately received it.++ d) If the work has interactive user interfaces, each must display+ Appropriate Legal Notices; however, if the Program has interactive+ interfaces that do not display Appropriate Legal Notices, your+ work need not make them do so.++ A compilation of a covered work with other separate and independent+works, which are not by their nature extensions of the covered work,+and which are not combined with it such as to form a larger program,+in or on a volume of a storage or distribution medium, is called an+"aggregate" if the compilation and its resulting copyright are not+used to limit the access or legal rights of the compilation's users+beyond what the individual works permit. Inclusion of a covered work+in an aggregate does not cause this License to apply to the other+parts of the aggregate.++ 6. Conveying Non-Source Forms.++ You may convey a covered work in object code form under the terms+of sections 4 and 5, provided that you also convey the+machine-readable Corresponding Source under the terms of this License,+in one of these ways:++ a) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by the+ Corresponding Source fixed on a durable physical medium+ customarily used for software interchange.++ b) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by a+ written offer, valid for at least three years and valid for as+ long as you offer spare parts or customer support for that product+ model, to give anyone who possesses the object code either (1) a+ copy of the Corresponding Source for all the software in the+ product that is covered by this License, on a durable physical+ medium customarily used for software interchange, for a price no+ more than your reasonable cost of physically performing this+ conveying of source, or (2) access to copy the+ Corresponding Source from a network server at no charge.++ c) Convey individual copies of the object code with a copy of the+ written offer to provide the Corresponding Source. This+ alternative is allowed only occasionally and noncommercially, and+ only if you received the object code with such an offer, in accord+ with subsection 6b.++ d) Convey the object code by offering access from a designated+ place (gratis or for a charge), and offer equivalent access to the+ Corresponding Source in the same way through the same place at no+ further charge. You need not require recipients to copy the+ Corresponding Source along with the object code. If the place to+ copy the object code is a network server, the Corresponding Source+ may be on a different server (operated by you or a third party)+ that supports equivalent copying facilities, provided you maintain+ clear directions next to the object code saying where to find the+ Corresponding Source. Regardless of what server hosts the+ Corresponding Source, you remain obligated to ensure that it is+ available for as long as needed to satisfy these requirements.++ e) Convey the object code using peer-to-peer transmission, provided+ you inform other peers where the object code and Corresponding+ Source of the work are being offered to the general public at no+ charge under subsection 6d.++ A separable portion of the object code, whose source code is excluded+from the Corresponding Source as a System Library, need not be+included in conveying the object code work.++ A "User Product" is either (1) a "consumer product", which means any+tangible personal property which is normally used for personal, family,+or household purposes, or (2) anything designed or sold for incorporation+into a dwelling. In determining whether a product is a consumer product,+doubtful cases shall be resolved in favor of coverage. For a particular+product received by a particular user, "normally used" refers to a+typical or common use of that class of product, regardless of the status+of the particular user or of the way in which the particular user+actually uses, or expects or is expected to use, the product. A product+is a consumer product regardless of whether the product has substantial+commercial, industrial or non-consumer uses, unless such uses represent+the only significant mode of use of the product.++ "Installation Information" for a User Product means any methods,+procedures, authorization keys, or other information required to install+and execute modified versions of a covered work in that User Product from+a modified version of its Corresponding Source. The information must+suffice to ensure that the continued functioning of the modified object+code is in no case prevented or interfered with solely because+modification has been made.++ If you convey an object code work under this section in, or with, or+specifically for use in, a User Product, and the conveying occurs as+part of a transaction in which the right of possession and use of the+User Product is transferred to the recipient in perpetuity or for a+fixed term (regardless of how the transaction is characterized), the+Corresponding Source conveyed under this section must be accompanied+by the Installation Information. But this requirement does not apply+if neither you nor any third party retains the ability to install+modified object code on the User Product (for example, the work has+been installed in ROM).++ The requirement to provide Installation Information does not include a+requirement to continue to provide support service, warranty, or updates+for a work that has been modified or installed by the recipient, or for+the User Product in which it has been modified or installed. Access to a+network may be denied when the modification itself materially and+adversely affects the operation of the network or violates the rules and+protocols for communication across the network.++ Corresponding Source conveyed, and Installation Information provided,+in accord with this section must be in a format that is publicly+documented (and with an implementation available to the public in+source code form), and must require no special password or key for+unpacking, reading or copying.++ 7. Additional Terms.++ "Additional permissions" are terms that supplement the terms of this+License by making exceptions from one or more of its conditions.+Additional permissions that are applicable to the entire Program shall+be treated as though they were included in this License, to the extent+that they are valid under applicable law. If additional permissions+apply only to part of the Program, that part may be used separately+under those permissions, but the entire Program remains governed by+this License without regard to the additional permissions.++ When you convey a copy of a covered work, you may at your option+remove any additional permissions from that copy, or from any part of+it. (Additional permissions may be written to require their own+removal in certain cases when you modify the work.) You may place+additional permissions on material, added by you to a covered work,+for which you have or can give appropriate copyright permission.++ Notwithstanding any other provision of this License, for material you+add to a covered work, you may (if authorized by the copyright holders of+that material) supplement the terms of this License with terms:++ a) Disclaiming warranty or limiting liability differently from the+ terms of sections 15 and 16 of this License; or++ b) Requiring preservation of specified reasonable legal notices or+ author attributions in that material or in the Appropriate Legal+ Notices displayed by works containing it; or++ c) Prohibiting misrepresentation of the origin of that material, or+ requiring that modified versions of such material be marked in+ reasonable ways as different from the original version; or++ d) Limiting the use for publicity purposes of names of licensors or+ authors of the material; or++ e) Declining to grant rights under trademark law for use of some+ trade names, trademarks, or service marks; or++ f) Requiring indemnification of licensors and authors of that+ material by anyone who conveys the material (or modified versions of+ it) with contractual assumptions of liability to the recipient, for+ any liability that these contractual assumptions directly impose on+ those licensors and authors.++ All other non-permissive additional terms are considered "further+restrictions" within the meaning of section 10. If the Program as you+received it, or any part of it, contains a notice stating that it is+governed by this License along with a term that is a further+restriction, you may remove that term. If a license document contains+a further restriction but permits relicensing or conveying under this+License, you may add to a covered work material governed by the terms+of that license document, provided that the further restriction does+not survive such relicensing or conveying.++ If you add terms to a covered work in accord with this section, you+must place, in the relevant source files, a statement of the+additional terms that apply to those files, or a notice indicating+where to find the applicable terms.++ Additional terms, permissive or non-permissive, may be stated in the+form of a separately written license, or stated as exceptions;+the above requirements apply either way.++ 8. Termination.++ You may not propagate or modify a covered work except as expressly+provided under this License. Any attempt otherwise to propagate or+modify it is void, and will automatically terminate your rights under+this License (including any patent licenses granted under the third+paragraph of section 11).++ However, if you cease all violation of this License, then your+license from a particular copyright holder is reinstated (a)+provisionally, unless and until the copyright holder explicitly and+finally terminates your license, and (b) permanently, if the copyright+holder fails to notify you of the violation by some reasonable means+prior to 60 days after the cessation.++ Moreover, your license from a particular copyright holder is+reinstated permanently if the copyright holder notifies you of the+violation by some reasonable means, this is the first time you have+received notice of violation of this License (for any work) from that+copyright holder, and you cure the violation prior to 30 days after+your receipt of the notice.++ Termination of your rights under this section does not terminate the+licenses of parties who have received copies or rights from you under+this License. If your rights have been terminated and not permanently+reinstated, you do not qualify to receive new licenses for the same+material under section 10.++ 9. Acceptance Not Required for Having Copies.++ You are not required to accept this License in order to receive or+run a copy of the Program. Ancillary propagation of a covered work+occurring solely as a consequence of using peer-to-peer transmission+to receive a copy likewise does not require acceptance. However,+nothing other than this License grants you permission to propagate or+modify any covered work. These actions infringe copyright if you do+not accept this License. Therefore, by modifying or propagating a+covered work, you indicate your acceptance of this License to do so.++ 10. Automatic Licensing of Downstream Recipients.++ Each time you convey a covered work, the recipient automatically+receives a license from the original licensors, to run, modify and+propagate that work, subject to this License. You are not responsible+for enforcing compliance by third parties with this License.++ An "entity transaction" is a transaction transferring control of an+organization, or substantially all assets of one, or subdividing an+organization, or merging organizations. If propagation of a covered+work results from an entity transaction, each party to that+transaction who receives a copy of the work also receives whatever+licenses to the work the party's predecessor in interest had or could+give under the previous paragraph, plus a right to possession of the+Corresponding Source of the work from the predecessor in interest, if+the predecessor has it or can get it with reasonable efforts.++ You may not impose any further restrictions on the exercise of the+rights granted or affirmed under this License. For example, you may+not impose a license fee, royalty, or other charge for exercise of+rights granted under this License, and you may not initiate litigation+(including a cross-claim or counterclaim in a lawsuit) alleging that+any patent claim is infringed by making, using, selling, offering for+sale, or importing the Program or any portion of it.++ 11. Patents.++ A "contributor" is a copyright holder who authorizes use under this+License of the Program or a work on which the Program is based. The+work thus licensed is called the contributor's "contributor version".++ A contributor's "essential patent claims" are all patent claims+owned or controlled by the contributor, whether already acquired or+hereafter acquired, that would be infringed by some manner, permitted+by this License, of making, using, or selling its contributor version,+but do not include claims that would be infringed only as a+consequence of further modification of the contributor version. For+purposes of this definition, "control" includes the right to grant+patent sublicenses in a manner consistent with the requirements of+this License.++ Each contributor grants you a non-exclusive, worldwide, royalty-free+patent license under the contributor's essential patent claims, to+make, use, sell, offer for sale, import and otherwise run, modify and+propagate the contents of its contributor version.++ In the following three paragraphs, a "patent license" is any express+agreement or commitment, however denominated, not to enforce a patent+(such as an express permission to practice a patent or covenant not to+sue for patent infringement). To "grant" such a patent license to a+party means to make such an agreement or commitment not to enforce a+patent against the party.++ If you convey a covered work, knowingly relying on a patent license,+and the Corresponding Source of the work is not available for anyone+to copy, free of charge and under the terms of this License, through a+publicly available network server or other readily accessible means,+then you must either (1) cause the Corresponding Source to be so+available, or (2) arrange to deprive yourself of the benefit of the+patent license for this particular work, or (3) arrange, in a manner+consistent with the requirements of this License, to extend the patent+license to downstream recipients. "Knowingly relying" means you have+actual knowledge that, but for the patent license, your conveying the+covered work in a country, or your recipient's use of the covered work+in a country, would infringe one or more identifiable patents in that+country that you have reason to believe are valid.++ If, pursuant to or in connection with a single transaction or+arrangement, you convey, or propagate by procuring conveyance of, a+covered work, and grant a patent license to some of the parties+receiving the covered work authorizing them to use, propagate, modify+or convey a specific copy of the covered work, then the patent license+you grant is automatically extended to all recipients of the covered+work and works based on it.++ A patent license is "discriminatory" if it does not include within+the scope of its coverage, prohibits the exercise of, or is+conditioned on the non-exercise of one or more of the rights that are+specifically granted under this License. You may not convey a covered+work if you are a party to an arrangement with a third party that is+in the business of distributing software, under which you make payment+to the third party based on the extent of your activity of conveying+the work, and under which the third party grants, to any of the+parties who would receive the covered work from you, a discriminatory+patent license (a) in connection with copies of the covered work+conveyed by you (or copies made from those copies), or (b) primarily+for and in connection with specific products or compilations that+contain the covered work, unless you entered into that arrangement,+or that patent license was granted, prior to 28 March 2007.++ Nothing in this License shall be construed as excluding or limiting+any implied license or other defenses to infringement that may+otherwise be available to you under applicable patent law.++ 12. No Surrender of Others' Freedom.++ If 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 convey a+covered work so as to satisfy simultaneously your obligations under this+License and any other pertinent obligations, then as a consequence you may+not convey it at all. For example, if you agree to terms that obligate you+to collect a royalty for further conveying from those to whom you convey+the Program, the only way you could satisfy both those terms and this+License would be to refrain entirely from conveying the Program.++ 13. Use with the GNU Affero General Public License.++ Notwithstanding any other provision of this License, you have+permission to link or combine any covered work with a work licensed+under version 3 of the GNU Affero General Public License into a single+combined work, and to convey the resulting work. The terms of this+License will continue to apply to the part which is the covered work,+but the special requirements of the GNU Affero General Public License,+section 13, concerning interaction through a network will apply to the+combination as such.++ 14. Revised Versions of this License.++ The Free Software Foundation may publish revised and/or new versions of+the GNU 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+Program specifies that a certain numbered version of the GNU General+Public License "or any later version" applies to it, you have the+option of following the terms and conditions either of that numbered+version or of any later version published by the Free Software+Foundation. If the Program does not specify a version number of the+GNU General Public License, you may choose any version ever published+by the Free Software Foundation.++ If the Program specifies that a proxy can decide which future+versions of the GNU General Public License can be used, that proxy's+public statement of acceptance of a version permanently authorizes you+to choose that version for the Program.++ Later license versions may give you additional or different+permissions. However, no additional obligations are imposed on any+author or copyright holder as a result of your choosing to follow a+later version.++ 15. Disclaimer of Warranty.++ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.++ 16. Limitation of Liability.++ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS+THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF+SUCH DAMAGES.++ 17. Interpretation of Sections 15 and 16.++ If the disclaimer of warranty and limitation of liability provided+above cannot be given local legal effect according to their terms,+reviewing courts shall apply local law that most closely approximates+an absolute waiver of all civil liability in connection with the+Program, unless a warranty or assumption of liability accompanies a+copy of the Program in return for a fee.++ END OF TERMS AND CONDITIONS++ How to Apply These Terms to Your New Programs++ If you develop a new program, and you want it to be of the greatest+possible use to the public, the best way to achieve this is to make it+free software which everyone can redistribute and change under these terms.++ To do so, attach the following notices to the program. It is safest+to attach them to the start of each source file to most effectively+state 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 program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ 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 3 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, see <http://www.gnu.org/licenses/>.++Also add information on how to contact you by electronic and paper mail.++ If the program does terminal interaction, make it output a short+notice like this when it starts in an interactive mode:++ <program> Copyright (C) <year> <name of author>+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.+ This is free software, and you are welcome to redistribute it+ under certain conditions; type `show c' for details.++The hypothetical commands `show w' and `show c' should show the appropriate+parts of the General Public License. Of course, your program's commands+might be different; for a GUI interface, you would use an "about box".++ You should also get your employer (if you work as a programmer) or school,+if any, to sign a "copyright disclaimer" for the program, if necessary.+For more information on this, and how to apply and follow the GNU GPL, see+<http://www.gnu.org/licenses/>.++ The GNU General Public License does not permit incorporating your program+into proprietary programs. If your program is a subroutine library, you+may consider it more useful to permit linking proprietary applications with+the library. If this is what you want to do, use the GNU Lesser General+Public License instead of this License. But first, please read+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+ Setup.hs view
@@ -0,0 +1,55 @@+#!/usr/bin/env runhaskell++-- file: Setup.hs++-- Haskell bindings for the Augeas library+-- Copyright (c) 2009, Jude Nagurney+--+-- 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., 59 Temple Place, Suite 330, Boston, +-- MA 02111-1307 USA+-- +-- Contact the author at +-- jude@pwan.org ++import Data.List (isInfixOf)+import Distribution.PackageDescription+import Distribution.Simple+import System.Process ++-- main = defaultMain++-- Thanks http://mechablue.livejournal.com/11055.html+main = defaultMainWithHooks simpleUserHooks { runTests = _runTests, instHook = _instHook }+ where+ -- Run all executables with names that end in -tests+ _runTests _ _ pd _ = do+ let exeNames = ["dist/build/" ++ fp ++ "/" ++ fp | fp <- map exeName (executables pd)]+ sequence [_runTest e | e <- exeNames, isInfixOf "test-" e]+ return ()+ _runTest fp = do+ ph <- runCommand fp+ waitForProcess ph+ + -- Only install executables that don't end in -tests+ _instHook pd lbi uhs ifs = do+ let execs = filter (\e -> not $ isInfixOf "test-" (exeName e)) (executables pd)+ (instHook simpleUserHooks) (pd {executables = execs}) lbi uhs ifs+ +--tests _ _ _ _ = do+---- setCurrentDirectory "src"+-- h <- runCommand "/usr/bin/env runghc -laugeas HUnitAug"+-- waitForProcess h+-- return ()+++
+ System/Augeas.hs view
@@ -0,0 +1,499 @@+-- file: Setup.hs++-- Haskell bindings for the Augeas library+-- Copyright (c) 2009, Jude Nagurney+--+-- 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., 59 Temple Place, Suite 330, Boston, +-- MA 02111-1307 USA+-- +-- Contact the author at +-- jude@pwan.org ++{-# LANGUAGE CPP, ForeignFunctionInterface #-}++{-|+ This module provides FFI bindings for the Augeas API (<http://augeas.net/docs/api.html>).+ + /Note aug_close is not surfaced in the API because because the ForeignPtr returned by/+ /aug_init uses aug_close as its finializer./+-}+module System.Augeas+ (+ -- * Types+ Augeas+ , AugFlag,+ none, save_backup, save_newfile, type_check+ , AugMatch+ , exactly_one, no_match, invalid_match+ , AugRet+ , success, System.Augeas.error+ , AugBefore+ , just_before, just_after+ -- * Functions+ , aug_init+ , aug_get+ , aug_set+ , aug_insert+ , aug_rm+ , aug_mv+ , aug_match+ , aug_save+ , aug_print+ ) where++import System.IO+import System.Posix.IO+import System.Posix.Types+import Foreign+import Foreign.C.Types+import Foreign.C.String+import GHC.Handle+import Data.ByteString++import AugeasHsc++-- --------------+-- Augeas pointer+-- --------------+{-|+ A pointer to the Augeas tree structure+ Not using a typed pointer (as per RWH p416) because of the compiler warning+-}+--newtype Augeas = Augeas (Ptr Augeas)+-- deriving (Eq, Show)+type Augeas = ()++-- ---------+-- aug_match+-- ---------++{-|+ The possible 'aug_get' return values.+-}+newtype AugMatch = AugMatch CInt+ deriving (Eq, Show)++{-|+ Exactly one match was found.+-}+exactly_one :: AugMatch+exactly_one = AugMatch 1++{-|+ No matches were found+-}+no_match :: AugMatch+no_match = AugMatch 0++{-|+ Either an invalid paths, or multiple matches were found.+-}+invalid_match :: AugMatch+invalid_match = AugMatch (-1)++-- -------+-- aug_ret+-- -------+{-|+ The possible return values for the 'aug_set', 'aug_insert', 'aug_mv', 'aug_save', and 'aug_print' functions+-}+newtype AugRet = AugRet CInt+ deriving (Eq, Show)++{-|+ The function worked as expected+-}+success :: AugRet+success = AugRet 0++{-|+ The function failed+-}+error :: AugRet+error = AugRet (-1)++-- ----------+-- aug_before+-- ----------+{-|+ The possible BEFORE values fro the aug_insert function+-}+newtype AugBefore = AugBefore CInt+ deriving (Eq, Show)++{-|+ Insert the LABEL just before the PATH+-}+just_before :: AugBefore+just_before = AugBefore 1++{-|+ Insert the LABEL just after the PATH+-}+just_after :: AugBefore+just_after = AugBefore 0++-- utility functions++combineFlags :: [AugFlag] -> AugFlag+combineFlags = AugFlag . Prelude.foldr ((.|.) . unAugFlag) 0++-- --------+-- aug_init+-- --------++-- TODO: Replace loadpath string with a dedicated loadpath type ?+foreign import ccall unsafe "augeas.h aug_init"+ c_aug_init :: CString -> CString -> AugFlag -> IO (Ptr Augeas) ++{-|+ Initialize the library.+ + Use ROOT as the filesystem root. If ROOT is NULL, use the value of the+ environment variable AUGEAS_ROOT. If that doesn't exist either, use \"\/\".++ LOADPATH is a colon-spearated list of directories that modules should be+ searched in. This is in addition to the standard load path and the+ directories in AUGEAS_LENS_LIB++ FLAGS is a list of AugFlags++ Return a ForeignPtr to the Augeas tree upon success. If initialization+ fails, returns Nothing.++ /Note that the ForeignPtr returned by the function is using aug_close as a finializer,/+ /so aug_close is called automatically when the Augeas pointer goes out of scope./++ /Therefore, there is no need to surface aug_close in the library./+ +-}+aug_init :: ByteString -- ^ ROOT+ -> ByteString -- ^ LOADPATH+ -> [AugFlag] -- ^ FLAGS+ -> IO (Maybe (ForeignPtr Augeas)) -- ^ Augeas pointer+aug_init bstr1 bstr2 flags =+ useAsCString bstr1 $ \root -> do+ useAsCString bstr2 $ \loadpath -> do+ aug_ptr <- c_aug_init root loadpath (combineFlags flags)+ if (aug_ptr == nullPtr)+ then do+ return Nothing+ else do+ ret_ptr <- newForeignPtr c_aug_close aug_ptr -- release with aug_close+ return (Just ret_ptr)++-- ---------+-- aug_close+-- ---------++foreign import ccall unsafe "augeas.h &aug_close"+ c_aug_close :: FinalizerPtr Augeas++--{-|+-- from augeas.h:+-- Close this Augeas instance and free any storage associated with+-- it. After running AUG_CLOSE, AUG is invalid and can not be used for any+-- more operations.+---}+--aug_close :: FinalizerPtr Augeas+--aug_close = c_aug_close ++-- -------+-- aug_get +-- -------+foreign import ccall unsafe "augeas.h aug_get"+ c_aug_get :: Ptr Augeas -- aug+ -> CString -- path+ -> Ptr CString -- value+ -> IO (AugMatch) -- return_value++{-| + Lookup the value associated with PATH. VALUE can be NULL, in which case+ it is ignored. If VALUE is not NULL, it is used to return a pointer to+ the value associated with PATH if PATH matches exactly one node. If PATH+ matches no nodes or more than one node, *VALUE is set to NULL.++ Return AugMatch.exactly_one if there is exactly one node matching PATH, AugMatch.no_match if there is none,+ and AugMatch.invalid_match if there is more than one node matching PATH, or if+ PATH is not a legal path expression.+-}++aug_get :: Ptr Augeas -- ^ Augeas pointer+ -> ByteString -- ^ PATH+ -> IO (Either AugMatch (Maybe String)) -- ^ Either AugMatch or VALUE+aug_get aug_ptr bstr1 = + useAsCString bstr1 $ \path -> do+ alloca $ \value -> do+ ret <- c_aug_get aug_ptr path value+ if ret == exactly_one+ then do + if value == nullPtr + then do+ return (Left ret)+ else do+ peeked <- peek value+ if peeked == nullPtr+ then do+ return (Right Nothing)+ else do+ str_peeked <- peekCString peeked+ return (Right (Just str_peeked))+ else do + return (Left ret)++-- -------+-- aug_set+-- -------+foreign import ccall unsafe "augeas.h aug_set"+ c_aug_set :: Ptr Augeas -- aug+ -> CString -- path+ -> CString -- value+ -> IO (AugRet) -- return value++{-|++ Set the value associated with PATH to VALUE. VALUE is copied into the+ internal data structure. Intermediate entries are created if they don't+ exist. ++ Return AugRet.success on success, AugRet.error on error. It is an error if more than one+ node matches PATH.++-}+aug_set :: Ptr Augeas -- ^ Augeas pointer+ -> ByteString -- ^ PATH+ -> ByteString -- ^ VALUE+ -> IO (AugRet) -- ^ return value+aug_set aug_ptr bs1 bs2 = + useAsCString bs1 $ \path -> do+ useAsCString bs2 $ \value -> do+ ret <- c_aug_set aug_ptr path value+ return ret++-- ----------+-- aug_insert+-- ----------+foreign import ccall unsafe "augeas.h aug_insert"+ c_aug_insert :: Ptr Augeas -- aug+ -> CString -- path+ -> CString -- label+ -> AugBefore -- before+ -> IO (AugRet) -- return value++{-|++ Create a new sibling LABEL for PATH by inserting into the tree just+ before PATH if BEFORE == just_before or just after PATH if BEFORE == just_after.++ PATH must match exactly one existing node in the tree, and LABEL must be+ a label, i.e. not contain a '/', '*' or end with a bracketed index+ '[N]'.++ Return AugRet.success on success, and AugRet.error if the insertion fails.++-}+aug_insert :: Ptr Augeas -- ^ Augeas pointer+ -> ByteString -- ^ PTH+ -> ByteString -- ^ LABEL+ -> AugBefore -- ^ BEFORE+ -> IO (AugRet) -- ^ return value+aug_insert aug_ptr bs1 bs2 before = + useAsCString bs1 $ \path -> do+ useAsCString bs2 $ \label -> do+ ret <- c_aug_insert aug_ptr path label before+ return ret++-- ------+-- aug_rm+-- ------+foreign import ccall unsafe "augeas.h aug_rm"+ c_aug_rm :: Ptr Augeas -- aug+ -> CString -- path+ -> IO (CInt) -- return value++{-|++ Remove path and all its children. Returns the number of entries removed.+ All nodes that match PATH, and their descendants, are removed.++-}+aug_rm :: Ptr Augeas -- ^ Augeas pointer+ -> ByteString -- ^ PATH+ -> IO (CInt) -- ^ number of entries removed+aug_rm aug_ptr bs_path = + useAsCString bs_path $ \path -> do + ret <- c_aug_rm aug_ptr path+ return ret++-- ------+-- aug_mv+-- ------+foreign import ccall unsafe "augeas.h aug_mv"+ c_aug_mv :: Ptr Augeas -- aug+ -> CString -- src+ -> CString -- dst+ -> IO (AugRet) -- return value++{- |+ Move the node SRC to DST. SRC must match exactly one node in the+ tree. DST must either match exactly one node in the tree, or may not+ exist yet. If DST exists already, it and all its descendants are+ deleted. If DST does not exist yet, it and all its missing ancestors are+ created.++ Note that the node SRC always becomes the node DST: when you move \/a\/b+ to \/x, the node \/a\/b is now called \/x, no matter whether \/x existed+ initially or not.++ Return AugRet.success on success and AugRet.error on failure.+-}+aug_mv :: Ptr Augeas -- ^ Augeas pointer+ -> ByteString -- ^ SRC+ -> ByteString -- ^ DEST+ -> IO (AugRet) -- ^ return value+aug_mv aug_ptr bs_src bs_dst = + useAsCString bs_src $ \src -> do+ useAsCString bs_dst $ \dst -> do+ ret <- c_aug_mv aug_ptr src dst+ return ret++-- ---------+-- aug_match+-- ---------+foreign import ccall unsafe "augeas.h aug_match"+ c_aug_match :: Ptr Augeas -- aug+ -> CString -- path+ -> Ptr (Ptr CString) -- matches+ -> IO (CInt) -- return value++{-|+ Return the number of matches of the path expression PATH in AUG. If+ MATCHES is non-NULL, an array with the returned number of elements will+ be allocated and filled with the paths of the matches. The caller must+ free both the array and the entries in it. The returned paths are+ sufficiently qualified to make sure that they match exactly one node in+ the current tree.++ If MATCHES is NULL, nothing is allocated and only the number+ of matches is returned.++ Returns -1 on error, or the total number of matches (which might be 0).++ Path expressions use a very simple subset of XPath: the path PATH+ consists of a number of segments, separated by '/'; each segment can+ either be a '*', matching any tree node, or a string, optionally+ followed by an index in brackets, matching tree nodes labelled with+ exactly that string. If no index is specified, the expression matches+ all nodes with that label; the index can be a positive number N, which+ matches exactly the Nth node with that label (counting from 1), or the+ special expression 'last()' which matches the last node with the given+ label. All matches are done in fixed positions in the tree, and nothing+ matches more than one path segment.++-}++aug_match :: Ptr Augeas -- ^ Augeas pointer+ -> ByteString -- ^ PATH+ -> IO (Int, Maybe [String]) -- ^ (match count, MATCHES)+aug_match aug_ptr bs_path = + useAsCString bs_path $ \path -> do+ alloca $ \matches -> do+ ret <- c_aug_match aug_ptr path matches+ if ret == -1 + then do+ return (-1, Nothing)+ else do+ matches_cstrs <- peekArray (fromIntegral ret) =<< peek matches++ -- There's got to be a better way to map (IO [CString]) to (IO [String]) ...+ matches_strs <- Prelude.foldr (\t io_l -> do s <- peekCString t; l <- io_l; return (s:l)) (return []) matches_cstrs++ return (fromIntegral ret, Just matches_strs)++-- --------+-- aug_save+-- --------+foreign import ccall unsafe "augeas.h aug_save"+ c_aug_save :: Ptr Augeas -- aug+ -> IO (AugRet) -- return value++{-|++ Write all pending changes to disk. ++ Return AugRet.error if an error is encountered, AugRet.success on success. + Only files that had any changes made to them are written.++ If AUG_SAVE_NEWFILE is set in the FLAGS passed to AUG_INIT, create+ changed files as new files with the extension ".augnew", and leave teh+ original file unmodified.++ Otherwise, if AUG_SAVE_BACKUP is set in the FLAGS passed to AUG_INIT,+ move the original file to a new file with extension ".augsave".++ If neither of these flags is set, overwrite the original file.++-}+aug_save :: Ptr Augeas -- ^ Augeas pointer+ -> IO (AugRet) -- ^ return value+aug_save aug_ptr = + do + ret <- c_aug_save aug_ptr+ return ret+++-- ---------+-- aug_print+-- ---------+-- FILE *fdopen(int fildes, const char *mode);+foreign import ccall "" fdopen :: Fd -> CString -> IO (Ptr CFile)++foreign import ccall "" fflush :: (Ptr CFile) -> IO (Int)++foreign import ccall "" fclose :: (Ptr CFile) -> IO (Int)+ +handleToCFile :: Handle -> String -> IO (Ptr CFile)+handleToCFile h m =+ do iomode <- newCString m++ -- Duplicate the handle, so the original stays open after the handleToFd call closes the duplicate+ dup_h <- hDuplicate h + fd <- handleToFd dup_h+ fdopen fd iomode++-- surface aug_print+foreign import ccall unsafe "augeas.h aug_print"+ c_aug_print :: Ptr Augeas -- aug+ -> Ptr CFile -- out+ -> CString -- path+ -> IO (AugRet) -- return value++{-|+ Print each node matching PATH and its descendants to OUT.+ Return AugRet.success on success, or AugRet.error on failure++-}++aug_print :: Ptr Augeas -- ^ Augeas pointer+ -> Handle -- ^ Already opened file handle+ -> ByteString -- ^ PATH+ -> IO (AugRet) -- ^ return value+aug_print aug_ptr fptr_out bs_path = + do + useAsCString bs_path $ \path -> do+ out <- handleToCFile fptr_out "w"+ ret <- c_aug_print aug_ptr out path+ fflush out+ fclose out+ return(ret)+
+ augeas.cabal view
@@ -0,0 +1,24 @@+Name: augeas+Version: 0.1+Synopsis: A Haskell FFI wrapper for the Augeas API+Description: A Haskell FFI wrapper for the Augeas API+Author: Jude Nagurney+Maintainer: jude@pwan.org+Cabal-Version: >= 1.2+License: GPL+License-File: LICENSE+Build-Type: Custom+Category: System+Stability: Alpha++library + Exposed-Modules: System.Augeas+ Build-Depends: base >= 2.0, bytestring >= 0.9.0.1, unix >=2.3.0.0, haskell98+ GHC-options: -Wall -fwarn-dodgy-imports++executable "test-haskell-augeas"+ Main-is: HUnitAug.hs+ Build-Depends: HUnit+ Other-Modules: System.Augeas+ extra-libraries: augeas+