diff --git a/COPYING b/COPYING new file mode 100644 --- /dev/null +++ b/COPYING @@ -0,0 +1,504 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + 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. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/Gtk2HsSetup.hs b/Gtk2HsSetup.hs new file mode 100644 --- /dev/null +++ b/Gtk2HsSetup.hs @@ -0,0 +1,486 @@ +{-# LANGUAGE CPP #-} + +#define CABAL_VERSION_ENCODE(major, minor, micro) ( \ + ((major) * 10000) \ + + ((minor) * 100) \ + + ((micro) * 1)) + +#define CABAL_VERSION_CHECK(major,minor,micro) \ + (CABAL_VERSION >= CABAL_VERSION_ENCODE(major,minor,micro)) + +-- now, this is bad, but Cabal doesn't seem to actually pass any information about +-- its version to CPP, so guess the version depending on the version of GHC +#ifdef CABAL_VERSION_MINOR +#ifndef CABAL_VERSION_MAJOR +#define CABAL_VERSION_MAJOR 1 +#endif +#ifndef CABAL_VERSION_MICRO +#define CABAL_VERSION_MICRO 0 +#endif +#define CABAL_VERSION CABAL_VERSION_ENCODE( \ + CABAL_VERSION_MAJOR, \ + CABAL_VERSION_MINOR, \ + CABAL_VERSION_MICRO) +#else +#warning Setup.hs is guessing the version of Cabal. If compilation of Setup.hs fails use -DCABAL_VERSION_MINOR=x for Cabal version 1.x.0 when building (prefixed by --ghc-option= when using the 'cabal' command) +#if (__GLASGOW_HASKELL__ >= 612) +#define CABAL_VERSION CABAL_VERSION_ENCODE(1,8,0) +#else +#define CABAL_VERSION CABAL_VERSION_ENCODE(1,6,0) +#endif +#endif + +-- | Build a Gtk2hs package. +-- +module Gtk2HsSetup ( gtk2hsUserHooks, getPkgConfigPackages ) where + +import Distribution.Simple +import Distribution.Simple.PreProcess +import Distribution.InstalledPackageInfo ( importDirs, + showInstalledPackageInfo, + libraryDirs, + extraLibraries, + extraGHCiLibraries ) +import Distribution.Simple.PackageIndex ( +#if CABAL_VERSION_CHECK(1,8,0) + lookupInstalledPackageId +#else + lookupPackageId +#endif + ) +import Distribution.PackageDescription as PD ( PackageDescription(..), + updatePackageDescription, + BuildInfo(..), + emptyBuildInfo, allBuildInfo, + Library(..), + libModules, hasLibs) +import Distribution.Simple.LocalBuildInfo (LocalBuildInfo(..), + InstallDirs(..), +#if CABAL_VERSION_CHECK(1,8,0) + componentPackageDeps, +#else + packageDeps, +#endif + absoluteInstallDirs) +import Distribution.Simple.Compiler ( Compiler(..) ) +import Distribution.Simple.Program ( + Program(..), ConfiguredProgram(..), + rawSystemProgramConf, rawSystemProgramStdoutConf, + c2hsProgram, pkgConfigProgram, requireProgram, ghcPkgProgram, + simpleProgram, lookupProgram, rawSystemProgramStdout, ProgArg) +import Distribution.ModuleName ( ModuleName, components, toFilePath ) +import Distribution.Simple.Utils +import Distribution.Simple.Setup (CopyFlags(..), InstallFlags(..), CopyDest(..), + defaultCopyFlags, ConfigFlags(configVerbosity), + fromFlag, toFlag, RegisterFlags(..), flagToMaybe, + fromFlagOrDefault, defaultRegisterFlags) +import Distribution.Simple.BuildPaths ( autogenModulesDir ) +import Distribution.Simple.Install ( install ) +#if CABAL_VERSION_CHECK(1,8,0) +import Distribution.Simple.Register ( generateRegistrationInfo, registerPackage ) +#else +import qualified Distribution.Simple.Register as Register ( register ) +#endif +import Distribution.Text ( simpleParse, display ) +import System.FilePath +import System.Directory ( doesFileExist ) +import Distribution.Version (Version(..)) +import Distribution.Verbosity +import Control.Monad (when, unless, filterM) +import Data.Maybe ( isJust, isNothing, fromMaybe, maybeToList ) +import Data.List (isPrefixOf, isSuffixOf, nub) +import Data.Char (isAlpha) +import qualified Data.Map as M +import qualified Data.Set as S + +import Control.Applicative ((<$>)) +import System.Directory (getDirectoryContents, doesDirectoryExist) + +-- the name of the c2hs pre-compiled header file +precompFile = "precompchs.bin" + +gtk2hsUserHooks = simpleUserHooks { + hookedPrograms = [typeGenProgram, signalGenProgram, c2hsLocal], + hookedPreProcessors = [("chs", ourC2hs)], + confHook = \pd cf -> + confHook simpleUserHooks pd cf >>= return . adjustLocalBuildInfo, + postConf = \args cf pd lbi -> do + genSynthezisedFiles (fromFlag (configVerbosity cf)) pd lbi + postConf simpleUserHooks args cf pd lbi, + buildHook = \pd lbi uh bf -> fixDeps pd >>= \pd -> + (buildHook simpleUserHooks) pd lbi uh bf, + copyHook = \pd lbi uh flags -> (copyHook simpleUserHooks) pd lbi uh flags >> + installCHI pd lbi (fromFlag (copyVerbosity flags)) (fromFlag (copyDest flags)), + instHook = \pd lbi uh flags -> +#if defined(mingw32_HOST_OS) || defined(__MINGW32__) + installHook pd lbi uh flags >> + installCHI pd lbi (fromFlag (installVerbosity flags)) NoCopyDest, + regHook = registerHook +#else + instHook simpleUserHooks pd lbi uh flags >> + installCHI pd lbi (fromFlag (installVerbosity flags)) NoCopyDest +#endif + } + +------------------------------------------------------------------------------ +-- Lots of stuff for windows ghci support +------------------------------------------------------------------------------ + +getDlls :: [FilePath] -> IO [FilePath] +getDlls dirs = filter ((== ".dll") . takeExtension) . concat <$> + mapM getDirectoryContents dirs + +fixLibs :: [FilePath] -> [String] -> [String] +fixLibs dlls = concatMap $ \ lib -> + case filter (("lib" ++ lib) `isPrefixOf`) dlls of + dll:_ -> [dropExtension dll] + _ -> if lib == "z" then [] else [lib] + +-- The following code is a big copy-and-paste job from the sources of +-- Cabal 1.8 just to be able to fix a field in the package file. Yuck. + +#if CABAL_VERSION_CHECK(1,8,0) + +installHook :: PackageDescription -> LocalBuildInfo + -> UserHooks -> InstallFlags -> IO () +installHook pkg_descr localbuildinfo _ flags = do + let copyFlags = defaultCopyFlags { + copyDistPref = installDistPref flags, + copyDest = toFlag NoCopyDest, + copyVerbosity = installVerbosity flags + } + install pkg_descr localbuildinfo copyFlags + let registerFlags = defaultRegisterFlags { + regDistPref = installDistPref flags, + regInPlace = installInPlace flags, + regPackageDB = installPackageDB flags, + regVerbosity = installVerbosity flags + } + when (hasLibs pkg_descr) $ register pkg_descr localbuildinfo registerFlags + +registerHook :: PackageDescription -> LocalBuildInfo + -> UserHooks -> RegisterFlags -> IO () +registerHook pkg_descr localbuildinfo _ flags = + if hasLibs pkg_descr + then register pkg_descr localbuildinfo flags + else setupMessage verbosity + "Package contains no library to register:" (packageId pkg_descr) + where verbosity = fromFlag (regVerbosity flags) + +register :: PackageDescription -> LocalBuildInfo + -> RegisterFlags -- ^Install in the user's database?; verbose + -> IO () +register pkg@PackageDescription { library = Just lib } + lbi@LocalBuildInfo { libraryConfig = Just clbi } regFlags + = do + + installedPkgInfoRaw <- generateRegistrationInfo + verbosity pkg lib lbi clbi inplace distPref + + dllsInScope <- getSearchPath >>= (filterM doesDirectoryExist) >>= getDlls + let libs = fixLibs dllsInScope (extraLibraries installedPkgInfoRaw) + installedPkgInfo = installedPkgInfoRaw { + extraGHCiLibraries = libs } + + -- Three different modes: + case () of + _ | modeGenerateRegFile -> die "Generate Reg File not supported" + | modeGenerateRegScript -> die "Generate Reg Script not supported" + | otherwise -> registerPackage verbosity + installedPkgInfo pkg lbi inplace packageDb + + where + modeGenerateRegFile = isJust (flagToMaybe (regGenPkgConf regFlags)) + modeGenerateRegScript = fromFlag (regGenScript regFlags) + inplace = fromFlag (regInPlace regFlags) + packageDb = case flagToMaybe (regPackageDB regFlags) of + Just db -> db + Nothing -> registrationPackageDB (withPackageDB lbi) + distPref = fromFlag (regDistPref regFlags) + verbosity = fromFlag (regVerbosity regFlags) + +register _ _ regFlags = notice verbosity "No package to register" + where + verbosity = fromFlag (regVerbosity regFlags) + +#else +installHook :: PackageDescription -> LocalBuildInfo + -> UserHooks -> InstallFlags -> IO () +installHook pkg_descr localbuildinfo _ flags = do + let copyFlags = defaultCopyFlags { + copyDistPref = installDistPref flags, + copyInPlace = installInPlace flags, + copyUseWrapper = installUseWrapper flags, + copyDest = toFlag NoCopyDest, + copyVerbosity = installVerbosity flags + } + install pkg_descr localbuildinfo copyFlags + let registerFlags = defaultRegisterFlags { + regDistPref = installDistPref flags, + regInPlace = installInPlace flags, + regPackageDB = installPackageDB flags, + regVerbosity = installVerbosity flags + } + when (hasLibs pkg_descr) $ register pkg_descr localbuildinfo registerFlags + +registerHook :: PackageDescription -> LocalBuildInfo + -> UserHooks -> RegisterFlags -> IO () +registerHook pkg_descr localbuildinfo _ flags = + if hasLibs pkg_descr + then register pkg_descr localbuildinfo flags + else setupMessage verbosity + "Package contains no library to register:" (packageId pkg_descr) + where verbosity = fromFlag (regVerbosity flags) + +register :: PackageDescription -> LocalBuildInfo + -> RegisterFlags -- ^Install in the user's database?; verbose + -> IO () +register pkg_descr lbi regFlags = do + let verbosity = fromFlag (regVerbosity regFlags) + warn verbosity "Cannot register ghci libraries with Cabal 1.6 (need 1.8)." + Register.register pkg_descr lbi regFlags + +#endif + +------------------------------------------------------------------------------ +-- This is a hack for Cabal-1.8, It is not needed in Cabal-1.9.1 or later +------------------------------------------------------------------------------ + +adjustLocalBuildInfo :: LocalBuildInfo -> LocalBuildInfo +adjustLocalBuildInfo lbi = + let extra = (Just libBi, []) + libBi = emptyBuildInfo { includeDirs = [ autogenModulesDir lbi + , buildDir lbi ] } + in lbi { localPkgDescr = updatePackageDescription extra (localPkgDescr lbi) } + +------------------------------------------------------------------------------ +-- Processing .chs files with our local c2hs. +------------------------------------------------------------------------------ + +ourC2hs :: BuildInfo -> LocalBuildInfo -> PreProcessor +ourC2hs bi lbi = PreProcessor { + platformIndependent = False, + runPreProcessor = runC2HS bi lbi +} + +runC2HS :: BuildInfo -> LocalBuildInfo -> + (FilePath, FilePath) -> (FilePath, FilePath) -> Verbosity -> IO () +runC2HS bi lbi (inDir, inFile) (outDir, outFile) verbosity = do + -- have the header file name if we don't have the precompiled header yet + header <- case lookup "x-c2hs-header" (customFieldsBI bi) of + Just h -> return h + Nothing -> die ("Need x-c2hs-Header definition in the .cabal Library section "++ + "that sets the C header file to process .chs.pp files.") + + -- c2hs will output files in out dir, removing any leading path of the input file. + -- Thus, append the dir of the input file to the output dir. + let (outFileDir, newOutFile) = splitFileName outFile + let newOutDir = outDir outFileDir + -- additional .chi files might be needed that other packages have installed; + -- we assume that these are installed in the same place as .hi files + let chiDirs = [ dir | +#if CABAL_VERSION_CHECK(1,8,0) + ipi <- maybe [] (map fst . componentPackageDeps) (libraryConfig lbi), + dir <- maybe [] importDirs (lookupInstalledPackageId (installedPkgs lbi) ipi) ] +#else + ipi <- packageDeps lbi, + dir <- maybe [] importDirs (lookupPackageId (installedPkgs lbi) ipi) ] +#endif + rawSystemProgramConf verbosity c2hsLocal (withPrograms lbi) $ + map ("--include=" ++) (outDir:chiDirs) + ++ ["--cppopts=" ++ opt | opt <- getCppOptions bi lbi] + ++ ["--output-dir=" ++ newOutDir, + "--output=" ++ newOutFile, + "--precomp=" ++ buildDir lbi precompFile, + header, inDir inFile] + +getCppOptions :: BuildInfo -> LocalBuildInfo -> [String] +getCppOptions bi lbi + = nub $ + ["-I" ++ dir | dir <- PD.includeDirs bi] + ++ [opt | opt@('-':c:_) <- (PD.cppOptions bi ++ PD.ccOptions bi), c `elem` "DIU"] + +installCHI :: PackageDescription -- ^information from the .cabal file + -> LocalBuildInfo -- ^information from the configure step + -> Verbosity -> CopyDest -- ^flags sent to copy or install + -> IO () +installCHI pkg@PD.PackageDescription { library = Just lib } lbi verbosity copydest = do + let InstallDirs { libdir = libPref } = absoluteInstallDirs pkg lbi copydest + -- cannot use the recommended 'findModuleFiles' since it fails if there exists + -- a modules that does not have a .chi file + mFiles <- mapM (findFileWithExtension' ["chi"] [buildDir lbi]) + (map toFilePath +#if CABAL_VERSION_CHECK(1,8,0) + (PD.libModules lib) +#else + (PD.libModules pkg) +#endif + ) + let files = [ f | Just f <- mFiles ] +#if CABAL_VERSION_CHECK(1,8,0) + installOrdinaryFiles verbosity libPref files +#else + copyFiles verbosity libPref files +#endif + + +installCHI _ _ _ _ = return () + +------------------------------------------------------------------------------ +-- Generating the type hierarchy and signal callback .hs files. +------------------------------------------------------------------------------ + +typeGenProgram :: Program +typeGenProgram = (simpleProgram "gtk2hsTypeGen") + +signalGenProgram :: Program +signalGenProgram = (simpleProgram "gtk2hsHookGenerator") + +c2hsLocal :: Program +c2hsLocal = (simpleProgram "gtk2hsC2hs") + +genSynthezisedFiles :: Verbosity -> PackageDescription -> LocalBuildInfo -> IO () +genSynthezisedFiles verb pd lbi = do + + cPkgs <- getPkgConfigPackages verb lbi pd + + let xList = maybe [] (customFieldsBI . libBuildInfo) (library pd) + ++customFieldsPD pd + typeOpts :: String -> [ProgArg] + typeOpts tag = concat [ map (\val -> '-':'-':drop (length tag) field++'=':val) (words content) + | (field,content) <- xList, + tag `isPrefixOf` field, + field /= (tag++"file")] + ++ [ "--tag=" ++ tag + | PackageIdentifier name (Version (major:minor:_) _) <- cPkgs + , let name' = filter isAlpha (display name) + , tag <- name' + : [ name' ++ "-" ++ show major ++ "." ++ show digit + | digit <- [0,2..minor] ] + ] + + signalsOpts :: [ProgArg] + signalsOpts = concat [ map (\val -> '-':'-':drop 10 field++'=':val) (words content) + | (field,content) <- xList, + "x-signals-" `isPrefixOf` field, + field /= "x-signals-file"] + + genFile :: Program -> [ProgArg] -> FilePath -> IO () + genFile prog args outFile = do + res <- rawSystemProgramStdoutConf verb prog (withPrograms lbi) args + rewriteFile outFile res + + (flip mapM_) (filter (\(tag,_) -> "x-types-" `isPrefixOf` tag && "file" `isSuffixOf` tag) xList) $ + \(fileTag, f) -> do + let tag = reverse (drop 4 (reverse fileTag)) + info verb ("Ensuring that class hierarchy in "++f++" is up-to-date.") + genFile typeGenProgram (typeOpts tag) f + + case lookup "x-signals-file" xList of + Nothing -> return () + Just f -> do + info verb ("Ensuring that callback hooks in "++f++" are up-to-date.") + genFile signalGenProgram signalsOpts f + +--FIXME: Cabal should tell us the selected pkg-config package versions in the +-- LocalBuildInfo or equivalent. +-- In the mean time, ask pkg-config again. + +getPkgConfigPackages :: Verbosity -> LocalBuildInfo -> PackageDescription -> IO [PackageId] +getPkgConfigPackages verbosity lbi pkg = + sequence + [ do version <- pkgconfig ["--modversion", display pkgname] + case simpleParse version of + Nothing -> die $ "parsing output of pkg-config --modversion failed" + Just v -> return (PackageIdentifier pkgname v) + | Dependency pkgname _ <- concatMap pkgconfigDepends (allBuildInfo pkg) ] + where + pkgconfig = rawSystemProgramStdoutConf verbosity + pkgConfigProgram (withPrograms lbi) + +------------------------------------------------------------------------------ +-- Dependency calculation amongst .chs files. +------------------------------------------------------------------------------ + +-- Given all files of the package, find those that end in .chs and extract the +-- .chs files they depend upon. Then return the PackageDescription with these +-- files rearranged so that they are built in a sequence that files that are +-- needed by other files are built first. +fixDeps :: PackageDescription -> IO PackageDescription +fixDeps pd@PD.PackageDescription { + PD.library = Just lib@PD.Library { + PD.exposedModules = expMods, + PD.libBuildInfo = bi@PD.BuildInfo { + PD.hsSourceDirs = srcDirs, + PD.otherModules = othMods + }}} = do + let findModule m = findFileWithExtension [".chs.pp",".chs"] srcDirs + (joinPath (components m)) + mExpFiles <- mapM findModule expMods + mOthFiles <- mapM findModule othMods + + -- tag all exposed files with True so we throw an error if we need to build + -- an exposed module before an internal modules (we cannot express this) + let modDeps = zipWith (ModDep True []) expMods mExpFiles++ + zipWith (ModDep False []) othMods mOthFiles + modDeps <- mapM extractDeps modDeps + let (expMods, othMods) = span mdExposed $ sortTopological modDeps + badOther = map (fromMaybe "" . mdLocation) $ + filter (not . mdExposed) expMods + unless (null badOther) $ + die ("internal chs modules "++intercalate "," badOther++ + " depend on exposed chs modules; cabal needs to build internal modules first") + return pd { PD.library = Just lib { + PD.exposedModules = map mdOriginal expMods, + PD.libBuildInfo = bi { PD.otherModules = map mdOriginal othMods } + }} + +data ModDep = ModDep { + mdExposed :: Bool, + mdRequires :: [ModuleName], + mdOriginal :: ModuleName, + mdLocation :: Maybe FilePath +} + +instance Show ModDep where + show x = show (mdLocation x) + +instance Eq ModDep where + ModDep { mdOriginal = m1 } == ModDep { mdOriginal = m2 } = m1==m2 +instance Ord ModDep where + compare ModDep { mdOriginal = m1 } ModDep { mdOriginal = m2 } = compare m1 m2 + +-- Extract the dependencies of this file. This is intentionally rather naive as it +-- ignores CPP conditionals. We just require everything which means that the +-- existance of a .chs module may not depend on some CPP condition. +extractDeps :: ModDep -> IO ModDep +extractDeps md@ModDep { mdLocation = Nothing } = return md +extractDeps md@ModDep { mdLocation = Just f } = withFileContents f $ \con -> do + let findImports acc (('{':'#':xs):xxs) = case (dropWhile ((==) ' ') xs) of + ('i':'m':'p':'o':'r':'t':' ':ys) -> + case simpleParse (takeWhile ((/=) '#') ys) of + Just m -> findImports (m:acc) xxs + Nothing -> die ("cannot parse chs import in "++f++":\n"++ + "offending line is {#"++xs) + -- no more imports after the first non-import hook + _ -> return acc + findImports acc (_:xxs) = findImports acc xxs + findImports acc [] = return acc + mods <- findImports [] (lines con) + return md { mdRequires = mods } + +-- Find a total order of the set of modules that are partially sorted by their +-- dependencies on each other. The function returns the sorted list of modules +-- together with a list of modules that are required but not supplied by this +-- in the input set of modules. +sortTopological :: [ModDep] -> [ModDep] +sortTopological ms = reverse $ fst $ foldl visit ([], S.empty) (map mdOriginal ms) + where + set = M.fromList (map (\m -> (mdOriginal m, m)) ms) + visit (out,visited) m + | m `S.member` visited = (out,visited) + | otherwise = case m `M.lookup` set of + Nothing -> (out, m `S.insert` visited) + Just md -> (md:out', visited') + where + (out',visited') = foldl visit (out, m `S.insert` visited) (mdRequires md) diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,7 @@ +-- Setup file for a Gtk2Hs module. Contains only adjustments specific to this module, +-- all Gtk2Hs-specific boilerplate is stored in Gtk2HsSetup.hs which should be kept +-- identical across all modules. +import Gtk2HsSetup ( gtk2hsUserHooks ) +import Distribution.Simple ( defaultMainWithHooks ) + +main = defaultMainWithHooks gtk2hsUserHooks diff --git a/System/Gnome/GConf.hs b/System/Gnome/GConf.hs new file mode 100644 --- /dev/null +++ b/System/Gnome/GConf.hs @@ -0,0 +1,6 @@ +module System.Gnome.GConf ( + module System.Gnome.GConf.GConfClient + +) where + +import System.Gnome.GConf.GConfClient diff --git a/System/Gnome/GConf/GConfClient.chs b/System/Gnome/GConf/GConfClient.chs new file mode 100644 --- /dev/null +++ b/System/Gnome/GConf/GConfClient.chs @@ -0,0 +1,425 @@ +{-# LANGUAGE CPP, FlexibleContexts #-} +-- -*-haskell-*- +-- GIMP Toolkit (GTK) GConf API +-- +-- Author : Duncan Coutts +-- Created: 16 April 2004 +-- +-- Copyright (c) 2004 Duncan Coutts +-- +-- This library is free software; you can redistribute it and/or +-- modify it under the terms of the GNU Library 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 +-- Library General Public License for more details. +-- +-- | GConf is a system for maintaining program configuration information. +-- +-- The main difference between GConf and traditional configuration file +-- API's is that GConf is \'live\'. Applications can be notified of changes +-- in their configuration, it allows desktop wide setting +-- to be propogated without restarting all applications, or multiple instances +-- of a single application to synchronise their configuration. It is similar +-- in many ways to the Win32 Registry with its directory-like structure. +-- +-- This module only binds the client library which is the only interface that +-- normal applications should need. Only special GConf apps need lower level +-- access. +-- +-- * Some low level functions have not been bound +-- eg @gconf_client_get_for_engine@ +-- +module System.Gnome.GConf.GConfClient ( + + -- * Data types + -- + GConf, GConfPreloadType, GConfError, + + -- * Creation operation + -- + gconfGetDefault, + + -- * Registering for change notifications + -- + gconfAddDir, gconfRemoveDir, + gconfNotifyAdd, gconfNotifyRemove, + onValueChanged, afterValueChanged, + + -- * Getting and setting configuration values + -- + gconfGet, gconfSet, +-- gconfGetFloat, +-- gconfGetInt, +-- gconfGetString, +-- gconfGetBool, +-- gconfGetSchema, +-- gconfGetList, +-- gconfGetPair, + gconfGetWithoutDefault, + gconfGetDefaultFromSchema, + gconfUnset, + + -- * Caching control + -- + gconfClearCache, gconfPreload, + gconfSuggestSync, + + -- * Navigation + -- + gconfAllEntries, + gconfAllDirs, + gconfDirExists, + + -- * GConfValue + -- + GConfValueClass, + GConfPrimitiveValueClass, + GConfValue, + GConfValueDyn(..), + +) where + +import Control.Monad (liftM, when) +import Data.IORef (newIORef, readIORef, writeIORef) +import System.IO.Unsafe (unsafePerformIO) + +import System.Glib.FFI +import System.Glib.UTFString +import System.Glib.GList +import System.Glib.GError (GErrorDomain, GErrorClass(..), propagateGError) +import System.Glib.GObject (constructNewGObject) +{#import System.Gnome.GConf.Types#} +{#import System.Gnome.GConf.Signals#} +{#import System.Gnome.GConf.GConfValue#} + +{# context lib="gconf" prefix ="gconf_client" #} + +{# enum GConfClientPreloadType as GConfPreloadType {underscoreToCase} #} + +-- | The "GError" exceptions that can be thrown by functions in this module +{# enum GConfError {underscoreToCase} #} + +gconfErrorDomain :: GErrorDomain +gconfErrorDomain = unsafePerformIO {#call unsafe gconf_error_quark#} + +instance GErrorClass GConfError where + gerrorDomain _ = gconfErrorDomain + +{# pointer *GConfEntry newtype #} + +-- Operations + +-- Creation operations + +-- | Create a new GConf object using the default configuration engine. +-- +gconfGetDefault :: IO GConf +gconfGetDefault = do + -- make sure the glib type system is initialised, which it might not be if + -- we're using gconf without using gtk and initGUI. + -- It is safe to call g_type_init more than once. + {# call g_type_init #} + constructNewGObject mkGConf {# call gconf_client_get_default #} + + +-- Registering for change notifications + +-- | Add a directory to the list of directories the +-- GConf will watch. You should use gconfNotifyAdd to associate +-- change handlers with specific keys. +-- +-- * Added directories may not overlap. That is, if you add \"\/foo\", you may +-- not add \"\/foo\/bar\". However you can add \"\/foo\" and \"\/bar\". You can +-- also add \"\/foo\" multiple times; if you add a directory multiple times, it +-- will not be removed until you call 'gconfRemoveDir' an equal number of +-- times. +-- +-- * Note that the watch is recursive, all keys below the given directory will +-- be watched. So it would be a bad idea to watch the root \"\/\". +-- +gconfAddDir :: GConf -> String -> IO () +gconfAddDir gc key = gconfAddDirWithPreload gc key PreloadNone + +-- | Like 'gconfAddDir' but with the option to specify a preload mode. +-- +-- As a rule of thumb, if you plan to get the value of almost all the keys in a +-- directory, preloading that directory will probably enhance performance. If +-- you plan to use only half the keys, preloading is likely a bad idea. +-- +-- * PreloadNone specifies that no preload occurs +-- * PreloadOnelevel loads the immediate children of the directory +-- * PreloadRecursive loads all children of the directory and its +-- subdirectories, recursively. +-- +gconfAddDirWithPreload :: GConf -> String -> GConfPreloadType -> IO () +gconfAddDirWithPreload gc key preload = + propagateGError $ \gerrorPtr -> + withCString key $ \strPtr -> + {# call gconf_client_add_dir #} gc strPtr + (fromIntegral $ fromEnum preload) gerrorPtr + +-- | Remove a directory from the list created with 'gconfAddDir'. If any +-- notifications have been added below this directory with 'gconfNotifyAdd', +-- those notifications will be disabled until you re-add the removed directory. +-- +-- * Note that if a directory has been added multiple times, you must remove it +-- the same number of times before the remove takes effect. +-- +gconfRemoveDir :: GConf -> String -> IO () +gconfRemoveDir gc key = + propagateGError $ \gerrorPtr -> + withCString key $ \strPtr -> + {# call gconf_client_remove_dir #} gc strPtr gerrorPtr + + +{#pointer GFreeFunc#} + +foreign import ccall "wrapper" mkDestructor :: IO () -> IO GFreeFunc + +type GConfClientNotifyFunc = Ptr () -> --GConfClient *client + {#type guint#} -> --guint cnxn_id + Ptr () -> --GConfEntry *entry + Ptr () -> --gpointer user_data + IO () + +foreign import ccall "wrapper" mkHandler_GConfClientNotifyFunc :: + GConfClientNotifyFunc -> IO (FunPtr GConfClientNotifyFunc) + +connect_GConfClientNotifyFunc :: + GConf -> + String -> + (GConfEntry -> IO ()) -> + IO GConfConnectId +connect_GConfClientNotifyFunc gc key user = do + hPtr <- mkHandler_GConfClientNotifyFunc + (\_ _ entryPtr _ -> user (GConfEntry $ castPtr entryPtr)) + dRef <- newIORef nullFunPtr + dPtr <- mkDestructor $ do + freeHaskellFunPtr hPtr + dPtr <- readIORef dRef + freeHaskellFunPtr dPtr + writeIORef dRef dPtr + cnxId <- propagateGError $ \gerrorPtr -> + withCString key $ \strPtr -> + {# call gconf_client_notify_add #} gc strPtr + (castFunPtr hPtr) nullPtr dPtr gerrorPtr + return $ GConfConnectId cnxId + +newtype GConfConnectId = GConfConnectId {#type guint#} + +gconfNotifyAdd :: GConfValueClass value => + GConf -> + String -> + (String -> value -> IO ()) -> + IO GConfConnectId +gconfNotifyAdd gc key handler = + connect_GConfClientNotifyFunc gc key (convertValueChangedHandler handler) + where convertValueChangedHandler :: GConfValueClass value => + (String -> value -> IO ()) -> + (GConfEntry -> IO ()) + convertValueChangedHandler handler entry = do + keyStrPtr <- {# call unsafe gconf_entry_get_key #} entry + valuePtr <- {# call unsafe gconf_entry_get_value #} entry + key <- peekUTFString keyStrPtr + value <- marshalFromGConfValue (GConfValue valuePtr) + handler key value + +gconfNotifyRemove :: GConf -> GConfConnectId -> IO () +gconfNotifyRemove gc (GConfConnectId cxid) = + {# call gconf_client_notify_remove #} gc cxid + + +-- Getting and setting configuration values + +-- | Gets the value of a configuration key. +-- +gconfGet :: GConfValueClass value => GConf + -> String -- ^ Name of the key + -> IO value +gconfGet gc key = do + value <- propagateGError $ \gerrorPtr -> + withCString key $ \strPtr -> + {# call gconf_client_get #} gc strPtr gerrorPtr + marshalFromGConfValue (GConfValue value) + +gconfGetInt :: GConf -> String -> IO Int +gconfGetInt = gconfGet + +gconfGetBool :: GConf -> String -> IO Bool +gconfGetBool = gconfGet + +gconfGetFloat :: GConf -> String -> IO Double +gconfGetFloat = gconfGet + +gconfGetString :: GConf -> String -> IO String +gconfGetString = gconfGet + +gconfGetPair :: GConfValueClass (a,b) => + GConf -> String -> IO (a, b) +gconfGetPair = gconfGet + +gconfGetList :: GConfValueClass [a] => + GConf -> String -> IO [a] +gconfGetList = gconfGet + +-- | Sets the value of a configuration key. +-- +gconfSet :: GConfValueClass value => GConf + -> String -- ^ Name of the key + -> value -- ^ New value + -> IO () +gconfSet gc key val = do + value@(GConfValue ptr) <- marshalToGConfValue val + if ptr == nullPtr + then gconfUnset gc key + else propagateGError $ \gerrorPtr -> + withCString key $ \strPtr -> + {# call gconf_client_set #} gc strPtr value gerrorPtr + +gconfSetInt :: GConf -> String -> Int -> IO () +gconfSetInt = gconfSet + +gconfSetBool :: GConf -> String -> Bool -> IO () +gconfSetBool = gconfSet + +gconfSetFloat :: GConf -> String -> Double -> IO () +gconfSetFloat = gconfSet + +gconfSetString :: GConf -> String -> String -> IO () +gconfSetString = gconfSet + +gconfSetPair :: GConfValueClass (a,b) => + GConf -> String -> (a, b) -> IO () +gconfSetPair = gconfSet + +gconfSetList :: GConfValueClass [a] => + GConf -> String -> [a] -> IO () +gconfSetList = gconfSet + +-- | Gets the value of a configuration key. +-- +-- Same as 'gconfGet', but doesn't look for a default value if the key is +-- unset. +-- +gconfGetWithoutDefault :: GConfValueClass value => + GConf -> String -> IO value +gconfGetWithoutDefault gc key = do + value <- propagateGError $ \gerrorPtr -> + withCString key $ \strPtr -> + {# call gconf_client_get_without_default #} gc strPtr gerrorPtr + marshalFromGConfValue (GConfValue value) + +-- | Returns the default value stored in the key's schema, if the key has a +-- schema associated and the schema exists and the schema contains a default +-- value. Note that 'gconfSet' already returns the default value if no other +-- value is found, so normally you do not need this function. +-- +gconfGetDefaultFromSchema :: GConfValueClass value => + GConf -> String -> IO value +gconfGetDefaultFromSchema gc key = do + value <- propagateGError $ \gerrorPtr -> + withCString key $ \strPtr -> + {# call gconf_client_get_default_from_schema #} gc strPtr gerrorPtr + marshalFromGConfValue (GConfValue value) + +-- | Unsets the value of key; if key is already unset, has no effect. An error +-- of note is 'GconfErrorOverridden', indicating that the system administrator +-- has \"forced\" a value for this key. +-- +gconfUnset :: GConf -> String -> IO () +gconfUnset gc key = + propagateGError $ \gerrorPtr -> + withCString key $ \strPtr -> do + {# call gconf_client_unset #} gc strPtr gerrorPtr + return () + +-- | Dumps everything out of the GConf client-side cache. If you know you're +-- done using the GConf for a while, you can call this function to save some +-- memory. +-- +gconfClearCache :: GConf -> IO () +gconfClearCache gc = {# call gconf_client_clear_cache #} gc + +-- | Preloads a directory. Normally you do this when you call +-- 'gconfAddDirWithPreload', but if you've called 'gconfClearCache' there may +-- be a reason to do it again. +-- +gconfPreload :: GConf -> String -> GConfPreloadType -> IO () +gconfPreload gc key preload = + propagateGError $ \gerrorPtr -> + withCString key $ \strPtr -> + {# call gconf_client_preload #} gc strPtr + (fromIntegral $ fromEnum preload) gerrorPtr + +-- | Suggests to gconfd that you've just finished a block of changes, and it +-- would be an optimal time to sync to permanent storage. This is only a +-- suggestion; and gconfd will eventually sync even if you don't call +-- 'gconfSuggestSync'. This function is just a "hint" provided to gconfd to +-- maximize efficiency and minimize data loss. +-- +gconfSuggestSync :: GConf -> IO () +gconfSuggestSync gc = + propagateGError $ \gerrorPtr -> + {# call gconf_client_suggest_sync #} gc gerrorPtr + +-- | +-- +gconfAllEntries :: GConf -> String -> IO [(String, GConfValueDyn)] +gconfAllEntries gc dir = do + gsList <- propagateGError $ \gerrorPtr -> + withCString dir $ \strPtr -> + {# call gconf_client_all_entries #} gc strPtr gerrorPtr + entryList <- fromGSList gsList + mapM (\entry -> do let entry' = GConfEntry entry + keyStrPtr <- {# call unsafe gconf_entry_get_key #} entry' + valuePtr <- {# call unsafe gconf_entry_get_value #} entry' + key <- peekUTFString keyStrPtr + value <- marshalFromGConfValue (GConfValue valuePtr) + -- gconf_entry_free is depreciated, use gconf_entry_unref + -- however gconf_entry_unref is not documented and docs + -- still say to use gconf_entry_free. Confusing. + {# call unsafe gconf_entry_free #} entry' + return (key,value)) + entryList + +-- | +-- +gconfAllDirs :: GConf -> String -> IO [String] +gconfAllDirs gc dir = do + gsList <- withCString dir $ \strPtr -> + {# call gconf_client_all_dirs #} gc strPtr nullPtr + dirList <- fromGSList gsList + mapM (\strPtr -> do str <- peekUTFString strPtr + {# call unsafe g_free #} (castPtr strPtr) + return str) + dirList + +-- | +-- +gconfDirExists :: GConf -> String -> IO Bool +gconfDirExists gc dir = + withCString dir $ \strPtr -> + liftM toBool $ {# call gconf_client_dir_exists #} gc strPtr nullPtr + + +-- Signals + +onValueChanged, afterValueChanged :: GConf -> + (String -> Maybe GConfValueDyn -> IO ()) -> + IO (ConnectId GConf) +onValueChanged gc handler = + connect_STRING_PTR__NONE "value_changed" False gc + (convertValueChangedHandler handler) +afterValueChanged gc handler = + connect_STRING_PTR__NONE "value_changed" True gc + (convertValueChangedHandler handler) + +convertValueChangedHandler :: (String -> Maybe GConfValueDyn -> IO ()) -> + (String -> Ptr GConfValue -> IO ()) +convertValueChangedHandler handler key ptr = do + value <- marshalFromGConfValue (GConfValue $ castPtr ptr) + handler key value diff --git a/System/Gnome/GConf/GConfValue.chs b/System/Gnome/GConf/GConfValue.chs new file mode 100644 --- /dev/null +++ b/System/Gnome/GConf/GConfValue.chs @@ -0,0 +1,334 @@ +{-# LANGUAGE CPP, TypeSynonymInstances, OverlappingInstances, ScopedTypeVariables #-} +-- String & [a] overlap +-- -*-haskell-*- +-- GIMP Toolkit (GTK) GConf API +-- +-- Author : Duncan Coutts +-- Created: 16 April 2004 +-- +-- Copyright (c) 2004 Duncan Coutts +-- +-- This library is free software; you can redistribute it and/or +-- modify it under the terms of the GNU Library 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 +-- Library General Public License for more details. +-- +-- | +-- +-- Module for dealing with the values stored in the GConf system. +-- +-- GConfValue has its own primitive type system which is represented in +-- Haskell using type classes. This allows values to be get and set without +-- needing to perform any dynamic type casting or needing a union type. +-- +-- Alternatively, a dynamic\/union type is provided for the rare occasions +-- when that degree of flexability is required. It should only be necessary +-- if you need to deal with configuration values without statically knowing +-- their type. +-- + +module System.Gnome.GConf.GConfValue ( + GConfPrimitiveValueClass, + GConfValueClass(marshalFromGConfValue, marshalToGConfValue), + GConfValue(GConfValue), + GConfValueDyn(..), + ) where + +import Control.Monad (liftM, when) + +import System.Glib.FFI +import System.Glib.UTFString +import System.Glib.GList (toGSList, readGSList) + +--{# context lib="gconf" prefix ="gconf_value" #} +{# context lib="gconf" #} + +{# enum GConfValueType {underscoreToCase} deriving (Eq, Show) #} + +{# pointer *GConfValue newtype #} + +-- | Class of types which can be kept by GConf +class GConfValueClass value where + --unsafe because assumes non-null pointer and correct type + unsafeMarshalFromGConfValue :: GConfValue -> IO value + + -- safe checked version, may throw exception + marshalFromGConfValue :: GConfValue -> IO value + marshalFromGConfValue value = do + checkForNullAndExpectedType (typeofGConfValue (undefined::value)) value + unsafeMarshalFromGConfValue value + + typeofGConfValue :: value -> GConfValueType + + marshalToGConfValue :: value -> IO GConfValue + +-- The above methods follow the following memory management rules regarding +-- GConfValues: marshalFrom reads the value but does not gain ownership and thus +-- does not deallocate. marshalTo allocates a new value and gives up ownership; +-- it is not responsible for dellocation (it does not attach a finaliser). +-- The code that uses marshalTo must ensure that it hands the value off to a +-- function that is prepared to asume ownership of the value. + +-- | Dynamic version for when the type is not known statically. +data GConfValueDyn = GConfValueString String + | GConfValueInt Int + | GConfValueFloat Double + | GConfValueBool Bool + | GConfValueSchema -- ^ Not supported + | GConfValueList [GConfValueDyn] -- ^ Must all be of same primitive type + | GConfValuePair (GConfValueDyn, GConfValueDyn) -- ^ Must both be primitive + +-- Allow variant using Maybe, where Nothing means the value was not set +-- Use this variant when you expect the gconf key to not be set somethimes; +-- otherwise the 'raw' types will raise an exception if you get an unset key. +-- Just for consistency, setting a key to Nothing will unset the key, however +-- it is preferable to use gconfClientUnset explicitly. +instance GConfValueClass value => GConfValueClass (Maybe value) where + typeofGConfValue _ = typeofGConfValue (undefined :: value) + unsafeMarshalFromGConfValue = marshalFromGConfValue + marshalFromGConfValue value = + catch (liftM Just $ marshalFromGConfValue value) + (\_ -> return Nothing) + marshalToGConfValue (Just v) = marshalToGConfValue v + marshalToGConfValue Nothing = return $ GConfValue nullPtr + +-- The GConfValue type system says some types are primitive. +-- Compound types (lists & pairs) may only be constructed from primitive types. +class GConfValueClass value => GConfPrimitiveValueClass value +instance GConfPrimitiveValueClass Int +instance GConfPrimitiveValueClass Bool +instance GConfPrimitiveValueClass Double +instance GConfPrimitiveValueClass String + +instance GConfValueClass Int where + typeofGConfValue _ = GconfValueInt + unsafeMarshalFromGConfValue = liftM fromIntegral . {# call unsafe gconf_value_get_int #} + marshalToGConfValue n = do + value <- {# call unsafe gconf_value_new #} + (fromIntegral $ fromEnum GconfValueInt) + {# call unsafe gconf_value_set_int #} (GConfValue value) (fromIntegral n) + return (GConfValue value) + +instance GConfValueClass Bool where + typeofGConfValue _ = GconfValueBool + unsafeMarshalFromGConfValue = liftM toBool . {# call unsafe gconf_value_get_bool #} + marshalToGConfValue b = do + value <- {# call unsafe gconf_value_new #} + (fromIntegral $ fromEnum GconfValueBool) + {# call unsafe gconf_value_set_bool #} (GConfValue value) (fromBool b) + return (GConfValue value) + +instance GConfValueClass Double where + typeofGConfValue _ = GconfValueFloat + unsafeMarshalFromGConfValue = liftM realToFrac . {# call unsafe gconf_value_get_float #} + marshalToGConfValue f = do + value <- {# call unsafe gconf_value_new #} + (fromIntegral $ fromEnum GconfValueFloat) + {# call unsafe gconf_value_set_float #} (GConfValue value) (realToFrac f) + return (GConfValue value) + +-- Now unfortunately String & [a] overlap, although really they don't since Char +-- is not an instance of GConfPrimitiveValueClass, however classes are open so +-- we don't know that Char would never be an instance. I want closed classes! +instance GConfValueClass String where + typeofGConfValue _ = GconfValueString + + unsafeMarshalFromGConfValue value = do + strPtr <- {# call unsafe gconf_value_get_string #} value + peekUTFString strPtr + + marshalToGConfValue s = do + value <- {# call unsafe gconf_value_new #} + (fromIntegral $ fromEnum GconfValueString) + withCString s $ \strPtr -> + {# call unsafe gconf_value_set_string #} (GConfValue value) strPtr + return (GConfValue value) + +instance (GConfPrimitiveValueClass a, GConfPrimitiveValueClass b) => GConfValueClass (a,b) where + typeofGConfValue _ = GconfValuePair + + unsafeMarshalFromGConfValue value = do + a <- {# call unsafe gconf_value_get_car #} value + b <- {# call unsafe gconf_value_get_cdr #} value + a' <- marshalFromGConfValue (GConfValue a) + b' <- marshalFromGConfValue (GConfValue b) + return (a',b') + + marshalToGConfValue (a,b) = do + value <- {# call unsafe gconf_value_new #} + (fromIntegral $ fromEnum GconfValuePair) + a' <- marshalToGConfValue a + b' <- marshalToGConfValue b + {# call unsafe gconf_value_set_car_nocopy #} (GConfValue value) a' + {# call unsafe gconf_value_set_cdr_nocopy #} (GConfValue value) b' + return (GConfValue value) + + +instance GConfPrimitiveValueClass a => GConfValueClass [a] where + typeofGConfValue _ = GconfValueList + + unsafeMarshalFromGConfValue value = do + gsList <- {# call unsafe gconf_value_get_list #} value + valuesPtrs <- readGSList gsList + mapM (unsafeMarshalFromGConfValue . GConfValue) valuesPtrs + + marshalFromGConfValue value = do + checkForNullAndExpectedType GconfValueList value + listType <- liftM (toEnum . fromIntegral) $ + {# call unsafe gconf_value_get_list_type #} value + when (listType /= typeofGConfValue (undefined :: a)) + (fail "GConf: key is list with elements of unexpected type") + unsafeMarshalFromGConfValue value + + marshalToGConfValue list = do + value <- {# call unsafe gconf_value_new #} + (fromIntegral $ fromEnum GconfValueList) + valuesPtrs <- mapM (liftM (\(GConfValue ptr) -> ptr) . marshalToGConfValue) list + valuesList <- toGSList valuesPtrs + {# call unsafe gconf_value_set_list_type #} (GConfValue value) + (fromIntegral $ fromEnum $ typeofGConfValue (undefined::a)) + {# call unsafe gconf_value_set_list_nocopy #} (GConfValue value) valuesList + return (GConfValue value) + +---------------- +-- For convenience and best practice, an instance for Enum +-- This conforms to the GConf GTK+/Gnome convention for storing enum types, +-- which is to store them as a string using ThisStlyeOfCapitalisation. + +-- Note: currently disabled since it requires -fallow-undecidable-instances +{- +instance (Show enum, Read enum, Enum enum, GConfValueClass enum) + => GConfPrimitiveValueClass enum +instance (Show enum, Read enum, Enum enum) => GConfValueClass enum where + marshalFromGConfValue value = do + enumStr <- marshalFromGConfValue value + case reads enumStr of + [(enum,_)] -> return enum + _ -> fail "GCconf: invalid enum value" + marshalFromGConfValue' value = do + maybeEnumStr <- marshalFromGConfValue' value + case maybeEnumStr of + Nothing -> return Nothing + (Just enumStr) -> case reads enumStr of + [(enum,_)] -> return (Just enum) + _ -> return Nothing + marshalToGConfValue enum = marshalToGConfValue (show enum) + typeofGConfValue _ = GconfValueString +-} + +---------------- +-- Helper funcs + +gconfValueGetType :: GConfValue -> IO GConfValueType +--we mean the following but unfortunately c2hs barfs on 'type' +--gconfValueGetType (GConfValue valuePtr) = {# get GConfValue->type #} valuePtr +-- so instead we have the ugly: +gconfValueGetType (GConfValue valuePtr) = + liftM (toEnum . fromIntegral) $ peek (castPtr valuePtr :: Ptr CInt) +--TODO: check that sizeof(GConfValueType) == sizeof(int) + +-- returns Nothing if ok, or and error message +checkForNullAndExpectedType :: GConfValueType -> GConfValue -> IO () +checkForNullAndExpectedType expectedType value@(GConfValue ptr) + | ptr == nullPtr = fail "GConf: cannot get value of key, key is unset" + | otherwise = do valueType <- gconfValueGetType value + when (valueType /= expectedType) + (fail $ "GConf: key is of unexpected type, expected: " + ++ show expectedType ++ ", got: " ++ show valueType) + +{- +checkForNullAndExpectedType :: GConfValueType -> GConfValue -> IO GConfValue +checkForNullAndExpectedType expectedType value@(GConfValue ptr) + | ptr == nullPtr = fail "GConf: cannot get value of key, key is unset" + | otherwise = do valueType <- gconfValueGetType value + if valueType /= expectedType + then fail $ "GConf: key is of unexpected type, expected: " + ++ show expectedType ++ ", got: " ++ show valueType + else return value + +checkForNullAndExpectedType' :: GConfValueType -> GConfValue -> IO (Maybe GConfValue) +checkForNullAndExpectedType' expectedType value@(GConfValue ptr) + | ptr == nullPtr = return Nothing + | otherwise = do valueType <- gconfValueGetType value + if valueType /= expectedType + then return Nothing + else return (Just value) +-} +---------------- +-- GConfValueDyn + +unsafeMarshalGConfValueDynListFromGConfValue :: GConfValue -> IO [GConfValueDyn] +unsafeMarshalGConfValueDynListFromGConfValue value = do + gsList <- {# call unsafe gconf_value_get_list #} value + valuesPtrs <- readGSList gsList + mapM (unsafeMarshalFromGConfValue . GConfValue) valuesPtrs + +marshalGConfValueDynListToGConfValue :: [GConfValueDyn] -> IO GConfValue +marshalGConfValueDynListToGConfValue as = do + value <- {# call unsafe gconf_value_new #} + (fromIntegral $ fromEnum GconfValueList) + valuesPtrs <- mapM (liftM (\(GConfValue ptr) -> ptr) . marshalToGConfValue) as + valuesList <- toGSList valuesPtrs + {# call unsafe gconf_value_set_list_type #} (GConfValue value) + (fromIntegral $ fromEnum $ (case as of + [] -> GconfValueInvalid --unknown type + (a:_) -> gconfValueDynGetType (head as))) + {# call unsafe gconf_value_set_list_nocopy #} (GConfValue value) valuesList + return (GConfValue value) + +unsafeMarshalGConfValueDynPairFromGConfValue :: GConfValue -> IO (GConfValueDyn, GConfValueDyn) +unsafeMarshalGConfValueDynPairFromGConfValue value = do + a <- {# call unsafe gconf_value_get_car #} value + b <- {# call unsafe gconf_value_get_cdr #} value + a' <- marshalFromGConfValue (GConfValue a) + b' <- marshalFromGConfValue (GConfValue b) + return (a', b') + +marshalGConfValueDynPairToGConfValue :: (GConfValueDyn, GConfValueDyn) -> IO GConfValue +marshalGConfValueDynPairToGConfValue (a,b) = do + value <- {# call unsafe gconf_value_new #} + (fromIntegral $ fromEnum GconfValuePair) + a' <- marshalToGConfValue a + b' <- marshalToGConfValue b + {# call unsafe gconf_value_set_car_nocopy #} (GConfValue value) a' + {# call unsafe gconf_value_set_cdr_nocopy #} (GConfValue value) b' + return (GConfValue value) + +instance GConfValueClass GConfValueDyn where + typeofGConfValue _ = undefined -- will never be used + unsafeMarshalFromGConfValue value = do + valueType <- gconfValueGetType value + case valueType of + GconfValueString -> liftM GConfValueString $ unsafeMarshalFromGConfValue value + GconfValueInt -> liftM GConfValueInt $ unsafeMarshalFromGConfValue value + GconfValueFloat -> liftM GConfValueFloat $ unsafeMarshalFromGConfValue value + GconfValueBool -> liftM GConfValueBool $ unsafeMarshalFromGConfValue value + GconfValueSchema -> return GConfValueSchema + GconfValueList -> liftM GConfValueList $ unsafeMarshalGConfValueDynListFromGConfValue value + GconfValuePair -> liftM GConfValuePair $ unsafeMarshalGConfValueDynPairFromGConfValue value + + marshalFromGConfValue value@(GConfValue ptr) = do + when (ptr == nullPtr) $ fail "GConf: cannot get value of key, key is unset" + unsafeMarshalFromGConfValue value + + marshalToGConfValue v = case v of + (GConfValueString v') -> marshalToGConfValue v' + (GConfValueInt v') -> marshalToGConfValue v' + (GConfValueFloat v') -> marshalToGConfValue v' + (GConfValueBool v') -> marshalToGConfValue v' + (GConfValueSchema ) -> fail "GConf: setting schema types not supported" + (GConfValueList v') -> marshalGConfValueDynListToGConfValue v' + (GConfValuePair v') -> marshalGConfValueDynPairToGConfValue v' + +gconfValueDynGetType :: GConfValueDyn -> GConfValueType +gconfValueDynGetType (GConfValueString _) = GconfValueString +gconfValueDynGetType (GConfValueInt _) = GconfValueInt +gconfValueDynGetType (GConfValueFloat _) = GconfValueFloat +gconfValueDynGetType (GConfValueBool _) = GconfValueBool +gconfValueDynGetType (GConfValueList _) = GconfValueList +gconfValueDynGetType (GConfValuePair _) = GconfValuePair diff --git a/System/Gnome/GConf/Signals.chs b/System/Gnome/GConf/Signals.chs new file mode 100644 --- /dev/null +++ b/System/Gnome/GConf/Signals.chs @@ -0,0 +1,76 @@ +{-# OPTIONS_HADDOCK hide #-} +-- -*-haskell-*- +-- -------------------- automatically generated file - do not edit ------------ +-- Callback installers for the GIMP Toolkit (GTK) Binding for Haskell +-- +-- Author : Axel Simon +-- +-- Created: 1 July 2000 +-- +-- Copyright (C) 2000-2005 Axel Simon +-- +-- This library is free software; you can redistribute it and/or +-- modify it under the terms of the GNU Lesser General Public +-- License as published by the Free Software Foundation; either +-- version 2.1 of the License, or (at your option) any later version. +-- +-- This library is distributed in the hope that it will be useful, +-- but WITHOUT ANY WARRANTY; without even the implied warranty of +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +-- Lesser General Public License for more details. +-- +-- #hide + +-- These functions are used to connect signals to widgets. They are auto- +-- matically created through HookGenerator.hs which takes a list of possible +-- function signatures that are included in the GTK sources (gtkmarshal.list). +-- +-- The object system in the second version of GTK is based on GObject from +-- GLIB. This base class is rather primitive in that it only implements +-- ref and unref methods (and others that are not interesting to us). If +-- the marshall list mentions OBJECT it refers to an instance of this +-- GObject which is automatically wrapped with a ref and unref call. +-- Structures which are not derived from GObject have to be passed as +-- BOXED which gives the signal connect function a possibility to do the +-- conversion into a proper ForeignPtr type. In special cases the signal +-- connect function use a PTR type which will then be mangled in the +-- user function directly. The latter is needed if a signal delivers a +-- pointer to a string and its length in a separate integer. +-- +module System.Gnome.GConf.Signals ( + module System.Glib.Signals, + + connect_STRING_PTR__NONE, + + ) where + +import Control.Monad (liftM) + +import System.Glib.FFI +import System.Glib.UTFString (peekUTFString) +import System.Glib.GError (failOnGError) +{#import System.Glib.Signals#} +{#import System.Glib.GObject#} + + +{#context lib="gtk" prefix="gtk" #} + + +-- Here are the generators that turn a Haskell function into +-- a C function pointer. The fist Argument is always the widget, +-- the last one is the user g_pointer. Both are ignored. + + +connect_STRING_PTR__NONE :: + GObjectClass obj => SignalName -> + ConnectAfter -> obj -> + (String -> Ptr b -> IO ()) -> + IO (ConnectId obj) +connect_STRING_PTR__NONE signal after obj user = + connectGeneric signal after obj action + where action :: Ptr GObject -> CString -> Ptr () -> IO () + action _ str1 ptr2 = + failOnGError $ + peekUTFString str1 >>= \str1' -> + user str1' (castPtr ptr2) + diff --git a/System/Gnome/GConf/Types.chs b/System/Gnome/GConf/Types.chs new file mode 100644 --- /dev/null +++ b/System/Gnome/GConf/Types.chs @@ -0,0 +1,85 @@ +{-# OPTIONS_HADDOCK hide #-} +-- -*-haskell-*- +-- -------------------- automatically generated file - do not edit ---------- +-- Object hierarchy for the GIMP Toolkit (GTK) Binding for Haskell +-- +-- Author : Axel Simon +-- +-- Copyright (C) 2001-2005 Axel Simon +-- +-- This library is free software; you can redistribute it and/or +-- modify it under the terms of the GNU Lesser General Public +-- License as published by the Free Software Foundation; either +-- version 2.1 of the License, or (at your option) any later version. +-- +-- This library is distributed in the hope that it will be useful, +-- but WITHOUT ANY WARRANTY; without even the implied warranty of +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +-- Lesser General Public License for more details. +-- +-- #hide + +-- | +-- Maintainer : gtk2hs-users@lists.sourceforge.net +-- Stability : provisional +-- Portability : portable (depends on GHC) +-- +-- This file reflects the Gtk+ object hierarchy in terms of Haskell classes. +-- +-- Note: the mk... functions were originally meant to simply be an alias +-- for the constructor. However, in order to communicate the destructor +-- of an object to objectNew, the mk... functions are now a tuple containing +-- Haskell constructor and the destructor function pointer. This hack avoids +-- changing all modules that simply pass mk... to objectNew. +-- +module System.Gnome.GConf.Types ( + + GConf(GConf), GConfClass, + toGConf, + mkGConf, unGConf, + castToGConf, gTypeGConf + ) where + +import Foreign.ForeignPtr (ForeignPtr, castForeignPtr, unsafeForeignPtrToPtr) +import Foreign.C.Types (CULong, CUInt) +import System.Glib.GType (GType, typeInstanceIsA) +import System.Glib.GObject + +{# context lib="gtk" prefix="gtk" #} + +-- The usage of foreignPtrToPtr should be safe as the evaluation will only be +-- forced if the object is used afterwards +-- +castTo :: (GObjectClass obj, GObjectClass obj') => GType -> String + -> (obj -> obj') +castTo gtype objTypeName obj = + case toGObject obj of + gobj@(GObject objFPtr) + | typeInstanceIsA ((unsafeForeignPtrToPtr.castForeignPtr) objFPtr) gtype + -> unsafeCastGObject gobj + | otherwise -> error $ "Cannot cast object to " ++ objTypeName + + +-- ********************************************************************** GConf + +{#pointer *GConfClient as GConf foreign newtype #} deriving (Eq,Ord) + +mkGConf = (GConf, objectUnref) +unGConf (GConf o) = o + +class GObjectClass o => GConfClass o +toGConf :: GConfClass o => o -> GConf +toGConf = unsafeCastGObject . toGObject + +instance GConfClass GConf +instance GObjectClass GConf where + toGObject = GObject . castForeignPtr . unGConf + unsafeCastGObject = GConf . castForeignPtr . unGObject + +castToGConf :: GObjectClass obj => obj -> GConf +castToGConf = castTo gTypeGConf "GConf" + +gTypeGConf :: GType +gTypeGConf = + {# call fun unsafe gconf_client_get_type #} + diff --git a/gconf.cabal b/gconf.cabal new file mode 100644 --- /dev/null +++ b/gconf.cabal @@ -0,0 +1,54 @@ +Name: gconf +Version: 0.11.0 +License: GPL +License-file: COPYING +Copyright: (c) 2001-2010 The Gtk2Hs Team +Author: Duncan Coutts +Maintainer: gtk2hs-users@sourceforge.net +Build-Type: Custom +Cabal-Version: >= 1.6 +Stability: stable +homepage: http://www.haskell.org/gtk2hs/ +bug-reports: http://hackage.haskell.org/trac/gtk2hs/ +Synopsis: Binding to the GNOME configuration database system. +Description: GConf is a configuration database system for storing application + preferences. It supports default or mandatory settings set by the + administrator, and changes to the database are instantly applied to all + running applications. It is written for the GNOME desktop but doesn't + require it. +Category: System +Tested-With: GHC == 6.12.1 +Extra-Source-Files: Gtk2HsSetup.hs + marshal.list + +x-Types-File: System/Gnome/GConf/Types.chs +x-Types-Tag: gconf +x-Types-ModName: System.Gnome.GConf.Types +x-Types-Import: System.Glib.GObject + +Source-Repository head + type: darcs + location: http://code.haskell.org/gtk2hs/ + subdir: gconf + +Library + build-depends: base >= 4 && < 5, array, containers, haskell98, mtl, + glib >= 0.11 && < 0.12 + + build-tools: gtk2hsC2hs, gtk2hsHookGenerator, gtk2hsTypeGen + + exposed-modules: + System.Gnome.GConf + System.Gnome.GConf.GConfClient + other-modules: + System.Gnome.GConf.GConfValue + System.Gnome.GConf.Types + System.Gnome.GConf.Signals + + extensions: ForeignFunctionInterface + + x-Signals-File: System/Gnome/GConf/Signals.chs + x-Signals-Modname: System.Gnome.GConf.Signals + x-Signals-Types: marshal.list + x-c2hs-Header: gconf/gconf-client.h + pkgconfig-depends: gconf-2.0 >= 2.0.0 diff --git a/marshal.list b/marshal.list new file mode 100644 --- /dev/null +++ b/marshal.list @@ -0,0 +1,45 @@ +# see glib-genmarshal(1) for a detailed description of the file format, +# possible parameter types are: +# VOID indicates no return type, or no extra +# parameters. if VOID is used as the parameter +# list, no additional parameters may be present. +# BOOLEAN for boolean types (gboolean) +# CHAR for signed char types (gchar) +# UCHAR for unsigned char types (guchar) +# INT for signed integer types (gint) +# UINT for unsigned integer types (guint) +# LONG for signed long integer types (glong) +# ULONG for unsigned long integer types (gulong) +# ENUM for enumeration types (gint) +# FLAGS for flag enumeration types (guint) +# FLOAT for single-precision float types (gfloat) +# DOUBLE for double-precision float types (gdouble) +# STRING for string types (gchar*) +# BOXED for boxed (anonymous but reference counted) types (GBoxed*) +# POINTER for anonymous pointer types (gpointer) +# NONE deprecated alias for VOID +# BOOL deprecated alias for BOOLEAN + +# +# One discrepancy from Gtk+ is that for signals that may pass NULL for an object +# reference, the Haskell signal should be passed a 'Maybe GObject'. +# We therefore have two variants that are marshalled as a maybe type: +# +# OBJECT for GObject or derived types (GObject*) +# MOBJECT for GObject or derived types (GObject*) that may be NULL + +# Furthermore, some objects needs to be destroyed synchronously from the main loop of +# Gtk rather than during GC. These objects need to be marshalled using TOBJECT (for thread-safe +# object). It doesn't hurt to use TOBJECT for an object that doesn't need it, except for the +# some performance. As a rule of thumb, use TOBJECT for all libraries that build on package +# 'gtk' and use OBJECT for all packages that only need packages 'glib', 'pango', 'cairo', +# 'gio'. Again both variants exist. Note that the same names will be generated for OBJECT and +# TOBJECT, so you have to remove the OBJECT handler if you need both. +# +# TOBJECT for GObject or derived types (GObject*) +# MTOBJECT for GObject or derived types (GObject*) that may be NULL + +# If you add a new signal type, please check that it actually works! +# If it is a Boxed type check that the reference counting is right. + +NONE:STRING,POINTER