diff --git a/Examples/dbus-monitor.hs b/Examples/dbus-monitor.hs deleted file mode 100644 --- a/Examples/dbus-monitor.hs +++ /dev/null @@ -1,280 +0,0 @@ -{- - Copyright (C) 2009 John Millikin - - 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 - 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 . --} - -{-# LANGUAGE OverloadedStrings #-} - -import DBus.Address -import DBus.Authentication -import DBus.Bus -import DBus.Connection -import DBus.Constants -import DBus.Message -import DBus.Types -import DBus.Wire - -import Control.Monad -import qualified Data.Set as Set -import Data.List -import Data.Maybe -import Data.Int -import Data.Word -import Data.Text.Lazy (Text) -import qualified Data.Text.Lazy as TL -import System -import System.IO -import System.Console.GetOpt - -data Bus = Session | System - deriving (Show) - -data Option = BusOption Bus | AddressOption String - deriving (Show) - -optionInfo :: [OptDescr Option] -optionInfo = [ - Option [] ["session"] (NoArg (BusOption Session)) - "Monitor the session message bus. (default)" - , Option [] ["system"] (NoArg (BusOption System)) - "Monitor the system message bus." - , Option [] ["address"] (ReqArg AddressOption "ADDRESS") - "Connect to a particular bus address." - ] - -usage :: String -> String -usage name = "Usage: " ++ name ++ " [OPTION...]" - -findBus :: [Option] -> IO (Connection, BusName) -findBus [] = getSessionBus -findBus (o:_) = case o of - BusOption Session -> getSessionBus - BusOption System -> getSystemBus - AddressOption addr -> case mkAddresses (TL.pack addr) of - Just [x] -> getBus realUserID x - Just xs -> getFirstBus [(realUserID, addr) | addr <- xs] - _ -> error $ "Invalid address: " ++ show addr - -addMatchMsg :: String -> MethodCall -addMatchMsg match = MethodCall - { methodCallPath = dbusPath - , methodCallMember = "AddMatch" - , methodCallInterface = Just dbusInterface - , methodCallDestination = Just dbusName - , methodCallFlags = Set.empty - , methodCallBody = [toVariant match] - } - -addMatch :: Connection -> String -> IO () -addMatch c s = send c return (addMatchMsg s) >> return () - -defaultFilters :: [String] -defaultFilters = - [ "type='signal'" - , "type='method_call'" - , "type='method_return'" - , "type='error'" - ] - -onMessage :: Either UnmarshalError ReceivedMessage -> IO () -onMessage (Right msg) = putStrLn $ (TL.unpack $ formatMessage msg) ++ "\n" -onMessage (Left err) = error $ show err - -main :: IO () -main = do - args <- getArgs - let (options, userFilters, errors) = getOpt Permute optionInfo args - unless (null errors) $ do - name <- getProgName - hPutStrLn stderr $ concat errors - hPutStrLn stderr $ usageInfo (usage name) optionInfo - exitFailure - - (bus, _) <- findBus options - - let filters = if null userFilters - then defaultFilters - else userFilters - - mapM_ (addMatch bus) filters - - forever (receive bus >>= onMessage) - --- Message formatting is verbose and mostly uninteresting, except as an --- excersise in string manipulation. - -formatMessage :: ReceivedMessage -> Text - --- Method call -formatMessage (ReceivedMethodCall serial sender msg) = TL.concat - [ "method call" - , " sender=" - , fromMaybe "(null)" . fmap strBusName $ sender - , " -> dest=" - , fromMaybe "(null)" . fmap strBusName . methodCallDestination $ msg - , " serial=" - , TL.pack . show $ serial - , " path=" - , strObjectPath . methodCallPath $ msg - , "; interface=" - , fromMaybe "(null)" . fmap strInterfaceName . methodCallInterface $ msg - , "; member=" - , strMemberName . methodCallMember $ msg - , formatBody msg - ] - --- Method return -formatMessage (ReceivedMethodReturn _ sender msg) = TL.concat - [ "method return" - , " sender=" - , fromMaybe "(null)" . fmap strBusName $ sender - , " -> dest=" - , fromMaybe "(null)" . fmap strBusName . methodReturnDestination $ msg - , " reply_serial=" - , TL.pack . show . methodReturnSerial $ msg - , formatBody msg - ] - --- Error -formatMessage (ReceivedError _ sender msg) = TL.concat - [ "error" - , " sender=" - , fromMaybe "(null)" . fmap strBusName $ sender - , " -> dest=" - , fromMaybe "(null)" . fmap strBusName . errorDestination $ msg - , " error_name=" - , strErrorName . errorName $ msg - , " reply_serial=" - , TL.pack . show . errorSerial $ msg - , formatBody msg - ] - --- Signal -formatMessage (ReceivedSignal serial sender msg) = TL.concat - [ "signal" - , " sender=" - , fromMaybe "(null)" . fmap strBusName $ sender - , " -> dest=" - , fromMaybe "(null)" . fmap strBusName . signalDestination $ msg - , " serial=" - , TL.pack . show $ serial - , " path=" - , strObjectPath . signalPath $ msg - , "; interface=" - , strInterfaceName . signalInterface $ msg - , "; member=" - , strMemberName . signalMember $ msg - , formatBody msg - ] - -formatMessage (ReceivedUnknown serial sender _) = TL.concat - [ "unknown" - , " sender=" - , fromMaybe "(null)" . fmap strBusName $ sender - , " serial=" - , TL.pack . show $ serial - ] - -formatBody :: Message a => a -> Text -formatBody msg = formatted where - tree = Children $ map formatVariant body - body = messageBody msg - formatted = TL.intercalate "\n" (TL.empty : collapseTree 1 tree) - --- A string tree allows easy indentation of nested structures -data StringTree = Line Text | MultiLine [StringTree] | Children [StringTree] - deriving (Show) - -collapseTree :: Int64 -> StringTree -> [Text] -collapseTree d (Line x) = [TL.append (TL.replicate d " ") x] -collapseTree d (MultiLine xs) = concatMap (collapseTree d) xs -collapseTree d (Children xs) = concatMap (collapseTree (d + 1)) xs - --- Formatting for various kinds of variants, keyed to their signature type. -formatVariant :: Variant -> StringTree -formatVariant v = formatVariant' (variantType v) v where - -showT :: Show a => a -> Text -showT = TL.pack . show - -formatVariant' :: Type -> Variant -> StringTree - -formatVariant' DBusBoolean x = Line $ TL.append "boolean " strX where - x' = fromJust . fromVariant $ x :: Bool - strX = if x' then "true" else "false" - -formatVariant' DBusByte x = Line $ TL.append "byte " $ showT x' where - x' = fromJust . fromVariant $ x :: Word8 - -formatVariant' DBusInt16 x = Line $ TL.append "int16 " $ showT x' where - x' = fromJust . fromVariant $ x :: Int16 - -formatVariant' DBusInt32 x = Line $ TL.append "int32 " $ showT x' where - x' = fromJust . fromVariant $ x :: Int32 - -formatVariant' DBusInt64 x = Line $ TL.append "int64 " $ showT x' where - x' = fromJust . fromVariant $ x :: Int64 - -formatVariant' DBusWord16 x = Line $ TL.append "uint16 " $ showT x' where - x' = fromJust . fromVariant $ x :: Word16 - -formatVariant' DBusWord32 x = Line $ TL.append "uint32 " $ showT x' where - x' = fromJust . fromVariant $ x :: Word32 - -formatVariant' DBusWord64 x = Line $ TL.append "uint64 " $ showT x' where - x' = fromJust . fromVariant $ x :: Word64 - -formatVariant' DBusDouble x = Line $ TL.append "double " $ showT x' where - x' = fromJust . fromVariant $ x :: Double - -formatVariant' DBusString x = Line $ TL.append "string " $ showT x' where - x' = fromJust . fromVariant $ x :: String - -formatVariant' DBusObjectPath x = Line $ TL.append "object path " $ showT x' where - x' = strObjectPath . fromJust . fromVariant $ x - -formatVariant' DBusSignature x = Line $ TL.append "signature " $ showT x' where - x' = strSignature . fromJust . fromVariant $ x - -formatVariant' (DBusArray _) x = MultiLine lines' where - items = arrayItems . fromJust . fromVariant $ x - lines' = - [ Line "array [" - , Children . map formatVariant $ items - , Line "]" - ] - -formatVariant' (DBusDictionary _ _) x = MultiLine lines' where - items = dictionaryItems . fromJust . fromVariant $ x - lines' = [ Line "dictionary {" - , Children . map formatItem $ items - , Line "}" - ] - formatItem (k, v) = MultiLine $ firstLine : vTail where - Line k' = formatVariant k - v' = collapseTree 0 (formatVariant v) - vHead = head v' - vTail = map Line $ tail v' - firstLine = Line $ TL.concat [k', " -> ", vHead] - -formatVariant' (DBusStructure _) x = MultiLine lines' where - Structure items = fromJust . fromVariant $ x - lines' = - [ Line "struct (" - , Children . map formatVariant $ items - , Line ")" - ] - -formatVariant' DBusVariant x = formatVariant . fromJust . fromVariant $ x diff --git a/Examples/simple.hs b/Examples/simple.hs deleted file mode 100644 --- a/Examples/simple.hs +++ /dev/null @@ -1,64 +0,0 @@ --- Copyright (C) 2009 John Millikin --- --- 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 --- 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 . - -{-# LANGUAGE OverloadedStrings #-} -module Main (main) where - -import DBus.Bus -import DBus.Connection -import DBus.Message -import DBus.Types -import qualified Data.Set as Set -import Data.List (sort) - -main :: IO () -main = do - -- Connect to the bus, and print which name was assigned to this - -- connection. - (bus, name) <- getSessionBus - putStrLn $ "Connected as: " ++ show name - - -- Request a list of connected clients from the bus - Right serial <- send bus return $ MethodCall - { methodCallPath = "/org/freedesktop/DBus" - , methodCallMember = "ListNames" - , methodCallInterface = Just "org.freedesktop.DBus" - , methodCallDestination = Just "org.freedesktop.DBus" - , methodCallFlags = Set.empty - , methodCallBody = [] - } - - -- Wait for the reply - reply <- waitForReply bus serial - - -- Pull out the body, and convert it to [String] - let Just names = fromArray =<< fromVariant (messageBody reply !! 0) - - -- Print each name on a line, sorted so reserved names are below - -- temporary names. - mapM_ putStrLn $ sort names - -waitForReply :: Connection -> Serial -> IO MethodReturn -waitForReply bus serial = wait where - wait = do - received <- receive bus - case received of - Right (ReceivedMethodReturn _ _ ret) -> - if methodReturnSerial ret == serial - then return ret - else wait - Right _ -> wait - Left err -> error $ show err - diff --git a/License.txt b/License.txt deleted file mode 100644 --- a/License.txt +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - 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. - - - Copyright (C) - - 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 . - -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: - - Copyright (C) - 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 -. - - 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 -. diff --git a/benchmarks/Benchmarks.hs b/benchmarks/Benchmarks.hs new file mode 100644 --- /dev/null +++ b/benchmarks/Benchmarks.hs @@ -0,0 +1,125 @@ +{-# LANGUAGE OverloadedStrings #-} + +-- Copyright (C) 2010-2011 John Millikin +-- +-- 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 +-- 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 . + +module Main (benchmarks, main) where + +import Control.DeepSeq +import Criterion.Types +import Criterion.Config +import qualified Criterion.Main +import qualified Data.Set +import Data.Word (Word32) +import Unsafe.Coerce (unsafeCoerce) + +import DBus.Message +import DBus.Wire +import DBus.Types + +config :: Config +config = defaultConfig { cfgPerformGC = ljust True } + +serial :: Word32 -> Serial +serial = unsafeCoerce -- FIXME: should the Serial constructor be exposed to + -- clients? + +instance NFData Type + +instance NFData Signature where + rnf = rnf . signatureTypes + +instance NFData ObjectPath + +instance NFData InterfaceName + +instance NFData MemberName + +instance NFData ErrorName + +instance NFData BusName + +empty_MethodCall :: MethodCall +empty_MethodCall = MethodCall + { methodCallPath = "/" + , methodCallMember = "m" + , methodCallInterface = Nothing + , methodCallDestination = Nothing + , methodCallFlags = Data.Set.empty + , methodCallBody = [] + } + +empty_MethodReturn :: MethodReturn +empty_MethodReturn = MethodReturn + { methodReturnSerial = serial 0 + , methodReturnDestination = Nothing + , methodReturnBody = [] + } + +benchMarshal :: Message msg => String -> msg -> Benchmark +benchMarshal name msg = bench name (whnf marshal msg) where + marshal = marshalMessage LittleEndian (serial 0) + +benchUnmarshal :: Message msg => String -> msg -> Benchmark +benchUnmarshal name msg = bench name (whnf unmarshalMessage bytes) where + Right bytes = marshalMessage LittleEndian (serial 0) msg + +benchmarks :: [Benchmark] +benchmarks = + [ bgroup "Types" + [ bgroup "Signature" + [ bench "signature_/small" (nf signature_ "y") + , bench "signature_/medium" (nf signature_ "yyyyuua(yv)") + , bench "signature_/large" (nf signature_ "a{s(asiiiiasa(siiia{s(iiiiv)}))}") + , bench "signatureText" (nf signatureText "a{s(asiiiiasa(siiia{s(iiiiv)}))}") + ] + , bgroup "ObjectPath" + [ bench "objectPath_/small" (nf objectPath "/") + , bench "objectPath_/medium" (nf objectPath "/foo/bar") + , bench "objectPath_/large" (nf objectPath "/f0OO/b4R/baz_qux/blahblahblah") + ] + , bgroup "InterfaceName" + [ bench "interfaceName_/small" (nf interfaceName_ "f.b") + , bench "interfaceName_/medium" (nf interfaceName_ "foo.bar.baz") + , bench "interfaceName_/large" (nf interfaceName_ "f0OOO.b4R.baz_qux.blahblahblah") + ] + , bgroup "MemberName" + [ bench "memberName_/small" (nf memberName_ "f") + , bench "memberName_/medium" (nf memberName_ "FooBar") + , bench "memberName_/large" (nf memberName_ "f0OOOb4RBazQuxBlahBlahBlah") + ] + , bgroup "ErrorName" + [ bench "errorName_/small" (nf errorName_ "f.b") + , bench "errorName_/medium" (nf errorName_ "foo.bar.baz") + , bench "errorName_/large" (nf errorName_ "f0OOO.b4R.baz_qux.blahblahblah") + ] + , bgroup "BusName" + [ bench "busName_/small" (nf busName_ "f.b") + , bench "busName_/medium" (nf busName_ "foo.bar.baz") + , bench "busName_/large" (nf busName_ "f0OOO.b4R.baz-qux.blahblahblah") + ] + ] + , bgroup "Marshal" + [ benchMarshal "MethodCall/empty" empty_MethodCall + , benchMarshal "MethodReturn/empty" empty_MethodReturn + ] + , bgroup "Unmarshal" + [ benchUnmarshal "MethodCall/empty" empty_MethodCall + , benchUnmarshal "MethodReturn/empty" empty_MethodReturn + ] + ] + +main :: IO () +main = Criterion.Main.defaultMainWith config (return ()) benchmarks diff --git a/benchmarks/dbus-core-benchmarks.cabal b/benchmarks/dbus-core-benchmarks.cabal new file mode 100644 --- /dev/null +++ b/benchmarks/dbus-core-benchmarks.cabal @@ -0,0 +1,16 @@ +name: dbus-core-benchmarks +version: 0 +build-type: Simple +cabal-version: >= 1.6 + +executable dbus-core_benchmarks + main-is: Benchmarks.hs + ghc-options: -Wall -O2 -fno-warn-orphans + + build-depends: + base > 3 && < 5 + , binary + , containers + , criterion + , deepseq + , dbus-core diff --git a/dbus-core.cabal b/dbus-core.cabal --- a/dbus-core.cabal +++ b/dbus-core.cabal @@ -1,8 +1,8 @@ name: dbus-core -version: 0.8.5.4 +version: 0.9 synopsis: Low-level D-Bus protocol implementation license: GPL-3 -license-file: License.txt +license-file: license.txt author: John Millikin maintainer: jmillikin@gmail.com build-type: Simple @@ -10,23 +10,52 @@ category: Network, Desktop stability: experimental bug-reports: mailto:jmillikin@gmail.com -homepage: http://john-millikin.com/software/haskell-dbus/ +homepage: https://john-millikin.com/software/dbus-core/ tested-with: GHC==6.12.1 extra-source-files: - src/*.anansi - Examples/*.hs readme.txt + -- + examples/dbus-monitor.hs + examples/export.hs + examples/introspect.hs + examples/simple.hs + -- + latex/figure_1.svg + latex/geometry.sty + latex/noweb.sty + -- + scripts/common.bash + scripts/dist + scripts/haddock + scripts/latex + scripts/run-benchmarks + scripts/run-coverage + scripts/run-tests + -- + src/api-docs.anansi + src/client.anansi + src/connections.anansi + src/constants.anansi + src/dbus-core.anansi + src/introduction.anansi + src/introspection.anansi + src/messages.anansi + src/module-headers.anansi + src/summary.anansi + src/types.anansi + src/utilities.anansi + src/wire.anansi + -- + benchmarks/Benchmarks.hs + benchmarks/dbus-core-benchmarks.cabal + -- + tests/Tests.hs + tests/dbus-core-tests.cabal source-repository head type: bazaar - location: http://john-millikin.com/software/haskell-dbus/ - -flag test - default: False - -flag hpc - default: False + location: https://john-millikin.com/software/dbus-core/ library ghc-options: -Wall @@ -39,53 +68,32 @@ , binary >= 0.4 && < 0.6 , bytestring >= 0.9 && < 0.10 , data-binary-ieee754 >= 0.3 && < 0.5 - , text >= 0.8 && < 0.12 + , text >= 0.11.1.5 && < 0.12 , containers >= 0.1 && < 0.5 , unix >= 2.2 && < 2.5 , network >= 2.2 && < 2.4 - , libxml-sax >= 0.6 && < 0.7 - , xml-types >= 0.1 && < 0.2 + , libxml-sax >= 0.7 && < 0.8 + , xml-types >= 0.3 && < 0.4 + , vector >= 0.7 && < 0.8 exposed-modules: DBus.Address - DBus.Authentication - DBus.Bus + DBus.Client + DBus.Client.Simple DBus.Connection DBus.Constants DBus.Introspection - DBus.MatchRule DBus.Message - DBus.NameReservation DBus.Types - DBus.UUID DBus.Wire other-modules: + DBus.Client.Internal + DBus.Connection.Error + DBus.Connection.Authentication + DBus.Connection.Transport DBus.Message.Internal DBus.Types.Internal - DBus.Wire.Internal - DBus.Wire.Marshal - DBus.Wire.Unmarshal - DBus.Wire.Unicode DBus.Util DBus.Util.MonadError - -executable dbus-core-tests - main-is: Tests.hs - hs-source-dirs: hs - - if flag(test) - build-depends: - QuickCheck >= 2.2 && < 2.3 - , test-framework >= 0.2 && < 0.4 - , test-framework-quickcheck2 >= 0.2 && < 0.3 - else - buildable: False - - if flag(hpc) - ghc-options: -fhpc - - other-modules: - DBus.Types.Internal - DBus.Util - + DBus.Wire.Internal diff --git a/examples/dbus-monitor.hs b/examples/dbus-monitor.hs new file mode 100644 --- /dev/null +++ b/examples/dbus-monitor.hs @@ -0,0 +1,294 @@ +{-# LANGUAGE OverloadedStrings #-} + +-- Copyright (C) 2009-2011 John Millikin +-- +-- 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 +-- 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 . + +module Main (main) where + +import Control.Concurrent (threadDelay) +import Control.Monad +import Data.Maybe +import Data.Int +import Data.Word +import Data.Text (Text) +import qualified Data.Text +import System +import System.IO +import System.Console.GetOpt + +import DBus.Address +import DBus.Client (connect, setMessageProcessor) +import DBus.Client.Simple +import DBus.Message + +data Bus = Session | System + deriving (Show) + +data Option = BusOption Bus | AddressOption String + deriving (Show) + +optionInfo :: [OptDescr Option] +optionInfo = [ + Option [] ["session"] (NoArg (BusOption Session)) + "Monitor the session message bus. (default)" + , Option [] ["system"] (NoArg (BusOption System)) + "Monitor the system message bus." + , Option [] ["address"] (ReqArg AddressOption "ADDRESS") + "Connect to a particular bus address." + ] + +usage :: String -> String +usage name = "Usage: " ++ name ++ " [OPTION...]" + +findClient :: [Option] -> IO Client +findClient [] = connectSession +findClient (o:_) = case o of + BusOption Session -> connectSession + BusOption System -> connectSystem + AddressOption addr -> case address (Data.Text.pack addr) of + Just addr' -> connect addr' + _ -> error ("Invalid address: " ++ show addr) + +addMatch :: Proxy -> Text -> IO () +addMatch bus match = do + _ <- call bus "org.freedesktop.DBus" "AddMatch" [toVariant match] + return () + +defaultFilters :: [Text] +defaultFilters = + [ "type='signal'" + , "type='method_call'" + , "type='method_return'" + , "type='error'" + ] + +main :: IO () +main = do + args <- getArgs + let (options, userFilters, errors) = getOpt Permute optionInfo args + unless (null errors) $ do + name <- getProgName + hPutStrLn stderr (concat errors) + hPutStrLn stderr (usageInfo (usage name) optionInfo) + exitFailure + + client <- findClient options + setMessageProcessor client (\msg -> do + putStrLn (Data.Text.unpack (formatMessage msg) ++ "\n") + return False) + + let filters = if null userFilters + then defaultFilters + else map Data.Text.pack userFilters + + bus <- proxy client "org.freedesktop.DBus" "/org/freedesktop/DBus" + mapM_ (addMatch bus) filters + + -- wait forever + forever (threadDelay 50000) + +-- Message formatting is verbose and mostly uninteresting, except as an +-- excersise in string manipulation. + +showT :: Show a => a -> Text +showT = Data.Text.pack . show + +formatMessage :: ReceivedMessage -> Text + +-- Method call +formatMessage (ReceivedMethodCall serial sender msg) = Data.Text.concat + [ "method call" + , " sender=" + , fromMaybe "(null)" (fmap busNameText sender) + , " -> dest=" + , fromMaybe "(null)" (fmap busNameText (methodCallDestination msg)) + , " serial=" + , showT (serialValue serial) + , " path=" + , objectPathText (methodCallPath msg) + , "; interface=" + , fromMaybe "(null)" (fmap interfaceNameText (methodCallInterface msg)) + , "; member=" + , memberNameText (methodCallMember msg) + , formatBody msg + ] + +-- Method return +formatMessage (ReceivedMethodReturn _ sender msg) = Data.Text.concat + [ "method return" + , " sender=" + , fromMaybe "(null)" (fmap busNameText sender) + , " -> dest=" + , fromMaybe "(null)" (fmap busNameText (methodReturnDestination msg)) + , " reply_serial=" + , showT (serialValue (methodReturnSerial msg)) + , formatBody msg + ] + +-- Error +formatMessage (ReceivedError _ sender msg) = Data.Text.concat + [ "error" + , " sender=" + , fromMaybe "(null)" (fmap busNameText sender) + , " -> dest=" + , fromMaybe "(null)" (fmap busNameText (errorDestination msg)) + , " error_name=" + , errorNameText (DBus.Message.errorName msg) + , " reply_serial=" + , showT (serialValue (errorSerial msg)) + , formatBody msg + ] + +-- Signal +formatMessage (ReceivedSignal serial sender msg) = Data.Text.concat + [ "signal" + , " sender=" + , fromMaybe "(null)" (fmap busNameText sender) + , " -> dest=" + , fromMaybe "(null)" (fmap busNameText (signalDestination msg)) + , " serial=" + , showT (serialValue serial) + , " path=" + , objectPathText (signalPath msg) + , "; interface=" + , interfaceNameText (signalInterface msg) + , "; member=" + , memberNameText (signalMember msg) + , formatBody msg + ] + +formatMessage (ReceivedUnknown serial sender _) = Data.Text.concat + [ "unknown" + , " sender=" + , fromMaybe "(null)" (fmap busNameText sender) + , " serial=" + , showT (serialValue serial) + ] + +formatBody :: Message a => a -> Text +formatBody msg = formatted where + tree = Children (map formatVariant body) + body = messageBody msg + formatted = Data.Text.intercalate "\n" ("" : collapseTree 1 tree) + +-- A string tree allows easy indentation of nested structures +data StringTree = Line Text | MultiLine [StringTree] | Children [StringTree] + deriving (Show) + +collapseTree :: Int -> StringTree -> [Text] +collapseTree d (Line x) = [Data.Text.append (Data.Text.replicate d " ") x] +collapseTree d (MultiLine xs) = concatMap (collapseTree d) xs +collapseTree d (Children xs) = concatMap (collapseTree (d + 1)) xs + +-- Formatting for various kinds of variants, keyed to their signature type. +formatVariant :: Variant -> StringTree +formatVariant x = case variantType x of + + TypeBoolean -> Line $ let + Just x' = fromVariant x + strX = if x' then "true" else "false" + in Data.Text.append "boolean " strX + + TypeWord8 -> Line $ let + Just x' = fromVariant x + strX = showT (x' :: Word8) + in Data.Text.append "byte " strX + + TypeWord16 -> Line $ let + Just x' = fromVariant x + strX = showT (x' :: Word16) + in Data.Text.append "uint16 " strX + + TypeWord32 -> Line $ let + Just x' = fromVariant x + strX = showT (x' :: Word32) + in Data.Text.append "uint32 " strX + + TypeWord64 -> Line $ let + Just x' = fromVariant x + strX = showT (x' :: Word64) + in Data.Text.append "uint64 " strX + + TypeInt16 -> Line $ let + Just x' = fromVariant x + strX = showT (x' :: Int16) + in Data.Text.append "int16 " strX + + TypeInt32 -> Line $ let + Just x' = fromVariant x + strX = showT (x' :: Int32) + in Data.Text.append "int32 " strX + + TypeInt64 -> Line $ let + Just x' = fromVariant x + strX = showT (x' :: Int64) + in Data.Text.append "int64 " strX + + TypeDouble -> Line $ let + Just x' = fromVariant x + strX = showT (x' :: Double) + in Data.Text.append "double " strX + + TypeString -> Line $ let + Just x' = fromVariant x + strX = showT (x' :: Text) + in Data.Text.append "string " strX + + TypeObjectPath -> Line $ let + Just x' = fromVariant x + strX = showT (objectPathText x') + in Data.Text.append "object path " strX + + TypeSignature -> Line $ let + Just x' = fromVariant x + strX = showT (signatureText x') + in Data.Text.append "signature " strX + + TypeArray _ -> MultiLine $ let + Just x' = fromVariant x + items = arrayItems x' + lines' = [ Line "array [" + , Children (map formatVariant items) + , Line "]" + ] + in lines' + + TypeDictionary _ _ -> MultiLine $ let + Just x' = fromVariant x + items = dictionaryItems x' + lines' = [ Line "dictionary {" + , Children (map formatItem items) + , Line "}" + ] + formatItem (k, v) = MultiLine (firstLine : vTail) where + Line k' = formatVariant k + v' = collapseTree 0 (formatVariant v) + vHead = head v' + vTail = map Line (tail v') + firstLine = Line (Data.Text.concat [k', " -> ", vHead]) + in lines' + + TypeStructure _ -> MultiLine $ let + Just x' = fromVariant x + items = structureItems x' + lines' = [ Line "struct (" + , Children (map formatVariant items) + , Line ")" + ] + in lines' + + TypeVariant -> let + Just x' = fromVariant x + in formatVariant x' diff --git a/examples/export.hs b/examples/export.hs new file mode 100644 --- /dev/null +++ b/examples/export.hs @@ -0,0 +1,56 @@ +{-# LANGUAGE OverloadedStrings #-} + +-- Copyright (C) 2009-2011 John Millikin +-- +-- 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 +-- 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 . + +module Main (main) where + +import Control.Concurrent (threadDelay) +import Control.Monad (forever) +import Data.Text + +import DBus.Client.Simple + +onFoo :: Text -> Text -> IO (Text, Text) +onFoo x y = do + putStrLn ("Foo " ++ unpack x ++ " " ++ unpack y) + return (x, y) + +onBar :: Text -> Text -> IO (Text, Text) +onBar x y = do + putStrLn ("Bar " ++ unpack x ++ " " ++ unpack y) + throwError "com.example.ErrorBar" "Bar failed" [] + +main :: IO () +main = do + -- Connect to the bus + client <- connectSession + + -- Request a unique name on the bus. If the name is already + -- in use, continue without it. + _ <- requestName client "com.example.exporting" [] + + -- Export two example objects + export client "/a" + [ method "test.iface_1" "Foo" (onFoo "hello" "a") + , method "test.iface_1" "Bar" (onBar "hello" "a") + ] + export client "/b" + [ method "test.iface_1" "Foo" (onFoo "hello") + , method "test.iface_1" "Bar" (onBar "hello") + ] + + -- Wait forever for method calls + forever (threadDelay 50000) diff --git a/examples/introspect.hs b/examples/introspect.hs new file mode 100644 --- /dev/null +++ b/examples/introspect.hs @@ -0,0 +1,97 @@ +{-# LANGUAGE OverloadedStrings #-} + +-- Copyright (C) 2009-2011 John Millikin +-- +-- 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 +-- 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 . + +module Main (main) where + +import Data.String (fromString) +import qualified Data.Text +import System (getArgs, getProgName, exitFailure) +import System.IO (hPutStrLn, stderr) + +import DBus.Client.Simple +import qualified DBus.Introspection as I + +main :: IO () +main = do + args <- getArgs + (service, path) <- case args of + a1:a2:_ -> return (fromString a1, fromString a2) + _ -> do + name <- getProgName + hPutStrLn stderr ("Usage: " ++ name ++ " ") + exitFailure + client <- connectSession + printObj (introspect client service) path + +introspect :: Client -> BusName -> ObjectPath -> IO I.Object +introspect client service path = do + obj <- proxy client service path + reply <- call obj "org.freedesktop.DBus.Introspectable" "Introspect" [] + let Just xml = fromVariant (reply !! 0) + case I.fromXML path xml of + Just info -> return info + Nothing -> error ("Invalid introspection XML: " ++ show xml) + +-- most of this stuff is just boring text formatting + +printObj :: (ObjectPath -> IO I.Object) -> ObjectPath -> IO () +printObj get path = do + (I.Object _ interfaces children) <- get path + putStrLn (Data.Text.unpack (objectPathText path)) + mapM_ printIface interfaces + putStrLn "" + mapM_ (printObj get) [x | (I.Object x _ _) <- children] + +printIface :: I.Interface -> IO () +printIface (I.Interface name methods signals properties) = do + putStr " " + putStrLn (Data.Text.unpack (interfaceNameText name)) + + mapM_ printMethod methods + mapM_ printSignal signals + mapM_ printProperty properties + putStrLn "" + +printMethod :: I.Method -> IO () +printMethod (I.Method name inParams outParams) = do + putStr " method " + putStrLn (Data.Text.unpack (memberNameText name)) + + mapM_ (printParam "IN") inParams + mapM_ (printParam "OUT") outParams + +printSignal :: I.Signal -> IO () +printSignal (I.Signal name params) = do + putStr " signal " + putStrLn (Data.Text.unpack (memberNameText name)) + + mapM_ (printParam "OUT") params + +printProperty :: I.Property -> IO () +printProperty (I.Property name sig access) = do + putStr " property " + putStr (show (signatureText sig) ++ " ") + putStrLn (Data.Text.unpack name) + + putStr " " + putStrLn (show access) + +printParam :: String -> I.Parameter -> IO () +printParam label (I.Parameter name sig) = do + putStr (" [" ++ label ++ " ") + putStr (show (signatureText sig) ++ "] ") + putStrLn (Data.Text.unpack name) diff --git a/examples/simple.hs b/examples/simple.hs new file mode 100644 --- /dev/null +++ b/examples/simple.hs @@ -0,0 +1,39 @@ +{-# LANGUAGE OverloadedStrings #-} + +-- Copyright (C) 2009-2011 John Millikin +-- +-- 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 +-- 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 . + +module Main (main) where + +import Data.Text +import Data.List (sort) + +import DBus.Client.Simple + +main :: IO () +main = do + client <- connectSession + + -- Request a list of connected clients from the bus + bus <- proxy client "org.freedesktop.DBus" "/org/freedesktop/DBus" + reply <- call bus "org.freedesktop.DBus" "ListNames" [] + + -- org.freedesktop.DBus.ListNames returns a single value, which is + -- a list of names (here represented as [Text]) + let Just names = fromVariant (reply !! 0) + + -- Print each name on a line, sorted so reserved names are below + -- temporary names. + mapM_ (putStrLn . unpack) (sort names) diff --git a/hs/DBus/Address.hs b/hs/DBus/Address.hs --- a/hs/DBus/Address.hs +++ b/hs/DBus/Address.hs @@ -1,6 +1,7 @@ +{-# LANGUAGE OverloadedStrings #-} --- Copyright (C) 2009-2010 John Millikin +-- Copyright (C) 2009-2011 John Millikin -- -- 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 @@ -15,69 +16,125 @@ -- You should have received a copy of the GNU General Public License -- along with this program. If not, see . - -{-# LANGUAGE OverloadedStrings #-} - module DBus.Address ( Address , addressMethod , addressParameters - , mkAddresses - , strAddress + , address + , addresses + , addressText + + -- * Environmental addresses + , getSystem + , getSession + , getStarter ) where +import qualified Control.Exception +import Data.Char (ord, chr) +import qualified Data.Map +import Data.Map (Map) +import qualified Data.Text +import Data.Text (Text) +import qualified System.Environment +import Text.Printf (printf) +import Text.ParserCombinators.Parsec hiding (runParser) -import Data.Text.Lazy (Text) -import qualified Data.Text.Lazy as TL +import DBus.Util (hexToInt, void) +import DBus.Types.Internal (runParser) +data Address = Address Text (Map Text Text) + deriving (Eq) -import Data.Char (ord, chr) -import qualified Data.Map as M -import Text.Printf (printf) -import qualified Text.ParserCombinators.Parsec as P -import Text.ParserCombinators.Parsec ((<|>)) -import DBus.Util (hexToInt, eitherToMaybe, void) +addressMethod :: Address -> Text +addressMethod (Address x _ ) = x +addressParameters :: Address -> Map Text Text +addressParameters (Address _ x) = x + +address :: Text -> Maybe Address +address = runParser $ do + addr <- parseAddress + eof + return addr + +parseAddress :: Parser Address +parseAddress = parser where + parser = do + method <- many (noneOf ":;") + void (char ':') + params <- sepEndBy param (char ',') + return (Address + (Data.Text.pack method) + (Data.Map.fromList params)) + + param = do + key <- many1 (noneOf "=;,") + void (char '=') + value <- many1 valueChar + let pack = Data.Text.pack + return (pack key, pack value) + + valueChar = encoded <|> unencoded + encoded = do + void (char '%') + hex <- count 2 hexDigit + return (chr (hexToInt hex)) + unencoded = oneOf optionallyEncoded + optionallyEncoded :: [Char] -optionallyEncoded = ['0'..'9'] ++ ['a'..'z'] ++ ['A'..'Z'] ++ "-_/\\*." +optionallyEncoded = concat + [ ['0'..'9'] + , ['a'..'z'] + , ['A'..'Z'] + , "-_/\\*." + ] -data Address = Address - { addressMethod :: Text - , addressParameters :: M.Map Text Text - } deriving (Eq) +addresses :: Text -> Maybe [Address] +addresses = runParser $ do + xs <- sepEndBy1 parseAddress (char ';') + eof + return xs instance Show Address where - showsPrec d x = showParen (d> 10) $ - showString "Address " . shows (strAddress x) + showsPrec d x = showParen (d > 10) $ + showString "Address " . + shows (addressText x) -mkAddresses :: Text -> Maybe [Address] -mkAddresses s = eitherToMaybe . P.parse parser "" . TL.unpack $ s where - address = do - method <- P.many (P.noneOf ":;") - void (P.char ':') - params <- P.sepEndBy param (P.char ',') - return $ Address (TL.pack method) (M.fromList params) - - param = do - key <- P.many1 (P.noneOf "=;,") - void (P.char '=') - value <- P.many1 (encodedValue <|> unencodedValue) - return (TL.pack key, TL.pack value) +addressText :: Address -> Text +addressText addr = Data.Text.concat chunks where + chunks = [ addressMethod addr, ":" + , paramsText] - parser = do - as <- P.sepEndBy1 address (P.char ';') - P.eof - return as + params = addressParameters addr + paramsText = Data.Text.intercalate "," $ do + (k, v) <- Data.Map.toList params + let k' = Data.Text.unpack k + let v' = Data.Text.unpack v + let encoded = concatMap encode v' + let str = concat [k', "=", encoded] + return (Data.Text.pack str) - unencodedValue = P.oneOf optionallyEncoded - encodedValue = do - void (P.char '%') - hex <- P.count 2 P.hexDigit - return . chr . hexToInt $ hex + encode c = if elem c optionallyEncoded + then [c] + else printf "%%%02X" (ord c) -strAddress :: Address -> Text -strAddress (Address t ps) = TL.concat [t, ":", ps'] where - ps' = TL.intercalate "," $ do - (k, v) <- M.toList ps - return $ TL.concat [k, "=", TL.concatMap encode v] - encode c | elem c optionallyEncoded = TL.singleton c - | otherwise = TL.pack $ printf "%%%02X" (ord c) +getenv :: String -> IO (Maybe Text) +getenv name = Control.Exception.catch + (fmap (Just . Data.Text.pack) (System.Environment.getEnv name)) + (\(Control.Exception.SomeException _) -> return Nothing) + +getSystem :: IO (Maybe [Address]) +getSystem = do + let system = "unix:path=/var/run/dbus/system_bus_socket" + env <- getenv "DBUS_SYSTEM_BUS_ADDRESS" + return (addresses (maybe system id env)) + +getSession :: IO (Maybe [Address]) +getSession = do + env <- getenv "DBUS_SESSION_BUS_ADDRESS" + return (env >>= addresses) + +getStarter :: IO (Maybe [Address]) +getStarter = do + env <- getenv "DBUS_STARTER_BUS_ADDRESS" + return (env >>= addresses) diff --git a/hs/DBus/Authentication.hs b/hs/DBus/Authentication.hs deleted file mode 100644 --- a/hs/DBus/Authentication.hs +++ /dev/null @@ -1,98 +0,0 @@ - - --- Copyright (C) 2009-2010 John Millikin --- --- 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 --- 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 . - - -{-# LANGUAGE OverloadedStrings #-} - -{-# LANGUAGE DeriveDataTypeable #-} -module DBus.Authentication - ( Command - , Mechanism (..) - , AuthenticationError (..) - , authenticate - , realUserID - ) where - -import Data.Text.Lazy (Text) -import qualified Data.Text.Lazy as TL - - -import Data.ByteString.Lazy (ByteString) -import qualified Data.ByteString.Lazy as ByteString -import Data.ByteString.Lazy.Char8 () -import qualified DBus.UUID as UUID - -import Data.Typeable (Typeable) -import qualified Control.Exception as E - -import Data.Word (Word8) - -import Control.Monad (liftM) -import Data.Char (chr) -import Data.Text.Lazy.Encoding (encodeUtf8) -import DBus.Util (readUntil, dropEnd) - -import System.Posix.User (getRealUserID) -import Data.Char (ord) -import Text.Printf (printf) - -import Data.Maybe (isJust) - -type Command = Text -newtype Mechanism = Mechanism - { mechanismRun :: (Command -> IO Command) -> IO UUID.UUID - } - -data AuthenticationError - = AuthenticationError Text - deriving (Show, Typeable) - -instance E.Exception AuthenticationError - -authenticate :: Mechanism -> (ByteString -> IO ()) -> IO Word8 - -> IO UUID.UUID -authenticate mech put getByte = do - put $ ByteString.singleton 0 - uuid <- mechanismRun mech (putCommand put getByte) - put "BEGIN\r\n" - return uuid - -putCommand :: Monad m => (ByteString -> m ()) -> m Word8 -> Command -> m Command -putCommand put get cmd = do - let getC = liftM (chr . fromIntegral) get - put $ encodeUtf8 cmd - put "\r\n" - liftM (TL.pack . dropEnd 2) $ readUntil "\r\n" getC - -realUserID :: Mechanism -realUserID = Mechanism $ \sendCmd -> do - uid <- getRealUserID - let token = concatMap (printf "%02X" . ord) (show uid) - let cmd = "AUTH EXTERNAL " ++ token - eitherUUID <- checkOK `fmap` sendCmd (TL.pack cmd) - case eitherUUID of - Right uuid -> return uuid - Left err -> E.throwIO $ AuthenticationError err - -checkOK :: Command -> Either Text UUID.UUID -checkOK cmd = if validUUID then Right uuid else Left errorMsg where - validUUID = TL.isPrefixOf "OK " cmd && isJust maybeUUID - maybeUUID = UUID.fromHex $ TL.drop 3 cmd - Just uuid = maybeUUID - errorMsg = if TL.isPrefixOf "ERROR " cmd - then TL.drop 6 cmd - else TL.pack $ "Unexpected response: " ++ show cmd diff --git a/hs/DBus/Bus.hs b/hs/DBus/Bus.hs deleted file mode 100644 --- a/hs/DBus/Bus.hs +++ /dev/null @@ -1,130 +0,0 @@ - - --- Copyright (C) 2009-2010 John Millikin --- --- 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 --- 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 . - - -{-# LANGUAGE OverloadedStrings #-} - -module DBus.Bus - ( getBus - , getFirstBus - , getSystemBus - , getSessionBus - , getStarterBus - ) where - -import Data.Text.Lazy (Text) -import qualified Data.Text.Lazy as TL - - -import qualified Control.Exception as E -import Control.Monad (when) -import Data.Maybe (fromJust, isNothing) -import qualified Data.Set as Set -import System.Environment (getEnv) - -import qualified DBus.Address as A -import qualified DBus.Authentication as Auth -import qualified DBus.Connection as C -import DBus.Constants (dbusName, dbusPath, dbusInterface) -import qualified DBus.Message as M -import qualified DBus.Types as T -import DBus.Util (fromRight) - -busForConnection :: C.Connection -> IO (C.Connection, T.BusName) -busForConnection c = fmap ((,) c) $ sendHello c - - --- | Similar to 'C.connect', but additionally sends @Hello@ messages to the --- central bus. - -getBus :: Auth.Mechanism -> A.Address -> IO (C.Connection, T.BusName) -getBus = ((busForConnection =<<) .) . C.connect - - --- | Similar to 'C.connectFirst', but additionally sends @Hello@ messages to --- the central bus. - -getFirstBus :: [(Auth.Mechanism, A.Address)] -> IO (C.Connection, T.BusName) -getFirstBus = (busForConnection =<<) . C.connectFirst - - --- | Connect to the bus specified in the environment variable --- @DBUS_SYSTEM_BUS_ADDRESS@, or to --- @unix:path=\/var\/run\/dbus\/system_bus_socket@ if @DBUS_SYSTEM_BUS_ADDRESS@ --- is not set. - -getSystemBus :: IO (C.Connection, T.BusName) -getSystemBus = getBus' $ fromEnv `E.catch` noEnv where - defaultAddr = "unix:path=/var/run/dbus/system_bus_socket" - fromEnv = getEnv "DBUS_SYSTEM_BUS_ADDRESS" - noEnv (E.SomeException _) = return defaultAddr - - --- | Connect to the bus specified in the environment variable --- @DBUS_SESSION_BUS_ADDRESS@, which must be set. - -getSessionBus :: IO (C.Connection, T.BusName) -getSessionBus = getBus' $ getEnv "DBUS_SESSION_BUS_ADDRESS" - - --- | Connect to the bus specified in the environment variable --- @DBUS_STARTER_ADDRESS@, which must be set. - -getStarterBus :: IO (C.Connection, T.BusName) -getStarterBus = getBus' $ getEnv "DBUS_STARTER_ADDRESS" - -getBus' :: IO String -> IO (C.Connection, T.BusName) -getBus' io = do - addr <- fmap TL.pack io - case A.mkAddresses addr of - Just [x] -> getBus Auth.realUserID x - Just xs -> getFirstBus [(Auth.realUserID,x) | x <- xs] - _ -> E.throwIO $ C.InvalidAddress addr - -hello :: M.MethodCall -hello = M.MethodCall dbusPath - "Hello" - (Just dbusInterface) - (Just dbusName) - Set.empty - [] - -sendHello :: C.Connection -> IO T.BusName -sendHello c = do - serial <- fromRight `fmap` C.send c return hello - reply <- waitForReply c serial - let name = case M.methodReturnBody reply of - (x:_) -> T.fromVariant x - _ -> Nothing - - when (isNothing name) $ - E.throwIO $ E.AssertionFailed "Invalid response to Hello()" - - return . fromJust $ name - -waitForReply :: C.Connection -> M.Serial -> IO M.MethodReturn -waitForReply c serial = do - received <- C.receive c - msg <- case received of - Right x -> return x - Left _ -> E.throwIO $ E.AssertionFailed "Invalid response to Hello()" - case msg of - (M.ReceivedMethodReturn _ _ reply) -> - if M.methodReturnSerial reply == serial - then return reply - else waitForReply c serial - _ -> waitForReply c serial diff --git a/hs/DBus/Client.hs b/hs/DBus/Client.hs new file mode 100644 --- /dev/null +++ b/hs/DBus/Client.hs @@ -0,0 +1,42 @@ + + +-- Copyright (C) 2009-2011 John Millikin +-- +-- 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 +-- 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 . + +module DBus.Client + ( + -- * Clients + Client + , connect + , attach + , disconnect + , call + , call_ + + -- * Listening for signals + , MatchRule(..) + , listen + + -- * Exporting objects + , Method + , Reply(..) + , throwError + , method + , export + + -- * Other + , setMessageProcessor + ) where +import DBus.Client.Internal diff --git a/hs/DBus/Client/Internal.hs b/hs/DBus/Client/Internal.hs new file mode 100644 --- /dev/null +++ b/hs/DBus/Client/Internal.hs @@ -0,0 +1,350 @@ + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE DeriveDataTypeable #-} + +-- Copyright (C) 2009-2011 John Millikin +-- +-- 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 +-- 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 . + +module DBus.Client.Internal where +import Control.Concurrent +import Control.Exception (SomeException) +import qualified Control.Exception +import Control.Monad (forever, unless) +import Control.Monad.Fix (mfix) +import Data.IORef +import Data.List (foldl') +import qualified Data.Map +import Data.Map (Map) +import Data.Maybe (isJust, catMaybes) +import Data.Text (Text) +import qualified Data.Text +import Data.Typeable (Typeable) +import qualified Data.Set + +import DBus.Address +import qualified DBus.Connection +import DBus.Connection (Connection) +import DBus.Connection.Authentication (external) +import DBus.Connection.Transport (unix, tcp) +import DBus.Connection.Error +import qualified DBus.Constants +import DBus.Constants ( errorFailed, errorUnknownMethod + , errorInvalidParameters) +import DBus.Message +import qualified DBus.Introspection +import DBus.Types +import DBus.Types.Internal (Signature(..)) +import DBus.Util (void) + + +data Client = Client + { clientConnection :: Connection + , clientCallbacks :: MVar (Map Serial Callback) + , clientSignalHandlers :: MVar [Callback] + , clientObjects :: MVar (Map ObjectPath ObjectInfo) + , clientThreadID :: ThreadId + , clientMessageProcessor :: IORef (ReceivedMessage -> IO Bool) + } + +type Callback = (ReceivedMessage -> IO ()) + +data Reply + = ReplyReturn [Variant] + | ReplyError ErrorName [Variant] + +data Method = Method InterfaceName MemberName Signature Signature ([Variant] -> IO Reply) + +type ObjectInfo = Map InterfaceName InterfaceInfo +type InterfaceInfo = Map MemberName MemberInfo +data MemberInfo + = MemberMethod Signature Signature Callback + | MemberSignal Signature + +attach :: Connection -> IO Client +attach connection = do + callbacks <- newMVar Data.Map.empty + signalHandlers <- newMVar [] + objects <- newMVar Data.Map.empty + processor <- newIORef (\_ -> return False) + + client <- mfix $ \client -> do + threadID <- forkIO (mainLoop client) + return (Client + { clientConnection = connection + , clientCallbacks = callbacks + , clientSignalHandlers = signalHandlers + , clientObjects = objects + , clientThreadID = threadID + , clientMessageProcessor = processor + }) + + export client "/" [introspectRoot client] + + void (call_ client (MethodCall + { methodCallDestination = Just "org.freedesktop.DBus" + , methodCallMember = "Hello" + , methodCallInterface = Just "org.freedesktop.DBus" + , methodCallPath = "/org/freedesktop/DBus" + , methodCallFlags = Data.Set.empty + , methodCallBody = [] + })) + + return client + +connect :: Address -> IO Client +connect addr = do + connection <- DBus.Connection.connect [unix, tcp] [external] addr + attach connection + + +-- | Stop a 'Client'#8217;s callback thread and close its underlying socket. + +disconnect :: Client -> IO () +disconnect client = do + let connection = clientConnection client + killThread (clientThreadID client) + modifyMVar_ (clientCallbacks client) (\_ -> return Data.Map.empty) + modifyMVar_ (clientSignalHandlers client) (\_ -> return []) + modifyMVar_ (clientObjects client) (\_ -> return Data.Map.empty) + DBus.Connection.disconnect connection + +setMessageProcessor :: Client -> (ReceivedMessage -> IO Bool) -> IO () +setMessageProcessor client io = atomicModifyIORef + (clientMessageProcessor client) + (\_ -> (io, ())) + +mainLoop :: Client -> IO () +mainLoop client = forever $ do + let connection = clientConnection client + + received <- DBus.Connection.receive connection + msg <- case received of + Left err -> do + disconnect client + connectionError ("Received invalid message: " ++ show err) + Right msg -> return msg + + dispatch client msg + +dispatch :: Client -> ReceivedMessage -> IO () +dispatch client received = void . forkIO $ do + process <- readIORef (clientMessageProcessor client) + handled <- process received + + let onReply serial = do + let mvar = clientCallbacks client + maybeCB <- modifyMVar mvar $ \callbacks -> let + x = Data.Map.lookup serial callbacks + callbacks' = if isJust x + then Data.Map.delete serial callbacks + else callbacks + in return (callbacks', x) + case maybeCB of + Just cb -> void (cb received) + Nothing -> return () + + unless handled $ case received of + (ReceivedMethodReturn _ _ msg) -> onReply (methodReturnSerial msg) + (ReceivedError _ _ msg) -> onReply (errorSerial msg) + (ReceivedSignal _ _ _) -> do + handlers <- readMVar (clientSignalHandlers client) + mapM_ ($ received) handlers + (ReceivedMethodCall serial sender msg) -> do + objects <- readMVar (clientObjects client) + case findMethod objects msg of + Just io -> io received + Nothing -> send_ client + (Error errorUnknownMethod serial sender []) + (\_ -> return ()) + _ -> return () + +send_ :: Message msg => Client -> msg -> (Serial -> IO a) -> IO a +send_ client msg io = do + result <- DBus.Connection.send (clientConnection client) msg io + case result of + Right serial -> return serial + Left err -> connectionError ("Error sending message: " ++ show err) + +call :: Client -> MethodCall -> IO (Either Error MethodReturn) +call client msg = do + mvar <- newEmptyMVar + + let callback (ReceivedError _ _ err) = putMVar mvar (Left err) + callback (ReceivedMethodReturn _ _ reply) = putMVar mvar (Right reply) + callback _ = return () + + send_ client msg (\serial -> + modifyMVar_ (clientCallbacks client) (\callbacks -> + return (Data.Map.insert serial callback callbacks))) + + takeMVar mvar + +call_ :: Client -> MethodCall -> IO MethodReturn +call_ client msg = do + result <- call client msg + case result of + Left err -> connectionError ("Call failed: " ++ Data.Text.unpack (errorMessage err)) + Right ret -> return ret + +data MatchRule = MatchRule + { matchSender :: Maybe BusName + , matchDestination :: Maybe BusName + , matchPath :: Maybe ObjectPath + , matchInterface :: Maybe InterfaceName + , matchMember :: Maybe MemberName + } + deriving (Show) + +listen :: Client -> MatchRule -> (BusName -> Signal -> IO ()) -> IO () +listen client rule io = do + let handler (ReceivedSignal _ (Just sender) msg) + | checkMatchRule rule sender msg = io sender msg + handler _ = return () + + modifyMVar_ (clientSignalHandlers client) (\hs -> return (handler : hs)) + void (call_ client (MethodCall + { methodCallPath = DBus.Constants.dbusPath + , methodCallMember = "AddMatch" + , methodCallInterface = Just DBus.Constants.dbusInterface + , methodCallDestination = Just DBus.Constants.dbusName + , methodCallFlags = Data.Set.empty + , methodCallBody = [toVariant (formatMatchRule rule)] + })) + +formatMatchRule :: MatchRule -> Text +formatMatchRule rule = Data.Text.intercalate "," predicates where + predicates = catMaybes + [ f "sender" matchSender busNameText + , f "destination" matchDestination busNameText + , f "path" matchPath objectPathText + , f "interface" matchInterface interfaceNameText + , f "member" matchMember memberNameText + ] + + f :: Text -> (MatchRule -> Maybe a) -> (a -> Text) -> Maybe Text + f key get text = do + val <- fmap text (get rule) + return (Data.Text.concat [key, "='", val, "'"]) + +checkMatchRule :: MatchRule -> BusName -> Signal -> Bool +checkMatchRule rule sender msg = and + [ maybe True (== sender) (matchSender rule) + , maybe True (\x -> signalDestination msg == Just x) (matchDestination rule) + , maybe True (== signalPath msg) (matchPath rule) + , maybe True (== signalInterface msg) (matchInterface rule) + , maybe True (== signalMember msg) (matchMember rule) + ] + +data MethodError = MethodError ErrorName [Variant] + deriving (Show, Eq, Typeable) + +instance Control.Exception.Exception MethodError + + +-- | Normally, any exceptions raised while executing a method will be +-- given the generic @\"org.freedesktop.DBus.Error.Failed\"@ name. +-- 'throwError' allows the programmer to specify an error name, and provide +-- additional information to the remote application. You may use this instead +-- of 'Control.Exception.throwIO' to abort a method call. + +throwError :: ErrorName -> Text -> [Variant] -> IO a +throwError name message extra = Control.Exception.throwIO (MethodError name (toVariant message : extra)) + +method :: InterfaceName -> MemberName -> Signature -> Signature -> ([Variant] -> IO Reply) -> Method +method iface name inSig outSig io = Method iface name inSig outSig + (\vs -> Control.Exception.catch + (Control.Exception.catch + (io vs) + (\(MethodError name' vs') -> return (ReplyError name' vs'))) + (\exc -> return (ReplyError errorFailed + [toVariant (Data.Text.pack (show (exc :: SomeException)))]))) + +export :: Client -> ObjectPath -> [Method] -> IO () +export client path methods = modifyMVar_ (clientObjects client) addObject where + addObject objs = return (Data.Map.insert path info objs) + + info = foldl' addMethod Data.Map.empty (defaultIntrospect : methods) + addMethod m (Method iface name inSig outSig cb) = Data.Map.insertWith' + Data.Map.union iface + (Data.Map.fromList [(name, MemberMethod inSig outSig (wrapCB cb))]) m + + wrapCB cb (ReceivedMethodCall serial sender msg) = do + reply <- cb (methodCallBody msg) + case reply of + ReplyReturn vs -> send_ client (MethodReturn serial sender vs) (\_ -> return ()) + ReplyError name vs -> send_ client (Error name serial sender vs) (\_ -> return ()) + wrapCB _ _ = return () + + defaultIntrospect = methodIntrospect $ do + objects <- readMVar (clientObjects client) + let Just obj = Data.Map.lookup path objects + return (introspect path obj) + +findMethod :: Map ObjectPath ObjectInfo -> MethodCall -> Maybe Callback +findMethod objects msg = do + ifaceName <- methodCallInterface msg + obj <- Data.Map.lookup (methodCallPath msg) objects + iface <- Data.Map.lookup ifaceName obj + member <- Data.Map.lookup (methodCallMember msg) iface + case member of + MemberMethod _ _ io -> return io + _ -> Nothing + +introspectRoot :: Client -> Method +introspectRoot client = methodIntrospect $ do + objects <- readMVar (clientObjects client) + let paths = filter (/= "/") (Data.Map.keys objects) + let iface = "org.freedesktop.DBus.Introspectable" + let name = "Introspect" + return (DBus.Introspection.Object "/" + [DBus.Introspection.Interface iface + [DBus.Introspection.Method name + [] + [DBus.Introspection.Parameter "" "s"]] + [] []] + [DBus.Introspection.Object p [] [] | p <- paths]) + +methodIntrospect :: IO DBus.Introspection.Object -> Method +methodIntrospect get = method iface name "" "s" impl where + iface = "org.freedesktop.DBus.Introspectable" + name = "Introspect" + impl [] = do + obj <- get + let Just xml = DBus.Introspection.toXML obj + return (ReplyReturn [toVariant xml]) + impl _ = return (ReplyError errorInvalidParameters []) + +introspect :: ObjectPath -> ObjectInfo -> DBus.Introspection.Object +introspect path obj = DBus.Introspection.Object path interfaces [] where + interfaces = map introspectIface (Data.Map.toList obj) + + introspectIface (name, iface) = let + members = Data.Map.toList iface + methods = concatMap introspectMethod members + signals = concatMap introspectSignal members + in DBus.Introspection.Interface name methods signals [] + + introspectMethod (name, (MemberMethod inSig outSig _)) = + [DBus.Introspection.Method name + (map introspectParam (signatureTypes inSig)) + (map introspectParam (signatureTypes outSig))] + introspectMethod _ = [] + + introspectSignal (name, (MemberSignal sig)) = + [DBus.Introspection.Signal name + (map introspectParam (signatureTypes sig))] + introspectSignal _ = [] + + introspectParam t = DBus.Introspection.Parameter "" (Signature [t]) diff --git a/hs/DBus/Client/Simple.hs b/hs/DBus/Client/Simple.hs new file mode 100644 --- /dev/null +++ b/hs/DBus/Client/Simple.hs @@ -0,0 +1,313 @@ + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE OverlappingInstances #-} + +-- Copyright (C) 2009-2011 John Millikin +-- +-- 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 +-- 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 . + +module DBus.Client.Simple + ( + -- * Clients + Client + , connectSystem + , connectSession + , connectStarter + , disconnect + + -- * Proxies + , Proxy + , proxy + , call + , DBus.Client.Simple.listen + + -- * Name reservation + , RequestNameFlag(..) + , RequestNameReply(..) + , ReleaseNameReply(..) + , requestName + , releaseName + + -- * Exporting objects + , Method + , AutoSignature + , AutoReply + , method + , export + , throwError + + -- * Re-exported modules + , module DBus.Types + ) where + +import qualified Control.Exception +import Data.Bits ((.|.)) +import qualified Data.Text -- for haddock +import qualified Data.Set +import Data.Word (Word32) + +import DBus.Address +import DBus.Client hiding (call, method, export) +import qualified DBus.Client +import DBus.Connection.Error +import DBus.Constants (errorInvalidParameters) +import DBus.Message hiding (errorName) +import DBus.Types +import DBus.Types.Internal (checkSignature) +import DBus.Util (maybeIndex) + + +connectFirst :: [Address] -> IO Client +connectFirst addrs = loop addrs where + loop [] = connectionError (concat + [ "connectFirst: no usable" + , " addresses in " + , show addrs]) + loop (a:as) = Control.Exception.catch + (DBus.Client.connect a) + (\(ConnectionError _) -> loop as) + + +-- | Connect to the bus specified in the environment variable +-- @DBUS_SESSION_BUS_ADDRESS@, which must be set. + +connectSession :: IO Client +connectSession = do + env <- DBus.Address.getSession + case env of + Nothing -> connectionError (concat + [ "connectSession: DBUS_SESSION_BUS_ADDRESS is" + , " missing or invalid." + ]) + Just addrs -> connectFirst addrs + + +-- | Connect to the bus specified in the environment variable +-- @DBUS_SYSTEM_BUS_ADDRESS@, or to +-- @unix:path=\/var\/run\/dbus\/system_bus_socket@ if @DBUS_SYSTEM_BUS_ADDRESS@ +-- is not set. + +connectSystem :: IO Client +connectSystem = do + env <- DBus.Address.getSystem + case env of + Nothing -> connectionError (concat + [ "connectSession: DBUS_SYSTEM_BUS_ADDRESS is" + , " invalid." + ]) + Just addrs -> connectFirst addrs + + +-- | Connect to the bus specified in the environment variable +-- @DBUS_STARTER_ADDRESS@, which must be set. + +connectStarter :: IO Client +connectStarter = do + env <- DBus.Address.getStarter + case env of + Nothing -> connectionError (concat + [ "connectSession: DBUS_STARTER_BUS_ADDRESS is" + , " missing or invalid." + ]) + Just addrs -> connectFirst addrs + +data Proxy = Proxy Client BusName ObjectPath + +proxy :: Client -> BusName -> ObjectPath -> IO Proxy +proxy client dest path = return (Proxy client dest path) + +call :: Proxy -> InterfaceName -> MemberName -> [Variant] -> IO [Variant] +call (Proxy client dest path) iface member body = do + reply <- DBus.Client.call_ client $ MethodCall + { methodCallDestination = Just dest + , methodCallMember = member + , methodCallInterface = Just iface + , methodCallPath = path + , methodCallFlags = Data.Set.empty + , methodCallBody = body + } + return (methodReturnBody reply) + +listen :: Proxy -> InterfaceName -> MemberName -> (BusName -> Signal -> IO ()) -> IO () +listen (Proxy client dest path) iface member = DBus.Client.listen client (MatchRule + { matchSender = Just dest + , matchInterface = Just iface + , matchMember = Just member + , matchPath = Just path + , matchDestination = Nothing + }) + +data RequestNameFlag + = AllowReplacement + | ReplaceExisting + | DoNotQueue + deriving (Show) + +data RequestNameReply + = PrimaryOwner + | InQueue + | Exists + | AlreadyOwner + deriving (Show) + +data ReleaseNameReply + = Released + | NonExistent + | NotOwner + deriving (Show) + +encodeFlags :: [RequestNameFlag] -> Word32 +encodeFlags = foldr (.|.) 0 . map flagValue where + flagValue AllowReplacement = 0x1 + flagValue ReplaceExisting = 0x2 + flagValue DoNotQueue = 0x4 + +requestName :: Client -> BusName -> [RequestNameFlag] -> IO RequestNameReply +requestName client name flags = do + bus <- proxy client "org.freedesktop.DBus" "/org/freedesktop/DBus" + reply <- call bus "org.freedesktop.DBus" "RequestName" + [ toVariant name + , toVariant (encodeFlags flags) + ] + case (maybeIndex reply 0 >>= fromVariant :: Maybe Word32) of + Just 1 -> return PrimaryOwner + Just 2 -> return InQueue + Just 3 -> return Exists + Just 4 -> return AlreadyOwner + _ -> connectionError "Call failed: received invalid reply" + +releaseName :: Client -> BusName -> IO ReleaseNameReply +releaseName client name = do + bus <- proxy client "org.freedesktop.DBus" "/org/freedesktop/DBus" + reply <- call bus "org.freedesktop.DBus" "ReleaseName" + [ toVariant name + ] + case (maybeIndex reply 0 >>= fromVariant :: Maybe Word32) of + Just 1 -> return Released + Just 2 -> return NonExistent + Just 3 -> return NotOwner + _ -> connectionError "Call failed: received invalid reply" + + +-- | Used to automatically generate method signatures for introspection +-- documents. To support automatic signatures, a method#8217;s parameters and +-- return value must all be instances of 'IsValue'. +-- +-- This class maps Haskell idioms to D‐Bus; it is therefore unable to +-- generate some signatures. In particular, it does not support methods +-- which accept/return a single structure, or single‐element structures. +-- It also cannot generate signatures for methods with parameters or return +-- values which are only instances of 'IsVariant'. For these cases, please +-- use 'DBus.Client.method'. +-- +-- To match common Haskell use, if the return value is a tuple, it will be +-- converted to a list of return values. + +class AutoSignature a where + funTypes :: a -> ([Type], [Type]) + +instance AutoSignature (IO ()) where + funTypes _ = ([], []) + +instance IsValue a => AutoSignature (IO a) where + funTypes io = ([], case ioT io undefined of + (_, t) -> case t of + TypeStructure ts -> ts + _ -> [t]) + +ioT :: IsValue a => IO a -> a -> (a, Type) +ioT _ a = (a, typeOf a) + +instance (IsValue a, AutoSignature fun) => AutoSignature (a -> fun) where + funTypes fn = case valueT undefined of + (a, t) -> case funTypes (fn a) of + (ts, ts') -> (t : ts, ts') + +valueT :: IsValue a => a -> (a, Type) +valueT a = (a, typeOf a) + + +-- | Used to automatically generate a 'Reply' from a return value. See +-- 'AutoSignature' for some caveats about supported signatures. +-- +-- To match common Haskell use, if the return value is a tuple, it will be +-- converted to a list of return values. + +class AutoReply fun where + apply :: fun -> [Variant] -> Maybe (IO [Variant]) + +instance AutoReply (IO ()) where + apply io [] = Just (io >> return []) + apply _ _ = Nothing + +instance IsVariant a => AutoReply (IO a) where + apply io [] = Just (do + var <- fmap toVariant io + case fromVariant var of + Just struct -> return (structureItems struct) + Nothing -> return [var]) + apply _ _ = Nothing + +instance (IsVariant a, AutoReply fun) => AutoReply (a -> fun) where + apply _ [] = Nothing + apply fn (v:vs) = case fromVariant v of + Just v' -> apply (fn v') vs + Nothing -> Nothing + + +-- | Prepare a Haskell function for export. This automatically detects the +-- function#8217;s type signature; see 'AutoSignature' and 'AutoReply'. +-- +-- To manage the type signature and marshaling yourself, use +-- 'DBus.Client.method' instead. + +method :: (AutoSignature fun, AutoReply fun) => InterfaceName -> MemberName -> fun -> Method +method iface name fun = DBus.Client.method iface name inSig outSig io where + (typesIn, typesOut) = funTypes fun + inSig = case checkSignature typesIn of + Just sig -> sig + Nothing -> invalid "input" + outSig = case checkSignature typesOut of + Just sig -> sig + Nothing -> invalid "output" + io vs = case apply fun vs of + Nothing -> return (ReplyError errorInvalidParameters []) + Just io' -> fmap ReplyReturn io' + + invalid label = error (concat + [ "Method " + , Data.Text.unpack (interfaceNameText iface) + , "." + , Data.Text.unpack (memberNameText name) + , " has an invalid " + , label + , " signature."]) + + +-- | Export the given functions under the given 'ObjectPath' and +-- 'InterfaceName'. The functions may accept/return any types that are +-- instances of 'IsValue'; see 'AutoSignature'. +-- +-- @ +--sayHello :: Text -> IO Text +--sayHello name = return ('Data.Text.concat' [\"Hello \", name, \"!\"]) +-- +--export client \"/hello_world\" +-- [ 'method' \"com.example.HelloWorld\" \"Hello\" sayHello +-- ] +-- @ + +export :: Client -> ObjectPath -> [Method] -> IO () +export = DBus.Client.export diff --git a/hs/DBus/Connection.hs b/hs/DBus/Connection.hs --- a/hs/DBus/Connection.hs +++ b/hs/DBus/Connection.hs @@ -1,6 +1,7 @@ +{-# LANGUAGE OverloadedStrings #-} --- Copyright (C) 2009-2010 John Millikin +-- Copyright (C) 2009-2011 John Millikin -- -- 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 @@ -15,242 +16,117 @@ -- You should have received a copy of the GNU General Public License -- along with this program. If not, see . - -{-# LANGUAGE OverloadedStrings #-} - -{-# LANGUAGE DeriveDataTypeable #-} -module DBus.Connection ( - - Connection - , connectionAddress - , connectionUUID - - , ConnectionError (..) - +module DBus.Connection + ( Connection + , ConnectionError , connect - , connectFirst - - , connectionClose - + , disconnect , send - , receive - + + -- * Authentication + , Mechanism + , mechanism + , external + + -- * Transports + , Transport + , Socket + , transport + , socket + , socketPut + , socketGet + + , unix + , tcp ) where +import Control.Concurrent +import Control.Monad (when) +import Data.IORef -import Data.Text.Lazy (Text) -import qualified Data.Text.Lazy as TL +import DBus.Address +import DBus.Connection.Authentication +import DBus.Connection.Error +import DBus.Connection.Transport +import DBus.Message.Internal +import DBus.Wire +import DBus.Wire.Internal (unmarshalMessageM) -import qualified Control.Concurrent as C -import qualified DBus.Address as A -import qualified DBus.Message as M -import qualified DBus.UUID as UUID -import qualified Data.ByteString.Lazy as L -import Data.Word (Word32) - -import qualified Network as N -import qualified Data.Map as Map - -import qualified Network.Socket as NS - -import qualified Text.ParserCombinators.Parsec as P -import Control.Monad (unless) -import Data.Binary.Get (runGet, getWord16host) -import Data.Binary.Put (runPut, putWord16be) - -import qualified System.IO as I - -import qualified Control.Exception as E -import Data.Typeable (Typeable) - -import qualified DBus.Authentication as Auth - -import qualified DBus.Wire as W +-- | A 'Connection' is an opaque handle to an open D‐Bus channel, with +-- an internal state for maintaining the current message serial. data Connection = Connection - { connectionAddress :: A.Address - , connectionTransport :: Transport - , connectionSerialMVar :: C.MVar M.Serial - , connectionReadMVar :: C.MVar () - , connectionUUID :: UUID.UUID + { connectionAddress :: Address + , connectionSocket :: Socket + , connectionSerial :: IORef Serial + , connectionReadLock :: MVar () + , connectionWriteLock :: MVar () } -instance Show Connection where - showsPrec d con = showParen (d > 10) strCon where - addr = A.strAddress $ connectionAddress con - strCon = s "" - s = showString - --- | A 'Transport' is anything which can send and receive bytestrings, --- typically via a socket. - -data Transport = Transport - { transportSend :: L.ByteString -> IO () - , transportRecv :: Word32 -> IO L.ByteString - , transportClose :: IO () - } - -connectTransport :: A.Address -> IO Transport -connectTransport a = transport' (A.addressMethod a) a where - transport' "unix" = unix - transport' "tcp" = tcp - transport' _ = E.throwIO . UnknownMethod - -unix :: A.Address -> IO Transport -unix a = port >>= N.connectTo "localhost" >>= handleTransport where - params = A.addressParameters a - path = Map.lookup "path" params - abstract = Map.lookup "abstract" params - - tooMany = "Only one of `path' or `abstract' may be specified for the\ - \ `unix' transport." - tooFew = "One of `path' or `abstract' must be specified for the\ - \ `unix' transport." - - port = fmap N.UnixSocket path' - path' = case (path, abstract) of - (Just _, Just _) -> E.throwIO $ BadParameters a tooMany - (Nothing, Nothing) -> E.throwIO $ BadParameters a tooFew - (Just x, Nothing) -> return $ TL.unpack x - (Nothing, Just x) -> return $ '\x00' : TL.unpack x - -tcp :: A.Address -> IO Transport -tcp a = openHandle >>= handleTransport where - params = A.addressParameters a - openHandle = do - port <- getPort - family <- getFamily - addresses <- getAddresses family - socket <- openSocket port addresses - NS.socketToHandle socket I.ReadWriteMode - - hostname = maybe "localhost" TL.unpack $ Map.lookup "host" params - - unknownFamily x = TL.concat ["Unknown socket family for TCP transport: ", x] - getFamily = case Map.lookup "family" params of - Just "ipv4" -> return NS.AF_INET - Just "ipv6" -> return NS.AF_INET6 - Nothing -> return NS.AF_UNSPEC - Just x -> E.throwIO $ BadParameters a $ unknownFamily x - - missingPort = "TCP transport requires the ``port'' parameter." - badPort x = TL.concat ["Invalid socket port for TCP transport: ", x] - getPort = case Map.lookup "port" params of - Nothing -> E.throwIO $ BadParameters a missingPort - Just x -> case P.parse parseWord16 "" (TL.unpack x) of - Right x' -> return $ NS.PortNum x' - Left _ -> E.throwIO $ BadParameters a $ badPort x - - parseWord16 = do - chars <- P.many1 P.digit - P.eof - let value = read chars :: Integer - unless (value > 0 && value <= 65535) $ - -- Calling 'fail' is acceptable here, because Parsec 2 - -- offers no other error reporting mechanism, and - -- implements 'fail'. - fail "bad port" - let word = fromIntegral value - return $ runGet getWord16host (runPut (putWord16be word)) - - getAddresses family = do - let hints = NS.defaultHints - { NS.addrFlags = [NS.AI_ADDRCONFIG] - , NS.addrFamily = family - , NS.addrSocketType = NS.Stream - } - NS.getAddrInfo (Just hints) (Just hostname) Nothing - - setPort port (NS.SockAddrInet _ x) = NS.SockAddrInet port x - setPort port (NS.SockAddrInet6 _ x y z) = NS.SockAddrInet6 port x y z - setPort _ addr = addr - - openSocket _ [] = E.throwIO $ NoWorkingAddress [a] - openSocket port (addr:addrs) = E.catch (openSocket' port addr) $ - \(E.SomeException _) -> openSocket port addrs - openSocket' port addr = do - sock <- NS.socket (NS.addrFamily addr) - (NS.addrSocketType addr) - (NS.addrProtocol addr) - NS.connect sock . setPort port . NS.addrAddress $ addr - return sock - -handleTransport :: I.Handle -> IO Transport -handleTransport h = do - I.hSetBuffering h I.NoBuffering - I.hSetBinaryMode h True - return $ Transport (L.hPut h) (L.hGet h . fromIntegral) (I.hClose h) - -data ConnectionError - = InvalidAddress Text - | BadParameters A.Address Text - | UnknownMethod A.Address - | NoWorkingAddress [A.Address] - deriving (Show, Typeable) - -instance E.Exception ConnectionError - - -- | Open a connection to some address, using a given authentication -- mechanism. If the connection fails, a 'ConnectionError' will be thrown. -connect :: Auth.Mechanism -> A.Address -> IO Connection -connect mechanism a = do - t <- connectTransport a - let getByte = L.head `fmap` transportRecv t 1 - uuid <- Auth.authenticate mechanism (transportSend t) getByte - readLock <- C.newMVar () - serialMVar <- C.newMVar M.firstSerial - return $ Connection a t serialMVar readLock uuid - - --- | Try to open a connection to various addresses, returning the first --- connection which could be successfully opened. - -connectFirst :: [(Auth.Mechanism, A.Address)] -> IO Connection -connectFirst orig = connectFirst' orig where - allAddrs = [a | (_, a) <- orig] - connectFirst' [] = E.throwIO $ NoWorkingAddress allAddrs - connectFirst' ((mech, a):as) = E.catch (connect mech a) $ - \(E.SomeException _) -> connectFirst' as +connect :: [Transport] -> [Mechanism] -> Address -> IO Connection +connect transports mechanisms addr = do + msock <- connectTransport transports addr + sock <- case msock of + Just s -> return s + Nothing -> connectionError (concat + [ "Unknown address method: " + , show (addressMethod addr) + ]) + authed <- authenticate sock mechanisms + when (not authed) + (connectionError "Authentication failed") + + serial <- newIORef (Serial 1) + readLock <- newMVar () + writeLock <- newMVar () + return (Connection addr sock serial + readLock writeLock) -- | Close an open connection. Once closed, the 'Connection' is no longer -- valid and must not be used. -connectionClose :: Connection -> IO () -connectionClose = transportClose . connectionTransport +disconnect :: Connection -> IO () +disconnect = socketClose . connectionSocket +instance Show Connection where + showsPrec _ x = + showString "" --- | Send a single message, with a generated 'M.Serial'. The second parameter + +-- | Send a single message, with a generated 'Serial'. The second parameter -- exists to prevent race conditions when registering a reply handler; it --- receives the serial the message /will/ be sent with, before it's actually --- sent. +-- receives the serial the message /will/ be sent with, before it’s +-- actually sent. -- -- Only one message may be sent at a time; if multiple threads attempt to -- send messages in parallel, one will block until after the other has -- finished. -send :: M.Message a => Connection -> (M.Serial -> IO b) -> a - -> IO (Either W.MarshalError b) -send (Connection _ t mvar _ _) io msg = withSerial mvar $ \serial -> - case W.marshalMessage W.LittleEndian serial msg of +send :: Message msg => Connection -> msg -> (Serial -> IO a) -> IO (Either MarshalError a) +send connection msg io = do + serial <- nextSerial connection + case marshalMessage LittleEndian serial msg of Right bytes -> do - x <- io serial - transportSend t bytes - return $ Right x - Left err -> return $ Left err + let sock = connectionSocket connection + let lock = connectionWriteLock connection + result <- io serial + withMVar lock (\_ -> socketPut sock bytes) + return (Right result) + Left err -> return (Left err) -withSerial :: C.MVar M.Serial -> (M.Serial -> IO a) -> IO a -withSerial m io = E.block $ do - s <- C.takeMVar m - let s' = M.nextSerial s - x <- E.unblock (io s) `E.onException` C.putMVar m s' - C.putMVar m s' - return x +nextSerial :: Connection -> IO Serial +nextSerial connection = atomicModifyIORef + (connectionSerial connection) + (\serial@(Serial x) -> (Serial (x + 1), serial)) -- | Receive the next message from the connection, blocking until one is @@ -260,6 +136,8 @@ -- to receive messages in parallel, one will block until after the other has -- finished. -receive :: Connection -> IO (Either W.UnmarshalError M.ReceivedMessage) -receive (Connection _ t _ lock _) = C.withMVar lock $ \_ -> - W.unmarshalMessage $ transportRecv t +receive :: Connection -> IO (Either UnmarshalError ReceivedMessage) +receive connection = do + let sock = connectionSocket connection + let lock = connectionReadLock connection + withMVar lock (\_ -> unmarshalMessageM (socketGet sock)) diff --git a/hs/DBus/Connection/Authentication.hs b/hs/DBus/Connection/Authentication.hs new file mode 100644 --- /dev/null +++ b/hs/DBus/Connection/Authentication.hs @@ -0,0 +1,90 @@ + + +-- Copyright (C) 2009-2011 John Millikin +-- +-- 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 +-- 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 . + +module DBus.Connection.Authentication + ( Mechanism + , mechanism + , authenticate + , external + ) where + +import Prelude hiding (getLine, head) +import Control.Monad (liftM) +import qualified Data.ByteString +import qualified Data.ByteString.Char8 +import Data.Char (ord) +import qualified System.Posix.User +import Text.Printf (printf) + +import DBus.Connection.Transport +import DBus.Util (readUntil, dropEnd) + + +authenticate :: Socket + -> [Mechanism] + -> IO Bool +authenticate s mechanisms = do + socketPut s (Data.ByteString.pack [0]) + let loop [] = return False + loop ((Mechanism m):next) = do + success <- m s + if success + then return True + else loop next + loop mechanisms + +newtype Mechanism = Mechanism (Socket -> IO Bool) + +mechanism :: (Socket -> IO Bool) -> Mechanism +mechanism = Mechanism + +data Auth a = Auth + { unAuth :: Socket -> IO a + } + +instance Monad Auth where + return a = Auth (\_ -> return a) + m >>= k = Auth $ \s -> do + x <- unAuth m s + unAuth (k x) s + +liftIO :: IO a -> Auth a +liftIO io = Auth (\_ -> io) + +putLine :: String -> Auth () +putLine line = Auth $ \s -> do + let pack = Data.ByteString.Char8.pack + socketPut s (pack (line ++ "\r\n")) + +getLine :: Auth String +getLine = Auth $ \s -> do + let head = Data.ByteString.Char8.head + let getchr = liftM head (socketGet s 1) + raw <- readUntil "\r\n" getchr + return (dropEnd 2 raw) + +external :: Mechanism +external = Mechanism $ unAuth $ do + uid <- liftIO System.Posix.User.getRealUserID + let token = concatMap (printf "%02X" . ord) (show uid) + putLine ("AUTH EXTERNAL " ++ token) + resp <- getLine + case takeWhile (/= ' ') resp of + "OK" -> do + putLine "BEGIN" + return True + _ -> return False diff --git a/hs/DBus/Connection/Error.hs b/hs/DBus/Connection/Error.hs new file mode 100644 --- /dev/null +++ b/hs/DBus/Connection/Error.hs @@ -0,0 +1,29 @@ + +{-# LANGUAGE DeriveDataTypeable #-} + +-- Copyright (C) 2009-2011 John Millikin +-- +-- 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 +-- 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 . + +module DBus.Connection.Error where +import Control.Exception (Exception, throwIO) +import Data.Typeable (Typeable) + +newtype ConnectionError = ConnectionError String + deriving (Show, Eq, Typeable) + +instance Exception ConnectionError + +connectionError :: String -> IO a +connectionError = throwIO . ConnectionError diff --git a/hs/DBus/Connection/Transport.hs b/hs/DBus/Connection/Transport.hs new file mode 100644 --- /dev/null +++ b/hs/DBus/Connection/Transport.hs @@ -0,0 +1,178 @@ + +{-# LANGUAGE OverloadedStrings #-} + +-- Copyright (C) 2009-2011 John Millikin +-- +-- 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 +-- 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 . + +module DBus.Connection.Transport + ( Transport + , transport + , Socket + , socket + , socketPut + , socketGet + , socketClose + , tcp + , unix + , connectTransport + ) where + +import qualified Control.Exception +import Control.Monad (unless) +import qualified Data.Binary.Get +import qualified Data.Binary.Put +import qualified Data.ByteString +import Data.ByteString (ByteString) +import qualified Data.Map +import qualified Data.Text +import Data.Text (Text) +import Data.Word (Word32) +import qualified Network +import qualified Network.Socket +import qualified System.IO +import Text.ParserCombinators.Parsec + +import DBus.Address +import DBus.Connection.Error + + + +-- | A 'Transport' is anything which can send and receive bytestrings, +-- typically via a socket. + +data Transport = Transport Text (Address -> IO Socket) + +data Socket = Socket + (ByteString -> IO ()) + (Word32 -> IO ByteString) + (IO ()) + +transport :: Text -> (Address -> IO Socket) -> Transport +transport = Transport + +socket :: (ByteString -> IO ()) -> (Word32 -> IO ByteString) -> IO () -> Socket +socket = Socket + +socketPut :: Socket -> ByteString -> IO () +socketPut (Socket x _ _) = x + +socketGet :: Socket -> Word32 -> IO ByteString +socketGet (Socket _ x _) = x + +socketClose :: Socket -> IO () +socketClose (Socket _ _ x) = x + +connectTransport :: [Transport] -> Address -> IO (Maybe Socket) +connectTransport transports addr = loop transports where + m = addressMethod addr + loop [] = return Nothing + loop ((Transport n io):ts) = if n == m + then fmap Just (io addr) + else loop ts + +connectHandle :: System.IO.Handle -> IO Socket +connectHandle h = do + System.IO.hSetBuffering h System.IO.NoBuffering + System.IO.hSetBinaryMode h True + return (Socket + (Data.ByteString.hPut h) + (Data.ByteString.hGet h . fromIntegral) + (System.IO.hClose h)) + +unix :: Transport +unix = transport "unix" connectUNIX + +connectUNIX :: Address -> IO Socket +connectUNIX a = getHandle >>= connectHandle where + params = addressParameters a + param key = Data.Map.lookup key params + + tooMany = "Only one of `path' or `abstract' may be specified for the\ + \ `unix' transport." + tooFew = "One of `path' or `abstract' must be specified for the\ + \ `unix' transport." + + path = case (param "path", param "abstract") of + (Just _, Just _) -> connectionError tooMany + (Nothing, Nothing) -> connectionError tooFew + (Just x, Nothing) -> return (Data.Text.unpack x) + (Nothing, Just x) -> return ('\x00' : Data.Text.unpack x) + + getHandle = do + port <- fmap Network.UnixSocket path + Network.connectTo "localhost" port + +tcp :: Transport +tcp = Transport "tcp" connectTCP + +connectTCP :: Address -> IO Socket +connectTCP a = getHandle >>= connectHandle where + params = addressParameters a + param key = Data.Map.lookup key params + + getHandle = do + port <- getPort + family <- getFamily + addrs <- getAddresses family + sock<- openSocket port addrs + Network.Socket.socketToHandle sock System.IO.ReadWriteMode + hostname = maybe "localhost" Data.Text.unpack (param "host") + unknownFamily x = concat ["Unknown socket family for TCP transport: ", show x] + getFamily = case param "family" of + Just "ipv4" -> return Network.Socket.AF_INET + Just "ipv6" -> return Network.Socket.AF_INET6 + Nothing -> return Network.Socket.AF_UNSPEC + Just x -> connectionError (unknownFamily x) + missingPort = "TCP transport requires the `port' parameter." + badPort x = concat ["Invalid socket port for TCP transport: ", show x] + getPort = case param "port" of + Nothing -> connectionError missingPort + Just x -> case parse parseWord16 "" (Data.Text.unpack x) of + Right x' -> return (Network.Socket.PortNum x') + Left _ -> connectionError (badPort x) + + parseWord16 = do + chars <- many1 digit + eof + let value = read chars :: Integer + unless (value > 0 && value <= 65535) $ + -- Calling 'fail' is acceptable here, because Parsec 2 + -- offers no other error reporting mechanism, and + -- implements 'fail'. + fail "bad port" + let word = fromIntegral value + return (Data.Binary.Get.runGet Data.Binary.Get.getWord16host (Data.Binary.Put.runPut (Data.Binary.Put.putWord16be word))) + + getAddresses family = do + let hints = Network.Socket.defaultHints + { Network.Socket.addrFlags = [Network.Socket.AI_ADDRCONFIG] + , Network.Socket.addrFamily = family + , Network.Socket.addrSocketType = Network.Socket.Stream + } + Network.Socket.getAddrInfo (Just hints) (Just hostname) Nothing + + setPort port (Network.Socket.SockAddrInet _ x) = Network.Socket.SockAddrInet port x + setPort port (Network.Socket.SockAddrInet6 _ x y z) = Network.Socket.SockAddrInet6 port x y z + setPort _ addr = addr + + openSocket _ [] = connectionError ("Failed to open socket to address " ++ show a) + openSocket port (addr:addrs) = Control.Exception.catch (openSocket' port addr) $ + \(Control.Exception.SomeException _) -> openSocket port addrs + openSocket' port addr = do + sock <- Network.Socket.socket (Network.Socket.addrFamily addr) + (Network.Socket.addrSocketType addr) + (Network.Socket.addrProtocol addr) + Network.Socket.connect sock . setPort port . Network.Socket.addrAddress $ addr + return sock diff --git a/hs/DBus/Constants.hs b/hs/DBus/Constants.hs --- a/hs/DBus/Constants.hs +++ b/hs/DBus/Constants.hs @@ -1,6 +1,7 @@ +{-# LANGUAGE OverloadedStrings #-} --- Copyright (C) 2009-2010 John Millikin +-- Copyright (C) 2009-2011 John Millikin -- -- 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 @@ -15,157 +16,153 @@ -- You should have received a copy of the GNU General Public License -- along with this program. If not, see . -{-# LANGUAGE OverloadedStrings #-} module DBus.Constants where -import qualified DBus.Types as T -import Data.Word (Word8, Word32) +import DBus.Types -protocolVersion :: Word8 -protocolVersion = 1 -messageMaximumLength :: Word32 -messageMaximumLength = 134217728 - -arrayMaximumLength :: Word32 -arrayMaximumLength = 67108864 - -dbusName :: T.BusName +dbusName :: BusName dbusName = "org.freedesktop.DBus" -dbusPath :: T.ObjectPath +dbusPath :: ObjectPath dbusPath = "/org/freedesktop/DBus" -dbusInterface :: T.InterfaceName +dbusInterface :: InterfaceName dbusInterface = "org.freedesktop.DBus" -interfaceIntrospectable :: T.InterfaceName +interfaceIntrospectable :: InterfaceName interfaceIntrospectable = "org.freedesktop.DBus.Introspectable" -interfaceProperties :: T.InterfaceName -interfaceProperties = "org.freedesktop.DBus.Properties" - -interfacePeer :: T.InterfaceName +interfacePeer :: InterfaceName interfacePeer = "org.freedesktop.DBus.Peer" -errorFailed :: T.ErrorName -errorFailed = "org.freedesktop.DBus.Error.Failed" +interfaceProperties :: InterfaceName +interfaceProperties = "org.freedesktop.DBus.Properties" -errorNoMemory :: T.ErrorName -errorNoMemory = "org.freedesktop.DBus.Error.NoMemory" +errorAccessDenied :: ErrorName +errorAccessDenied = "org.freedesktop.DBus.Error.AccessDenied" -errorServiceUnknown :: T.ErrorName -errorServiceUnknown = "org.freedesktop.DBus.Error.ServiceUnknown" +errorAuthFailed :: ErrorName +errorAuthFailed = "org.freedesktop.DBus.Error.AuthFailed" -errorNameHasNoOwner :: T.ErrorName -errorNameHasNoOwner = "org.freedesktop.DBus.Error.NameHasNoOwner" +errorDisconnected :: ErrorName +errorDisconnected = "org.freedesktop.DBus.Error.Disconnected" -errorNoReply :: T.ErrorName +errorFailed :: ErrorName +errorFailed = "org.freedesktop.DBus.Error.Failed" + +errorNoReply :: ErrorName errorNoReply = "org.freedesktop.DBus.Error.NoReply" -errorIOError :: T.ErrorName -errorIOError = "org.freedesktop.DBus.Error.IOError" +errorNoServer :: ErrorName +errorNoServer = "org.freedesktop.DBus.Error.NoServer" -errorBadAddress :: T.ErrorName -errorBadAddress = "org.freedesktop.DBus.Error.BadAddress" +errorTimedOut :: ErrorName +errorTimedOut = "org.freedesktop.DBus.Error.TimedOut" -errorNotSupported :: T.ErrorName -errorNotSupported = "org.freedesktop.DBus.Error.NotSupported" +errorTimeout :: ErrorName +errorTimeout = "org.freedesktop.DBus.Error.Timeout" -errorLimitsExceeded :: T.ErrorName -errorLimitsExceeded = "org.freedesktop.DBus.Error.LimitsExceeded" +errorServiceUnknown :: ErrorName +errorServiceUnknown = "org.freedesktop.DBus.Error.ServiceUnknown" -errorAccessDenied :: T.ErrorName -errorAccessDenied = "org.freedesktop.DBus.Error.AccessDenied" +errorUnknownObject :: ErrorName +errorUnknownObject = "org.freedesktop.DBus.Error.UnknownObject" -errorAuthFailed :: T.ErrorName -errorAuthFailed = "org.freedesktop.DBus.Error.AuthFailed" +errorUnknownInterface :: ErrorName +errorUnknownInterface = "org.freedesktop.DBus.Error.UnknownInterface" -errorNoServer :: T.ErrorName -errorNoServer = "org.freedesktop.DBus.Error.NoServer" +errorUnknownMethod :: ErrorName +errorUnknownMethod = "org.freedesktop.DBus.Error.UnknownMethod" -errorTimeout :: T.ErrorName -errorTimeout = "org.freedesktop.DBus.Error.Timeout" +errorInvalidParameters :: ErrorName +errorInvalidParameters = "org.freedesktop.DBus.Error.InvalidParameters" -errorNoNetwork :: T.ErrorName -errorNoNetwork = "org.freedesktop.DBus.Error.NoNetwork" +errorSpawnChildExited :: ErrorName +errorSpawnChildExited = "org.freedesktop.DBus.Error.Spawn.ChildExited" -errorAddressInUse :: T.ErrorName -errorAddressInUse = "org.freedesktop.DBus.Error.AddressInUse" +errorSpawnChildSignaled :: ErrorName +errorSpawnChildSignaled = "org.freedesktop.DBus.Error.Spawn.ChildSignaled" -errorDisconnected :: T.ErrorName -errorDisconnected = "org.freedesktop.DBus.Error.Disconnected" +errorSpawnConfigInvalid :: ErrorName +errorSpawnConfigInvalid = "org.freedesktop.DBus.Error.Spawn.ConfigInvalid" -errorInvalidArgs :: T.ErrorName -errorInvalidArgs = "org.freedesktop.DBus.Error.InvalidArgs" +errorSpawnExecFailed :: ErrorName +errorSpawnExecFailed = "org.freedesktop.DBus.Error.Spawn.ExecFailed" -errorFileNotFound :: T.ErrorName -errorFileNotFound = "org.freedesktop.DBus.Error.FileNotFound" +errorSpawnForkFailed :: ErrorName +errorSpawnForkFailed = "org.freedesktop.DBus.Error.Spawn.ForkFailed" -errorFileExists :: T.ErrorName -errorFileExists = "org.freedesktop.DBus.Error.FileExists" +errorSpawnFailed :: ErrorName +errorSpawnFailed = "org.freedesktop.DBus.Error.Spawn.Failed" -errorUnknownMethod :: T.ErrorName -errorUnknownMethod = "org.freedesktop.DBus.Error.UnknownMethod" +errorSpawnFailedToSetup :: ErrorName +errorSpawnFailedToSetup = "org.freedesktop.DBus.Error.Spawn.FailedToSetup" -errorTimedOut :: T.ErrorName -errorTimedOut = "org.freedesktop.DBus.Error.TimedOut" +errorSpawnFileInvalid :: ErrorName +errorSpawnFileInvalid = "org.freedesktop.DBus.Error.Spawn.FileInvalid" -errorMatchRuleNotFound :: T.ErrorName -errorMatchRuleNotFound = "org.freedesktop.DBus.Error.MatchRuleNotFound" +errorSpawnNoMemory :: ErrorName +errorSpawnNoMemory = "org.freedesktop.DBus.Error.Spawn.NoMemory" -errorMatchRuleInvalid :: T.ErrorName -errorMatchRuleInvalid = "org.freedesktop.DBus.Error.MatchRuleInvalid" +errorSpawnPermissionsInvalid :: ErrorName +errorSpawnPermissionsInvalid = "org.freedesktop.DBus.Error.Spawn.PermissionsInvalid" -errorSpawnExecFailed :: T.ErrorName -errorSpawnExecFailed = "org.freedesktop.DBus.Error.Spawn.ExecFailed" +errorSpawnServiceNotFound :: ErrorName +errorSpawnServiceNotFound = "org.freedesktop.DBus.Error.Spawn.ServiceNotFound" -errorSpawnForkFailed :: T.ErrorName -errorSpawnForkFailed = "org.freedesktop.DBus.Error.Spawn.ForkFailed" +errorSpawnServiceNotValid :: ErrorName +errorSpawnServiceNotValid = "org.freedesktop.DBus.Error.Spawn.ServiceNotValid" -errorSpawnChildExited :: T.ErrorName -errorSpawnChildExited = "org.freedesktop.DBus.Error.Spawn.ChildExited" +errorAddressInUse :: ErrorName +errorAddressInUse = "org.freedesktop.DBus.Error.AddressInUse" -errorSpawnChildSignaled :: T.ErrorName -errorSpawnChildSignaled = "org.freedesktop.DBus.Error.Spawn.ChildSignaled" +errorAdtAuditDataUnknown :: ErrorName +errorAdtAuditDataUnknown = "org.freedesktop.DBus.Error.AdtAuditDataUnknown" -errorSpawnFailed :: T.ErrorName -errorSpawnFailed = "org.freedesktop.DBus.Error.Spawn.Failed" +errorBadAddress :: ErrorName +errorBadAddress = "org.freedesktop.DBus.Error.BadAddress" -errorSpawnFailedToSetup :: T.ErrorName -errorSpawnFailedToSetup = "org.freedesktop.DBus.Error.Spawn.FailedToSetup" +errorFileExists :: ErrorName +errorFileExists = "org.freedesktop.DBus.Error.FileExists" -errorSpawnConfigInvalid :: T.ErrorName -errorSpawnConfigInvalid = "org.freedesktop.DBus.Error.Spawn.ConfigInvalid" +errorFileNotFound :: ErrorName +errorFileNotFound = "org.freedesktop.DBus.Error.FileNotFound" -errorSpawnServiceNotValid :: T.ErrorName -errorSpawnServiceNotValid = "org.freedesktop.DBus.Error.Spawn.ServiceNotValid" +errorInconsistentMessage :: ErrorName +errorInconsistentMessage = "org.freedesktop.DBus.Error.InconsistentMessage" -errorSpawnServiceNotFound :: T.ErrorName -errorSpawnServiceNotFound = "org.freedesktop.DBus.Error.Spawn.ServiceNotFound" +errorInvalidFileContent :: ErrorName +errorInvalidFileContent = "org.freedesktop.DBus.Error.InvalidFileContent" -errorSpawnPermissionsInvalid :: T.ErrorName -errorSpawnPermissionsInvalid = "org.freedesktop.DBus.Error.Spawn.PermissionsInvalid" +errorIOError :: ErrorName +errorIOError = "org.freedesktop.DBus.Error.IOError" -errorSpawnFileInvalid :: T.ErrorName -errorSpawnFileInvalid = "org.freedesktop.DBus.Error.Spawn.FileInvalid" +errorLimitsExceeded :: ErrorName +errorLimitsExceeded = "org.freedesktop.DBus.Error.LimitsExceeded" -errorSpawnNoMemory :: T.ErrorName -errorSpawnNoMemory = "org.freedesktop.DBus.Error.Spawn.NoMemory" +errorMatchRuleInvalid :: ErrorName +errorMatchRuleInvalid = "org.freedesktop.DBus.Error.MatchRuleInvalid" -errorUnixProcessIdUnknown :: T.ErrorName -errorUnixProcessIdUnknown = "org.freedesktop.DBus.Error.UnixProcessIdUnknown" +errorMatchRuleNotFound :: ErrorName +errorMatchRuleNotFound = "org.freedesktop.DBus.Error.MatchRuleNotFound" -errorInvalidFileContent :: T.ErrorName -errorInvalidFileContent = "org.freedesktop.DBus.Error.InvalidFileContent" +errorNameHasNoOwner :: ErrorName +errorNameHasNoOwner = "org.freedesktop.DBus.Error.NameHasNoOwner" -errorSELinuxSecurityContextUnknown :: T.ErrorName -errorSELinuxSecurityContextUnknown = "org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown" +errorNoMemory :: ErrorName +errorNoMemory = "org.freedesktop.DBus.Error.NoMemory" -errorAdtAuditDataUnknown :: T.ErrorName -errorAdtAuditDataUnknown = "org.freedesktop.DBus.Error.AdtAuditDataUnknown" +errorNoNetwork :: ErrorName +errorNoNetwork = "org.freedesktop.DBus.Error.NoNetwork" -errorObjectPathInUse :: T.ErrorName +errorNotSupported :: ErrorName +errorNotSupported = "org.freedesktop.DBus.Error.NotSupported" + +errorObjectPathInUse :: ErrorName errorObjectPathInUse = "org.freedesktop.DBus.Error.ObjectPathInUse" -errorInconsistentMessage :: T.ErrorName -errorInconsistentMessage = "org.freedesktop.DBus.Error.InconsistentMessage" +errorSELinuxSecurityContextUnknown :: ErrorName +errorSELinuxSecurityContextUnknown = "org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown" + +errorUnixProcessIdUnknown :: ErrorName +errorUnixProcessIdUnknown = "org.freedesktop.DBus.Error.UnixProcessIdUnknown" diff --git a/hs/DBus/Introspection.hs b/hs/DBus/Introspection.hs --- a/hs/DBus/Introspection.hs +++ b/hs/DBus/Introspection.hs @@ -1,6 +1,7 @@ +{-# LANGUAGE OverloadedStrings #-} --- Copyright (C) 2009-2010 John Millikin +-- Copyright (C) 2009-2011 John Millikin -- -- 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 @@ -15,9 +16,6 @@ -- You should have received a copy of the GNU General Public License -- along with this program. If not, see . - -{-# LANGUAGE OverloadedStrings #-} - module DBus.Introspection ( Object (..) , Interface (..) @@ -29,21 +27,19 @@ , toXML , fromXML ) where - -import Data.Text.Lazy (Text) -import qualified Data.Text.Lazy as TL - - +import Control.Monad ((>=>)) +import Control.Monad.ST (runST) +import Data.Maybe (fromMaybe) +import qualified Data.STRef as ST +import qualified Data.Text +import Data.Text (Text) +import qualified Data.Text.Encoding import qualified Data.XML.Types as X import qualified Text.XML.LibXML.SAX as SAX -import Control.Monad.ST (runST) -import qualified Data.STRef as ST -import Control.Monad ((>=>)) -import Data.Maybe (fromMaybe, listToMaybe) - import qualified DBus.Types as T + data Object = Object T.ObjectPath [Interface] [Object] deriving (Show, Eq) @@ -73,7 +69,9 @@ parseElement :: Text -> Maybe X.Element parseElement text = runST $ do stackRef <- ST.newSTRef [([], [])] - let onError _ = ST.writeSTRef stackRef [] + let onError _ = do + ST.writeSTRef stackRef [] + return False let onBegin _ attrs = do ST.modifySTRef stackRef ((attrs, []):) return True @@ -86,10 +84,11 @@ ST.writeSTRef stackRef (parent:stack'') return True - p <- SAX.newParserST onError Nothing + p <- SAX.newParserST Nothing SAX.setCallback p SAX.parsedBeginElement onBegin SAX.setCallback p SAX.parsedEndElement onEnd - SAX.parseLazyText p text + SAX.setCallback p SAX.reportError onError + SAX.parseBytes p (Data.Text.Encoding.encodeUtf8 text) SAX.parseComplete p stack <- ST.readSTRef stackRef return $ case stack of @@ -98,60 +97,58 @@ parseRoot :: T.ObjectPath -> X.Element -> Maybe Object parseRoot defaultPath e = do - path <- case getattrM "name" e of + path <- case X.attributeText "name" e of Nothing -> Just defaultPath - Just x -> T.mkObjectPath x + Just x -> T.objectPath x parseObject path e parseChild :: T.ObjectPath -> X.Element -> Maybe Object parseChild parentPath e = do - let parentPath' = case T.strObjectPath parentPath of + let parentPath' = case T.objectPathText parentPath of "/" -> "/" - x -> TL.append x "/" - pathSegment <- getattrM "name" e - path <- T.mkObjectPath $ TL.append parentPath' pathSegment + x -> Data.Text.append x "/" + pathSegment <- X.attributeText "name" e + path <- T.objectPath $ Data.Text.append parentPath' pathSegment parseObject path e parseObject :: T.ObjectPath -> X.Element -> Maybe Object -parseObject path e | X.elementName e == toName "node" = do - interfaces <- children parseInterface (named "interface") e - children' <- children (parseChild path) (named "node") e +parseObject path e | X.elementName e == "node" = do + interfaces <- children parseInterface (X.isNamed "interface") e + children' <- children (parseChild path) (X.isNamed "node") e return $ Object path interfaces children' parseObject _ _ = Nothing parseInterface :: X.Element -> Maybe Interface parseInterface e = do - name <- T.mkInterfaceName =<< getattrM "name" e - methods <- children parseMethod (named "method") e - signals <- children parseSignal (named "signal") e - properties <- children parseProperty (named "property") e + name <- T.interfaceName =<< X.attributeText "name" e + methods <- children parseMethod (X.isNamed "method") e + signals <- children parseSignal (X.isNamed "signal") e + properties <- children parseProperty (X.isNamed "property") e return $ Interface name methods signals properties parseMethod :: X.Element -> Maybe Method parseMethod e = do - name <- T.mkMemberName =<< getattrM "name" e + name <- T.memberName =<< X.attributeText "name" e paramsIn <- children parseParameter (isParam ["in", ""]) e paramsOut <- children parseParameter (isParam ["out"]) e return $ Method name paramsIn paramsOut parseSignal :: X.Element -> Maybe Signal parseSignal e = do - name <- T.mkMemberName =<< getattrM "name" e + name <- T.memberName =<< X.attributeText "name" e params <- children parseParameter (isParam ["out", ""]) e return $ Signal name params +parseType :: X.Element -> Maybe T.Signature +parseType e = X.attributeText "type" e >>= T.signature + parseParameter :: X.Element -> Maybe Parameter parseParameter e = do let name = getattr "name" e sig <- parseType e - return $ Parameter name sig - -parseType :: X.Element -> Maybe T.Signature -parseType e = do - sig <- T.mkSignature =<< getattrM "type" e case T.signatureTypes sig of - [_] -> Just sig - _ -> Nothing + [_] -> Just (Parameter name sig) + _ -> Nothing parseProperty :: X.Element -> Maybe Property parseProperty e = do @@ -165,36 +162,24 @@ _ -> Nothing return $ Property name sig access -getattrM :: Text -> X.Element -> Maybe Text -getattrM name = fmap attrText . listToMaybe . attrs where - attrText = textContent . X.attributeContent - attrs = X.elementAttributes >=> X.isNamed (toName name) - textContent cs = TL.concat [t | X.ContentText t <- cs] - -getattr :: Text -> X.Element -> Text -getattr = (fromMaybe "" .) . getattrM +getattr :: X.Name -> X.Element -> Text +getattr = (fromMaybe "" .) . X.attributeText isParam :: [Text] -> X.Element -> [X.Element] -isParam dirs = named "arg" >=> checkDir where +isParam dirs = X.isNamed "arg" >=> checkDir where checkDir e = [e | getattr "direction" e `elem` dirs] children :: Monad m => (X.Element -> m b) -> (X.Element -> [X.Element]) -> X.Element -> m [b] children f p = mapM f . concatMap p . X.elementChildren -named :: X.Named a => Text -> a -> [a] -named = X.isNamed . toName - -toName :: Text -> X.Name -toName t = X.Name t Nothing Nothing - newtype XmlWriter a = XmlWriter { runXmlWriter :: Maybe (a, Text) } instance Monad XmlWriter where - return a = XmlWriter $ Just (a, TL.empty) + return a = XmlWriter $ Just (a, Data.Text.empty) m >>= f = XmlWriter $ do (a, w) <- runXmlWriter m (b, w') <- runXmlWriter (f a) - return (b, TL.append w w') + return (b, Data.Text.append w w') tell :: Text -> XmlWriter () tell t = XmlWriter $ Just ((), t) @@ -208,16 +193,16 @@ writeRoot obj@(Object path _ _) = do tell "\n" - writeObject (T.strObjectPath path) obj + writeObject (T.objectPathText path) obj writeChild :: T.ObjectPath -> Object -> XmlWriter () writeChild parentPath obj@(Object path _ _) = write where - path' = T.strObjectPath path - parent' = T.strObjectPath parentPath - relpathM = if TL.isPrefixOf parent' path' + path' = T.objectPathText path + parent' = T.objectPathText parentPath + relpathM = if Data.Text.isPrefixOf parent' path' then Just $ if parent' == "/" - then TL.drop 1 path' - else TL.drop (TL.length parent' + 1) path' + then Data.Text.drop 1 path' + else Data.Text.drop (Data.Text.length parent' + 1) path' else Nothing write = case relpathM of @@ -232,38 +217,38 @@ writeInterface :: Interface -> XmlWriter () writeInterface (Interface name methods signals properties) = writeElement "interface" - [("name", T.strInterfaceName name)] $ do + [("name", T.interfaceNameText name)] $ do mapM_ writeMethod methods mapM_ writeSignal signals mapM_ writeProperty properties writeMethod :: Method -> XmlWriter () writeMethod (Method name inParams outParams) = writeElement "method" - [("name", T.strMemberName name)] $ do + [("name", T.memberNameText name)] $ do mapM_ (writeParameter "in") inParams mapM_ (writeParameter "out") outParams writeSignal :: Signal -> XmlWriter () writeSignal (Signal name params) = writeElement "signal" - [("name", T.strMemberName name)] $ do + [("name", T.memberNameText name)] $ do mapM_ (writeParameter "out") params writeParameter :: Text -> Parameter -> XmlWriter () writeParameter direction (Parameter name sig) = writeEmptyElement "arg" [ ("name", name) - , ("type", T.strSignature sig) + , ("type", T.signatureText sig) , ("direction", direction) ] writeProperty :: Property -> XmlWriter () writeProperty (Property name sig access) = writeEmptyElement "property" [ ("name", name) - , ("type", T.strSignature sig) + , ("type", T.signatureText sig) , ("access", strAccess access) ] strAccess :: [PropertyAccess] -> Text -strAccess access = TL.append readS writeS where +strAccess access = Data.Text.append readS writeS where readS = if elem Read access then "read" else "" writeS = if elem Write access then "write" else "" @@ -294,11 +279,11 @@ tell "'" escape :: Text -> Text -escape = TL.concatMap escapeChar where +escape = Data.Text.concatMap escapeChar where escapeChar c = case c of '&' -> "&" '<' -> "<" '>' -> ">" '"' -> """ '\'' -> "'" - _ -> TL.singleton c + _ -> Data.Text.singleton c diff --git a/hs/DBus/MatchRule.hs b/hs/DBus/MatchRule.hs deleted file mode 100644 --- a/hs/DBus/MatchRule.hs +++ /dev/null @@ -1,205 +0,0 @@ - - --- Copyright (C) 2009-2010 John Millikin --- --- 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 --- 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 . - - -{-# LANGUAGE OverloadedStrings #-} - -module DBus.MatchRule ( - MatchRule (..) - , MessageType (..) - , ParameterValue (..) - , formatRule - , addMatch - , matchAll - , matches - ) where - -import Data.Text.Lazy (Text) -import qualified Data.Text.Lazy as TL - -import Data.Word (Word8) -import Data.Maybe (fromMaybe, mapMaybe) -import qualified Data.Set as Set -import qualified DBus.Types as T -import qualified DBus.Message as M -import qualified DBus.Constants as C -import DBus.Util (maybeIndex) - --- | A match rule is a set of filters; most filters may have one possible --- value assigned, such as a single message type. The exception are parameter --- filters, which are limited in number only by the server implementation. --- -data MatchRule = MatchRule - { matchType :: Maybe MessageType - , matchSender :: Maybe T.BusName - , matchInterface :: Maybe T.InterfaceName - , matchMember :: Maybe T.MemberName - , matchPath :: Maybe T.ObjectPath - , matchDestination :: Maybe T.BusName - , matchParameters :: [ParameterValue] - } - deriving (Show) - --- | Parameters may match against two types, strings and object paths. It's --- probably an error to have two values for the same parameter. --- --- The constructor @StringValue 3 \"hello\"@ means that the fourth parameter --- in the message body must be the string @\"hello\"@. @PathValue@ is the --- same, but its value must be an object path. --- -data ParameterValue - = StringValue Word8 Text - | PathValue Word8 T.ObjectPath - deriving (Show, Eq) - --- | The set of allowed message types to filter on is separate from the set --- supported for sending over the wire. This allows the server to support --- additional types not yet implemented in the library, or vice-versa. --- -data MessageType - = MethodCall - | MethodReturn - | Signal - | Error - deriving (Show, Eq) - - --- | Format a 'MatchRule' as the bus expects to receive in a call to --- @AddMatch@. - -formatRule :: MatchRule -> Text -formatRule rule = TL.intercalate "," filters where - filters = structureFilters ++ parameterFilters - parameterFilters = map formatParameter $ matchParameters rule - structureFilters = mapMaybe unpack - [ ("type", fmap formatType . matchType) - , ("sender", fmap T.strBusName . matchSender) - , ("interface", fmap T.strInterfaceName . matchInterface) - , ("member", fmap T.strMemberName . matchMember) - , ("path", fmap T.strObjectPath . matchPath) - , ("destination", fmap T.strBusName . matchDestination) - ] - unpack (key, mkValue) = formatFilter' key `fmap` mkValue rule - -formatParameter :: ParameterValue -> Text -formatParameter (StringValue index x) = formatFilter' key x where - key = "arg" `TL.append` TL.pack (show index) -formatParameter (PathValue index x) = formatFilter' key value where - key = "arg" `TL.append` TL.pack (show index) `TL.append` "path" - value = T.strObjectPath x - -formatFilter' :: Text -> Text -> Text -formatFilter' key value = TL.concat [key, "='", value, "'"] - -formatType :: MessageType -> Text -formatType MethodCall = "method_call" -formatType MethodReturn = "method_return" -formatType Signal = "signal" -formatType Error = "error" - - --- | Build a 'M.MethodCall' for adding a match rule to the bus. - -addMatch :: MatchRule -> M.MethodCall -addMatch rule = M.MethodCall - C.dbusPath - "AddMatch" - (Just C.dbusInterface) - (Just C.dbusName) - Set.empty - [T.toVariant $ formatRule rule] - - --- | An empty match rule, which matches everything. - -matchAll :: MatchRule -matchAll = MatchRule - { matchType = Nothing - , matchSender = Nothing - , matchInterface = Nothing - , matchMember = Nothing - , matchPath = Nothing - , matchDestination = Nothing - , matchParameters = [] - } - - --- | Whether a 'M.ReceivedMessage' matches a given rule. This is useful --- for implementing signal handlers. - -matches :: MatchRule -> M.ReceivedMessage -> Bool -matches rule msg = and . mapMaybe ($ rule) $ - [ fmap (typeMatches msg) . matchType - , fmap (senderMatches msg) . matchSender - , fmap (ifaceMatches msg) . matchInterface - , fmap (memberMatches msg) . matchMember - , fmap (pathMatches msg) . matchPath - , fmap (destMatches msg) . matchDestination - , Just . parametersMatch msg . matchParameters - ] - -typeMatches :: M.ReceivedMessage -> MessageType -> Bool -typeMatches (M.ReceivedMethodCall _ _ _) MethodCall = True -typeMatches (M.ReceivedMethodReturn _ _ _) MethodReturn = True -typeMatches (M.ReceivedSignal _ _ _) Signal = True -typeMatches (M.ReceivedError _ _ _) Error = True -typeMatches _ _ = False - -senderMatches :: M.ReceivedMessage -> T.BusName -> Bool -senderMatches msg name = M.receivedSender msg == Just name - -ifaceMatches :: M.ReceivedMessage -> T.InterfaceName -> Bool -ifaceMatches (M.ReceivedMethodCall _ _ msg) name = - Just name == M.methodCallInterface msg -ifaceMatches (M.ReceivedSignal _ _ msg) name = - name == M.signalInterface msg -ifaceMatches _ _ = False - -memberMatches :: M.ReceivedMessage -> T.MemberName -> Bool -memberMatches (M.ReceivedMethodCall _ _ msg) name = - name == M.methodCallMember msg -memberMatches (M.ReceivedSignal _ _ msg) name = - name == M.signalMember msg -memberMatches _ _ = False - -pathMatches :: M.ReceivedMessage -> T.ObjectPath -> Bool -pathMatches (M.ReceivedMethodCall _ _ msg) path = - path == M.methodCallPath msg -pathMatches (M.ReceivedSignal _ _ msg) path = - path == M.signalPath msg -pathMatches _ _ = False - -destMatches :: M.ReceivedMessage -> T.BusName -> Bool -destMatches (M.ReceivedMethodCall _ _ msg) name = - Just name == M.methodCallDestination msg -destMatches (M.ReceivedMethodReturn _ _ msg) name = - Just name == M.methodReturnDestination msg -destMatches (M.ReceivedError _ _ msg) name = - Just name == M.errorDestination msg -destMatches (M.ReceivedSignal _ _ msg) name = - Just name == M.signalDestination msg -destMatches _ _ = False - -parametersMatch :: M.ReceivedMessage -> [ParameterValue] -> Bool -parametersMatch _ [] = True -parametersMatch msg values = all validParam values where - body = M.receivedBody msg - validParam (StringValue idx x) = validParam' idx x - validParam (PathValue idx x) = validParam' idx x - validParam' idx x = fromMaybe False $ do - var <- maybeIndex body $ fromIntegral idx - fmap (== x) $ T.fromVariant var diff --git a/hs/DBus/Message.hs b/hs/DBus/Message.hs --- a/hs/DBus/Message.hs +++ b/hs/DBus/Message.hs @@ -1,6 +1,6 @@ --- Copyright (C) 2009-2010 John Millikin +-- Copyright (C) 2009-2011 John Millikin -- -- 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 @@ -15,34 +15,22 @@ -- You should have received a copy of the GNU General Public License -- along with this program. If not, see . -module DBus.Message ( - - Message ( messageFlags - , messageBody - ) - +module DBus.Message + ( Message ( messageFlags + , messageBody + ) , Flag (..) - , Serial , serialValue - , firstSerial - , nextSerial - + , Unknown (..) , MethodCall (..) - , MethodReturn (..) - , Error (..) , errorMessage - , Signal (..) - - , Unknown (..) - , ReceivedMessage (..) , receivedSerial , receivedSender , receivedBody - ) where import DBus.Message.Internal diff --git a/hs/DBus/Message/Internal.hs b/hs/DBus/Message/Internal.hs --- a/hs/DBus/Message/Internal.hs +++ b/hs/DBus/Message/Internal.hs @@ -1,6 +1,7 @@ +{-# LANGUAGE OverloadedStrings #-} --- Copyright (C) 2009-2010 John Millikin +-- Copyright (C) 2009-2011 John Millikin -- -- 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 @@ -15,72 +16,71 @@ -- You should have received a copy of the GNU General Public License -- along with this program. If not, see . - -{-# LANGUAGE OverloadedStrings #-} - module DBus.Message.Internal where +import Data.Maybe (fromMaybe) +import qualified Data.Set +import Data.Set (Set) +import qualified Data.Text +import Data.Text (Text) +import Data.Word (Word8, Word32) -import Data.Text.Lazy (Text) -import qualified Data.Text.Lazy as TL +import DBus.Types hiding (errorName) +import DBus.Util (maybeIndex) -import qualified Data.Set as S -import Data.Word (Word8, Word32) -import Data.Maybe (fromMaybe) -import qualified DBus.Types as T -import DBus.Util (maybeIndex) class Message a where messageTypeCode :: a -> Word8 messageHeaderFields :: a -> [HeaderField] - messageFlags :: a -> S.Set Flag - messageBody :: a -> [T.Variant] + messageFlags :: a -> Set Flag + messageBody :: a -> [Variant] +maybe' :: (a -> b) -> Maybe a -> [b] +maybe' f = maybe [] (\x' -> [f x']) + +data Unknown = Unknown + { unknownType :: Word8 + , unknownFlags :: Set Flag + , unknownBody :: [Variant] + } + deriving (Show, Eq) + +data HeaderField + = HeaderPath ObjectPath + | HeaderInterface InterfaceName + | HeaderMember MemberName + | HeaderErrorName ErrorName + | HeaderReplySerial Serial + | HeaderDestination BusName + | HeaderSender BusName + | HeaderSignature Signature + deriving (Show, Eq) + data Flag = NoReplyExpected | NoAutoStart deriving (Show, Eq, Ord) -data HeaderField - = Path T.ObjectPath - | Interface T.InterfaceName - | Member T.MemberName - | ErrorName T.ErrorName - | ReplySerial Serial - | Destination T.BusName - | Sender T.BusName - | Signature T.Signature - deriving (Show, Eq) - -- | A value used to uniquely identify a particular message within a session. --- 'Serial's are 32-bit unsigned integers, and eventually wrap. - -newtype Serial = Serial { serialValue :: Word32 } - deriving (Eq, Ord) - -instance Show Serial where - show (Serial x) = show x - -instance T.Variable Serial where - toVariant (Serial x) = T.toVariant x - fromVariant = fmap Serial . T.fromVariant +-- 'Serial's are 32‐bit unsigned integers, and eventually wrap. -firstSerial :: Serial -firstSerial = Serial 1 +newtype Serial = Serial Word32 + deriving (Eq, Ord, Show) -nextSerial :: Serial -> Serial -nextSerial (Serial x) = Serial (x + 1) +instance IsVariant Serial where + toVariant (Serial x) = toVariant x + fromVariant = fmap Serial . fromVariant -maybe' :: (a -> b) -> Maybe a -> [b] -maybe' f = maybe [] (\x' -> [f x']) +serialValue :: Serial -> Word32 +serialValue (Serial x) = x data MethodCall = MethodCall - { methodCallPath :: T.ObjectPath - , methodCallMember :: T.MemberName - , methodCallInterface :: Maybe T.InterfaceName - , methodCallDestination :: Maybe T.BusName - , methodCallFlags :: S.Set Flag - , methodCallBody :: [T.Variant] + { methodCallPath :: ObjectPath + , methodCallMember :: MemberName + , methodCallInterface :: Maybe InterfaceName + , methodCallDestination :: Maybe BusName + , methodCallFlags :: Set Flag + , methodCallBody :: [Variant] } deriving (Show, Eq) @@ -89,96 +89,89 @@ messageFlags = methodCallFlags messageBody = methodCallBody messageHeaderFields m = concat - [ [ Path $ methodCallPath m - , Member $ methodCallMember m + [ [ HeaderPath (methodCallPath m) + , HeaderMember (methodCallMember m) ] - , maybe' Interface . methodCallInterface $ m - , maybe' Destination . methodCallDestination $ m + , maybe' HeaderInterface (methodCallInterface m) + , maybe' HeaderDestination (methodCallDestination m) ] data MethodReturn = MethodReturn { methodReturnSerial :: Serial - , methodReturnDestination :: Maybe T.BusName - , methodReturnBody :: [T.Variant] + , methodReturnDestination :: Maybe BusName + , methodReturnBody :: [Variant] } deriving (Show, Eq) instance Message MethodReturn where messageTypeCode _ = 2 - messageFlags _ = S.fromList [NoReplyExpected, NoAutoStart] + messageFlags _ = Data.Set.fromList [NoReplyExpected, NoAutoStart] messageBody = methodReturnBody messageHeaderFields m = concat - [ [ ReplySerial $ methodReturnSerial m + [ [ HeaderReplySerial (methodReturnSerial m) ] - , maybe' Destination . methodReturnDestination $ m + , maybe' HeaderDestination (methodReturnDestination m) ] data Error = Error - { errorName :: T.ErrorName + { errorName :: ErrorName , errorSerial :: Serial - , errorDestination :: Maybe T.BusName - , errorBody :: [T.Variant] + , errorDestination :: Maybe BusName + , errorBody :: [Variant] } deriving (Show, Eq) instance Message Error where messageTypeCode _ = 3 - messageFlags _ = S.fromList [NoReplyExpected, NoAutoStart] + messageFlags _ = Data.Set.fromList [NoReplyExpected, NoAutoStart] messageBody = errorBody messageHeaderFields m = concat - [ [ ErrorName $ errorName m - , ReplySerial $ errorSerial m + [ [ HeaderErrorName (errorName m) + , HeaderReplySerial (errorSerial m) ] - , maybe' Destination . errorDestination $ m + , maybe' HeaderDestination (errorDestination m) ] errorMessage :: Error -> Text errorMessage msg = fromMaybe "(no error message)" $ do field <- maybeIndex (errorBody msg) 0 - text <- T.fromVariant field - if TL.null text + text <- fromVariant field + if Data.Text.null text then Nothing else return text data Signal = Signal - { signalPath :: T.ObjectPath - , signalMember :: T.MemberName - , signalInterface :: T.InterfaceName - , signalDestination :: Maybe T.BusName - , signalBody :: [T.Variant] + { signalDestination :: Maybe BusName + , signalPath :: ObjectPath + , signalInterface :: InterfaceName + , signalMember :: MemberName + , signalBody :: [Variant] } deriving (Show, Eq) instance Message Signal where messageTypeCode _ = 4 - messageFlags _ = S.fromList [NoReplyExpected, NoAutoStart] + messageFlags _ = Data.Set.fromList [NoReplyExpected, NoAutoStart] messageBody = signalBody messageHeaderFields m = concat - [ [ Path $ signalPath m - , Member $ signalMember m - , Interface $ signalInterface m + [ [ HeaderPath (signalPath m) + , HeaderMember (signalMember m) + , HeaderInterface (signalInterface m) ] - , maybe' Destination . signalDestination $ m + , maybe' HeaderDestination (signalDestination m) ] -data Unknown = Unknown - { unknownType :: Word8 - , unknownFlags :: S.Set Flag - , unknownBody :: [T.Variant] - } - deriving (Show, Eq) - -- | Not an actual message type, but a wrapper around messages received from --- the bus. Each value contains the message's 'Serial' and possibly the --- origin's 'T.BusName' +-- the bus. Each value contains the message’s 'Serial' and possibly the +-- origin’s 'BusName' data ReceivedMessage - = ReceivedMethodCall Serial (Maybe T.BusName) MethodCall - | ReceivedMethodReturn Serial (Maybe T.BusName) MethodReturn - | ReceivedError Serial (Maybe T.BusName) Error - | ReceivedSignal Serial (Maybe T.BusName) Signal - | ReceivedUnknown Serial (Maybe T.BusName) Unknown + = ReceivedMethodCall Serial (Maybe BusName) MethodCall + | ReceivedMethodReturn Serial (Maybe BusName) MethodReturn + | ReceivedError Serial (Maybe BusName) Error + | ReceivedSignal Serial (Maybe BusName) Signal + | ReceivedUnknown Serial (Maybe BusName) Unknown deriving (Show, Eq) receivedSerial :: ReceivedMessage -> Serial @@ -188,14 +181,14 @@ receivedSerial (ReceivedSignal s _ _) = s receivedSerial (ReceivedUnknown s _ _) = s -receivedSender :: ReceivedMessage -> Maybe T.BusName +receivedSender :: ReceivedMessage -> Maybe BusName receivedSender (ReceivedMethodCall _ s _) = s receivedSender (ReceivedMethodReturn _ s _) = s receivedSender (ReceivedError _ s _) = s receivedSender (ReceivedSignal _ s _) = s receivedSender (ReceivedUnknown _ s _) = s -receivedBody :: ReceivedMessage -> [T.Variant] +receivedBody :: ReceivedMessage -> [Variant] receivedBody (ReceivedMethodCall _ _ x) = messageBody x receivedBody (ReceivedMethodReturn _ _ x) = messageBody x receivedBody (ReceivedError _ _ x) = messageBody x diff --git a/hs/DBus/NameReservation.hs b/hs/DBus/NameReservation.hs deleted file mode 100644 --- a/hs/DBus/NameReservation.hs +++ /dev/null @@ -1,112 +0,0 @@ - - --- Copyright (C) 2009-2010 John Millikin --- --- 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 --- 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 . - -{-# LANGUAGE OverloadedStrings #-} -module DBus.NameReservation - ( RequestNameFlag (..) - , RequestNameReply (..) - , ReleaseNameReply (..) - , requestName - , releaseName - , mkRequestNameReply - , mkReleaseNameReply - ) where -import Data.Word (Word32) -import Data.Bits ((.|.)) -import qualified Data.Set as Set -import qualified DBus.Types as T -import qualified DBus.Message as M -import qualified DBus.Constants as C -import DBus.Util (maybeIndex) - -data RequestNameFlag - = AllowReplacement - | ReplaceExisting - | DoNotQueue - deriving (Show) - -encodeFlags :: [RequestNameFlag] -> Word32 -encodeFlags = foldr (.|.) 0 . map flagValue where - flagValue AllowReplacement = 0x1 - flagValue ReplaceExisting = 0x2 - flagValue DoNotQueue = 0x4 - - --- | Build a 'M.MethodCall' for requesting a registered bus name. - -requestName :: T.BusName -> [RequestNameFlag] -> M.MethodCall -requestName name flags = M.MethodCall - { M.methodCallPath = C.dbusPath - , M.methodCallInterface = Just C.dbusInterface - , M.methodCallDestination = Just C.dbusName - , M.methodCallFlags = Set.empty - , M.methodCallMember = "RequestName" - , M.methodCallBody = - [ T.toVariant name - , T.toVariant . encodeFlags $ flags] - } - -data RequestNameReply - = PrimaryOwner - | InQueue - | Exists - | AlreadyOwner - deriving (Show) - -mkRequestNameReply :: M.MethodReturn -> Maybe RequestNameReply -mkRequestNameReply msg = - maybeIndex (M.messageBody msg) 0 >>= - T.fromVariant >>= - decodeRequestReply - -decodeRequestReply :: Word32 -> Maybe RequestNameReply -decodeRequestReply 1 = Just PrimaryOwner -decodeRequestReply 2 = Just InQueue -decodeRequestReply 3 = Just Exists -decodeRequestReply 4 = Just AlreadyOwner -decodeRequestReply _ = Nothing - - --- | Build a 'M.MethodCall' for releasing a registered bus name. - -releaseName :: T.BusName -> M.MethodCall -releaseName name = M.MethodCall - { M.methodCallPath = C.dbusPath - , M.methodCallInterface = Just C.dbusInterface - , M.methodCallDestination = Just C.dbusName - , M.methodCallFlags = Set.empty - , M.methodCallMember = "ReleaseName" - , M.methodCallBody = [T.toVariant name] - } - -data ReleaseNameReply - = Released - | NonExistent - | NotOwner - deriving (Show) - -mkReleaseNameReply :: M.MethodReturn -> Maybe ReleaseNameReply -mkReleaseNameReply msg = - maybeIndex (M.messageBody msg) 0 >>= - T.fromVariant >>= - decodeReleaseReply - -decodeReleaseReply :: Word32 -> Maybe ReleaseNameReply -decodeReleaseReply 1 = Just Released -decodeReleaseReply 2 = Just NonExistent -decodeReleaseReply 3 = Just NotOwner -decodeReleaseReply _ = Nothing diff --git a/hs/DBus/Types.hs b/hs/DBus/Types.hs --- a/hs/DBus/Types.hs +++ b/hs/DBus/Types.hs @@ -1,6 +1,6 @@ --- Copyright (C) 2009-2010 John Millikin +-- Copyright (C) 2009-2011 John Millikin -- -- 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 @@ -15,85 +15,57 @@ -- You should have received a copy of the GNU General Public License -- along with this program. If not, see . -module DBus.Types ( - - -- * Available types - Type (..) - , typeCode - - -- * Variants - , Variant - , Variable (..) - - , variantType - - -- * Signatures +module DBus.Types + ( Type(..) + , Signature + , signature + , signature_ + , signatureText , signatureTypes - , strSignature - - , mkSignature - , mkSignature_ - - -- * Object paths + + , IsValue + , IsAtom + , typeOf + + , Variant + , IsVariant(..) + , variantType + , ObjectPath - , strObjectPath - , mkObjectPath - , mkObjectPath_ - - -- * Arrays + , objectPath + , objectPath_ + , objectPathText + + , InterfaceName + , interfaceName + , interfaceName_ + , interfaceNameText + + , MemberName + , memberName + , memberName_ + , memberNameText + + , ErrorName + , errorName + , errorName_ + , errorNameText + + , BusName + , busName + , busName_ + , busNameText + + , Structure , Array - , arrayType - , arrayItems - - , toArray - , fromArray - , arrayFromItems - - , arrayToBytes - , arrayFromBytes - - -- * Dictionaries , Dictionary + , structureItems + , arrayItems , dictionaryItems - , dictionaryKeyType - , dictionaryValueType - - , toDictionary - , fromDictionary - , dictionaryFromItems - - , dictionaryToArray - , arrayToDictionary - - -- * Structures - , Structure (..) - - -- * Names - - -- ** Bus names - , BusName - , strBusName - , mkBusName - , mkBusName_ - - -- ** Interface names - , InterfaceName - , strInterfaceName - , mkInterfaceName - , mkInterfaceName_ - - -- ** Error names - , ErrorName - , strErrorName - , mkErrorName - , mkErrorName_ - - -- ** Member names - , MemberName - , strMemberName - , mkMemberName - , mkMemberName_ - ) where -import DBus.Types.Internal +import DBus.Types.Internal hiding (typeOf) +import qualified DBus.Types.Internal + +typeOf :: IsValue a => a -> Type +typeOf = DBus.Types.Internal.typeOf diff --git a/hs/DBus/Types/Internal.cpphs b/hs/DBus/Types/Internal.cpphs deleted file mode 100644 --- a/hs/DBus/Types/Internal.cpphs +++ /dev/null @@ -1,622 +0,0 @@ - - --- Copyright (C) 2009-2010 John Millikin --- --- 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 --- 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 . - - -{-# LANGUAGE OverloadedStrings #-} - - -{-# LANGUAGE TypeSynonymInstances #-} - -module DBus.Types.Internal where - -import Data.Text.Lazy (Text) -import qualified Data.Text.Lazy as TL - - -import Data.Word (Word8, Word16, Word32, Word64) -import Data.Int (Int16, Int32, Int64) - -import qualified Data.Text as T - -import Data.Ord (comparing) - -import Data.Text.Encoding (decodeUtf8) - -import qualified Data.ByteString.Unsafe as B -import qualified Foreign as F -import System.IO.Unsafe (unsafePerformIO) - -import Data.Text.Lazy.Encoding (encodeUtf8) - -import DBus.Util (mkUnsafe) -import qualified Data.String as String - -import Text.ParserCombinators.Parsec ((<|>)) -import qualified Text.ParserCombinators.Parsec as P -import DBus.Util (checkLength, parseMaybe) - -import Data.List (intercalate) - -import Control.Monad (unless) - -import Control.Arrow ((***)) -import qualified Data.Map as Map - -import Control.Monad (forM) - -import qualified Data.ByteString as B -import qualified Data.ByteString.Char8 as B8 -import qualified Data.ByteString.Lazy as BL -import qualified Data.ByteString.Char8 as BL8 - -data Type - = DBusBoolean - | DBusByte - | DBusInt16 - | DBusInt32 - | DBusInt64 - | DBusWord16 - | DBusWord32 - | DBusWord64 - | DBusDouble - | DBusString - | DBusSignature - | DBusObjectPath - | DBusVariant - | DBusArray Type - | DBusDictionary Type Type - | DBusStructure [Type] - deriving (Show, Eq) - - --- | \"Atomic\" types are any which can't contain any other types. Only --- atomic types may be used as dictionary keys. - -isAtomicType :: Type -> Bool -isAtomicType DBusBoolean = True -isAtomicType DBusByte = True -isAtomicType DBusInt16 = True -isAtomicType DBusInt32 = True -isAtomicType DBusInt64 = True -isAtomicType DBusWord16 = True -isAtomicType DBusWord32 = True -isAtomicType DBusWord64 = True -isAtomicType DBusDouble = True -isAtomicType DBusString = True -isAtomicType DBusSignature = True -isAtomicType DBusObjectPath = True -isAtomicType _ = False - - --- | Every type has an associated type code; a textual representation of --- the type, useful for debugging. - -typeCode :: Type -> Text - -typeCode t = TL.fromChunks [decodeUtf8 $ typeCodeB t] - -typeCodeB :: Type -> B.ByteString -typeCodeB DBusBoolean = "b" -typeCodeB DBusByte = "y" -typeCodeB DBusInt16 = "n" -typeCodeB DBusInt32 = "i" -typeCodeB DBusInt64 = "x" -typeCodeB DBusWord16 = "q" -typeCodeB DBusWord32 = "u" -typeCodeB DBusWord64 = "t" -typeCodeB DBusDouble = "d" -typeCodeB DBusString = "s" -typeCodeB DBusSignature = "g" -typeCodeB DBusObjectPath = "o" -typeCodeB DBusVariant = "v" - -typeCodeB (DBusArray t) = B8.cons 'a' $ typeCodeB t - -typeCodeB (DBusDictionary k v) = B.concat ["a{", typeCodeB k, typeCodeB v, "}"] - -typeCodeB (DBusStructure ts) = B.concat $ - ["("] ++ map typeCodeB ts ++ [")"] - - --- | 'Variant's may contain any other built-in D-Bus value. Besides --- representing native @VARIANT@ values, they allow type-safe storage and --- deconstruction of heterogeneous collections. - -data Variant - = VarBoxBool Bool - | VarBoxWord8 Word8 - | VarBoxInt16 Int16 - | VarBoxInt32 Int32 - | VarBoxInt64 Int64 - | VarBoxWord16 Word16 - | VarBoxWord32 Word32 - | VarBoxWord64 Word64 - | VarBoxDouble Double - | VarBoxString Text - | VarBoxSignature Signature - | VarBoxObjectPath ObjectPath - | VarBoxVariant Variant - | VarBoxArray Array - | VarBoxDictionary Dictionary - | VarBoxStructure Structure - deriving (Eq) - -class Variable a where - toVariant :: a -> Variant - fromVariant :: Variant -> Maybe a - -instance Show Variant where - showsPrec d var = showParen (d > 10) full where - full = s "Variant " . shows code . s " " . valueStr - code = typeCode $ variantType var - s = showString - valueStr = showsPrecVar 11 var - -showsPrecVar :: Int -> Variant -> ShowS -showsPrecVar d var = case var of - (VarBoxBool x) -> showsPrec d x - (VarBoxWord8 x) -> showsPrec d x - (VarBoxInt16 x) -> showsPrec d x - (VarBoxInt32 x) -> showsPrec d x - (VarBoxInt64 x) -> showsPrec d x - (VarBoxWord16 x) -> showsPrec d x - (VarBoxWord32 x) -> showsPrec d x - (VarBoxWord64 x) -> showsPrec d x - (VarBoxDouble x) -> showsPrec d x - (VarBoxString x) -> showsPrec d x - (VarBoxSignature x) -> showsPrec d x - (VarBoxObjectPath x) -> showsPrec d x - (VarBoxVariant x) -> showsPrec d x - (VarBoxArray x) -> showsPrec d x - (VarBoxDictionary x) -> showsPrec d x - (VarBoxStructure x) -> showsPrec d x - - --- | Every variant is strongly-typed; that is, the type of its contained --- value is known at all times. This function retrieves that type, so that --- the correct cast can be used to retrieve the value. - -variantType :: Variant -> Type -variantType var = case var of - (VarBoxBool _) -> DBusBoolean - (VarBoxWord8 _) -> DBusByte - (VarBoxInt16 _) -> DBusInt16 - (VarBoxInt32 _) -> DBusInt32 - (VarBoxInt64 _) -> DBusInt64 - (VarBoxWord16 _) -> DBusWord16 - (VarBoxWord32 _) -> DBusWord32 - (VarBoxWord64 _) -> DBusWord64 - (VarBoxDouble _) -> DBusDouble - (VarBoxString _) -> DBusString - (VarBoxSignature _) -> DBusSignature - (VarBoxObjectPath _) -> DBusObjectPath - (VarBoxVariant _) -> DBusVariant - (VarBoxArray x) -> DBusArray (arrayType x) - (VarBoxDictionary x) -> let - keyT = dictionaryKeyType x - valueT = dictionaryValueType x - in DBusDictionary keyT valueT - (VarBoxStructure x) -> let - Structure items = x - in DBusStructure (map variantType items) - -variantSignature :: Variant -> Maybe Signature -variantSignature = mkBytesSignature . typeCodeB . variantType - -#define INSTANCE_VARIABLE(TYPE) \ - instance Variable TYPE where \ - { toVariant = VarBox/**/TYPE \ - ; fromVariant (VarBox/**/TYPE x) = Just x \ - ; fromVariant _ = Nothing \ - } - -INSTANCE_VARIABLE(Variant) - -INSTANCE_VARIABLE(Bool) -INSTANCE_VARIABLE(Word8) -INSTANCE_VARIABLE(Int16) -INSTANCE_VARIABLE(Int32) -INSTANCE_VARIABLE(Int64) -INSTANCE_VARIABLE(Word16) -INSTANCE_VARIABLE(Word32) -INSTANCE_VARIABLE(Word64) -INSTANCE_VARIABLE(Double) - -instance Variable TL.Text where - toVariant = VarBoxString - fromVariant (VarBoxString x) = Just x - fromVariant _ = Nothing - -instance Variable T.Text where - toVariant = toVariant . TL.fromChunks . (:[]) - fromVariant = fmap (T.concat . TL.toChunks) . fromVariant - -instance Variable String where - toVariant = toVariant . TL.pack - fromVariant = fmap TL.unpack . fromVariant - -INSTANCE_VARIABLE(Signature) -data Signature = Signature { signatureTypes :: [Type] } - deriving (Eq) - -instance Show Signature where - showsPrec d x = showParen (d > 10) $ - showString "Signature " . shows (strSignature x) - -bytesSignature :: Signature -> B.ByteString -bytesSignature (Signature ts) = B.concat $ map typeCodeB ts - -strSignature :: Signature -> Text -strSignature (Signature ts) = TL.concat $ map typeCode ts - -instance Ord Signature where - compare = comparing strSignature - -mkBytesSignature :: B.ByteString -> Maybe Signature -mkBytesSignature = unsafePerformIO . flip B.unsafeUseAsCStringLen io where - - parseAtom c yes no = case c of - 0x62 -> yes DBusBoolean - 0x79 -> yes DBusByte - 0x6E -> yes DBusInt16 - 0x69 -> yes DBusInt32 - 0x78 -> yes DBusInt64 - 0x71 -> yes DBusWord16 - 0x75 -> yes DBusWord32 - 0x74 -> yes DBusWord64 - 0x64 -> yes DBusDouble - 0x73 -> yes DBusString - 0x67 -> yes DBusSignature - 0x6F -> yes DBusObjectPath - _ -> no - - fast c = parseAtom c (\t -> Just (Signature [t])) $ case c of - 0x76 -> Just (Signature [DBusVariant]) - _ -> Nothing - - - slow :: F.Ptr Word8 -> Int -> IO (Maybe Signature) - slow buf len = loop [] 0 where - loop acc ii | ii >= len = return . Just . Signature $ reverse acc - loop acc ii = do - c <- F.peekElemOff buf ii - let next t = loop (t : acc) (ii + 1) - parseAtom c next $ case c of - 0x76 -> next DBusVariant - - -- '(' - 0x28 -> do - mt <- structure buf len (ii + 1) - case mt of - Just (ii', t) -> loop (t : acc) ii' - Nothing -> return Nothing - - -- 'a' - 0x61 -> do - mt <- array buf len (ii + 1) - case mt of - Just (ii', t) -> loop (t : acc) ii' - Nothing -> return Nothing - - _ -> return Nothing - - structure :: F.Ptr Word8 -> Int -> Int -> IO (Maybe (Int, Type)) - structure buf len = loop [] where - loop _ ii | ii >= len = return Nothing - loop acc ii = do - c <- F.peekElemOff buf ii - let next t = loop (t : acc) (ii + 1) - parseAtom c next $ case c of - 0x76 -> next DBusVariant - - -- '(' - 0x28 -> do - mt <- structure buf len (ii + 1) - case mt of - Just (ii', t) -> loop (t : acc) ii' - Nothing -> return Nothing - - -- ')' - 0x29 -> return $ Just $ (ii + 1, DBusStructure (reverse acc)) - - -- 'a' - 0x61 -> do - mt <- array buf len (ii + 1) - case mt of - Just (ii', t) -> loop (t : acc) ii' - Nothing -> return Nothing - - _ -> return Nothing - - array :: F.Ptr Word8 -> Int -> Int -> IO (Maybe (Int, Type)) - array _ len ii | ii >= len = return Nothing - array buf len ii = do - c <- F.peekElemOff buf ii - let next t = return $ Just (ii + 1, DBusArray t) - parseAtom c next $ case c of - 0x76 -> next DBusVariant - - -- '(' - 0x28 -> do - mt <- structure buf len (ii + 1) - case mt of - Just (ii', t) -> return $ Just (ii', DBusArray t) - Nothing -> return Nothing - - -- '{' - 0x7B -> dict buf len (ii + 1) - - -- 'a' - 0x61 -> do - mt <- array buf len (ii + 1) - case mt of - Just (ii', t) -> return $ Just (ii', DBusArray t) - Nothing -> return Nothing - - _ -> return Nothing - - dict :: F.Ptr Word8 -> Int -> Int -> IO (Maybe (Int, Type)) - dict _ len ii | ii + 1 >= len = return Nothing - dict buf len ii = do - c1 <- F.peekElemOff buf ii - c2 <- F.peekElemOff buf (ii + 1) - - let mt1 = parseAtom c1 Just Nothing - - let next t = return $ Just (ii + 2, t) - mt2 <- parseAtom c2 next $ case c2 of - 0x76 -> next DBusVariant - - -- '(' - 0x28 -> structure buf len (ii + 2) - - -- 'a' - 0x61 -> array buf len (ii + 2) - - _ -> return Nothing - - case mt2 of - Nothing -> return Nothing - Just (ii', t2) -> if ii' >= len - then return Nothing - else do - c3 <- F.peekElemOff buf ii' - return $ do - if c3 == 0x7D then Just () else Nothing - t1 <- mt1 - Just (ii' + 1, DBusDictionary t1 t2) - - - io (cstr, len) = case len of - 0 -> return $ Just $ Signature [] - 1 -> fmap fast $ F.peek cstr - _ | len <= 255 -> slow (F.castPtr cstr) len - _ -> return Nothing - -mkSignature :: Text -> Maybe Signature -mkSignature = mkBytesSignature . B.concat . BL.toChunks . encodeUtf8 - -mkSignature_ :: Text -> Signature -mkSignature_ = mkUnsafe "signature" mkSignature - -instance String.IsString Signature where - fromString = mkUnsafe "signature" mkBytesSignature . BL8.pack - -maybeValidType :: Type -> Maybe () -maybeValidType t = if B.length (typeCodeB t) > 255 - then Nothing - else Just () - -INSTANCE_VARIABLE(ObjectPath) -newtype ObjectPath = ObjectPath - { strObjectPath :: Text - } - deriving (Eq, Ord) - -instance Show ObjectPath where - showsPrec d (ObjectPath x) = showParen (d > 10) $ - showString "ObjectPath " . shows x - -instance String.IsString ObjectPath where - fromString = mkObjectPath_ . TL.pack - -mkObjectPath :: Text -> Maybe ObjectPath -mkObjectPath s = parseMaybe path' (TL.unpack s) where - c = P.oneOf $ ['a'..'z'] ++ ['A'..'Z'] ++ ['0'..'9'] ++ "_" - path = P.char '/' >>= P.optional . P.sepBy (P.many1 c) . P.char - path' = path >> P.eof >> return (ObjectPath s) - -mkObjectPath_ :: Text -> ObjectPath -mkObjectPath_ = mkUnsafe "object path" mkObjectPath - -INSTANCE_VARIABLE(Array) -data Array - = VariantArray Type [Variant] - | ByteArray BL.ByteString - deriving (Eq) - - --- | This is the type contained within the array, not the type of the array --- itself. - -arrayType :: Array -> Type -arrayType (VariantArray t _) = t -arrayType (ByteArray _) = DBusByte - -arrayItems :: Array -> [Variant] -arrayItems (VariantArray _ xs) = xs -arrayItems (ByteArray xs) = map toVariant $ BL.unpack xs - -instance Show Array where - showsPrec d array = showParen (d > 10) $ - s "Array " . showSig . s " [" . s valueString . s "]" where - s = showString - showSig = shows . typeCode . arrayType $ array - showVar var = showsPrecVar 0 var "" - valueString = intercalate ", " $ map showVar $ arrayItems array - -arrayFromItems :: Type -> [Variant] -> Maybe Array -arrayFromItems DBusByte vs = fmap (ByteArray . BL.pack) (mapM fromVariant vs) - -arrayFromItems t vs = do - maybeValidType t - if all (\x -> variantType x == t) vs - then Just $ VariantArray t vs - else Nothing - -toArray :: Variable a => Type -> [a] -> Maybe Array -toArray t = arrayFromItems t . map toVariant - -fromArray :: Variable a => Array -> Maybe [a] -fromArray = mapM fromVariant . arrayItems - -arrayToBytes :: Array -> Maybe BL.ByteString -arrayToBytes (ByteArray x) = Just x -arrayToBytes _ = Nothing - -arrayFromBytes :: BL.ByteString -> Array -arrayFromBytes = ByteArray - -instance Variable BL.ByteString where - toVariant = toVariant . arrayFromBytes - fromVariant x = fromVariant x >>= arrayToBytes - -instance Variable B.ByteString where - toVariant x = toVariant . arrayFromBytes $ BL.fromChunks [x] - fromVariant = fmap (B.concat . BL.toChunks) . fromVariant - -INSTANCE_VARIABLE(Dictionary) - -data Dictionary = Dictionary - { dictionaryKeyType :: Type - , dictionaryValueType :: Type - , dictionaryItems :: [(Variant, Variant)] - } - deriving (Eq) - -instance Show Dictionary where - showsPrec d (Dictionary kt vt pairs) = showParen (d > 10) $ - s "Dictionary " . showSig . s " {" . s valueString . s "}" where - s = showString - showSig = shows $ TL.append (typeCode kt) (typeCode vt) - valueString = intercalate ", " $ map showPair pairs - showPair (k, v) = (showsPrecVar 0 k . showString " -> " . showsPrecVar 0 v) "" - -dictionaryFromItems :: Type -> Type -> [(Variant, Variant)] -> Maybe Dictionary -dictionaryFromItems kt vt pairs = do - unless (isAtomicType kt) Nothing - maybeValidType kt - maybeValidType vt - - let sameType (k, v) = variantType k == kt && - variantType v == vt - if all sameType pairs - then Just $ Dictionary kt vt pairs - else Nothing - -toDictionary :: (Variable a, Variable b) => Type -> Type -> Map.Map a b - -> Maybe Dictionary -toDictionary kt vt = dictionaryFromItems kt vt . pairs where - pairs = map (toVariant *** toVariant) . Map.toList - -fromDictionary :: (Variable a, Ord a, Variable b) => Dictionary - -> Maybe (Map.Map a b) -fromDictionary (Dictionary _ _ vs) = do - pairs <- forM vs $ \(k, v) -> do - k' <- fromVariant k - v' <- fromVariant v - return (k', v') - return $ Map.fromList pairs - -dictionaryToArray :: Dictionary -> Array -dictionaryToArray (Dictionary kt vt items) = array where - Just array = toArray itemType structs - itemType = DBusStructure [kt, vt] - structs = [Structure [k, v] | (k, v) <- items] - -arrayToDictionary :: Array -> Maybe Dictionary -arrayToDictionary array = do - let toPair x = do - struct <- fromVariant x - case struct of - Structure [k, v] -> Just (k, v) - _ -> Nothing - (kt, vt) <- case arrayType array of - DBusStructure [kt, vt] -> Just (kt, vt) - _ -> Nothing - pairs <- mapM toPair $ arrayItems array - dictionaryFromItems kt vt pairs - -INSTANCE_VARIABLE(Structure) - -data Structure = Structure [Variant] - deriving (Show, Eq) - -#define NAME_TYPE(TYPE, NAME) \ - newtype TYPE = TYPE {str/**/TYPE :: Text} \ - deriving (Eq, Ord); \ - \ - instance Show TYPE where \ - { showsPrec d (TYPE x) = showParen (d > 10) $ \ - showString "TYPE " . shows x \ - }; \ - \ - instance String.IsString TYPE where \ - { fromString = mk/**/TYPE/**/_ . TL.pack }; \ - \ - instance Variable TYPE where \ - { toVariant = toVariant . str/**/TYPE \ - ; fromVariant = (mk/**/TYPE =<<) . fromVariant }; \ - \ - mk/**/TYPE/**/_ :: Text -> TYPE; \ - mk/**/TYPE/**/_ = mkUnsafe NAME mk/**/TYPE - -NAME_TYPE(BusName, "bus name") - -mkBusName :: Text -> Maybe BusName -mkBusName s = checkLength 255 (TL.unpack s) >>= parseMaybe parser where - c = ['a'..'z'] ++ ['A'..'Z'] ++ "_-" - c' = c ++ ['0'..'9'] - parser = (unique <|> wellKnown) >> P.eof >> return (BusName s) - unique = P.char ':' >> elems c' - wellKnown = elems c - elems start = elem' start >> P.many1 (P.char '.' >> elem' start) - elem' start = P.oneOf start >> P.many (P.oneOf c') - -NAME_TYPE(InterfaceName, "interface name") - -mkInterfaceName :: Text -> Maybe InterfaceName -mkInterfaceName s = checkLength 255 (TL.unpack s) >>= parseMaybe parser where - c = ['a'..'z'] ++ ['A'..'Z'] ++ "_" - c' = c ++ ['0'..'9'] - element = P.oneOf c >> P.many (P.oneOf c') - name = element >> P.many1 (P.char '.' >> element) - parser = name >> P.eof >> return (InterfaceName s) - -NAME_TYPE(ErrorName, "error name") - -mkErrorName :: Text -> Maybe ErrorName -mkErrorName = fmap (ErrorName . strInterfaceName) . mkInterfaceName - -NAME_TYPE(MemberName, "member name") - -mkMemberName :: Text -> Maybe MemberName -mkMemberName s = checkLength 255 (TL.unpack s) >>= parseMaybe parser where - c = ['a'..'z'] ++ ['A'..'Z'] ++ "_" - c' = c ++ ['0'..'9'] - name = P.oneOf c >> P.many (P.oneOf c') - parser = name >> P.eof >> return (MemberName s) diff --git a/hs/DBus/Types/Internal.hs b/hs/DBus/Types/Internal.hs new file mode 100644 --- /dev/null +++ b/hs/DBus/Types/Internal.hs @@ -0,0 +1,1215 @@ + +{-# LANGUAGE CPP #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE IncoherentInstances #-} + +-- Copyright (C) 2009-2011 John Millikin +-- +-- 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 +-- 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 . + +module DBus.Types.Internal where +import Control.Monad (liftM, when, (>=>)) +import Data.ByteString (ByteString) +import qualified Data.ByteString +import qualified Data.ByteString.Char8 +import qualified Data.ByteString.Lazy +import qualified Data.ByteString.Unsafe +import Data.Int +import Data.List (intercalate) +import qualified Data.Map +import Data.Map (Map) +import qualified Data.String +import qualified Data.Text +import Data.Text (Text) +import qualified Data.Text.Encoding +import qualified Data.Text.Lazy +import qualified Data.Vector +import Data.Vector (Vector) +import Data.Word +import qualified Foreign +import System.IO.Unsafe (unsafePerformIO) + + +import qualified Text.ParserCombinators.Parsec as Parsec +import Text.ParserCombinators.Parsec ((<|>), oneOf) + + +import DBus.Util (void) + + +data Type + = TypeBoolean + | TypeWord8 + | TypeWord16 + | TypeWord32 + | TypeWord64 + | TypeInt16 + | TypeInt32 + | TypeInt64 + | TypeDouble + | TypeString + | TypeSignature + | TypeObjectPath + | TypeVariant + | TypeArray Type + | TypeDictionary Type Type + | TypeStructure [Type] + deriving (Eq, Ord) + +instance Show Type where + showsPrec d = showString . showType (d > 10) + +showType :: Bool -> Type -> String +showType paren t = case t of + TypeBoolean -> "Bool" + TypeWord8 -> "Word8" + TypeWord16 -> "Word16" + TypeWord32 -> "Word32" + TypeWord64 -> "Word64" + TypeInt16 -> "Int16" + TypeInt32 -> "Int32" + TypeInt64 -> "Int64" + TypeDouble -> "Double" + TypeString -> "String" + TypeSignature -> "Signature" + TypeObjectPath -> "ObjectPath" + TypeVariant -> "Variant" + TypeArray t' -> concat ["[", show t', "]"] + TypeDictionary kt vt -> showParen paren ( + showString "Map " . + shows kt . + showString " " . + showsPrec 11 vt) "" + TypeStructure ts -> concat + ["(", intercalate ", " (map show ts), ")"] + +newtype Signature = Signature [Type] + deriving (Eq, Ord) + +signatureTypes :: Signature -> [Type] +signatureTypes (Signature types) = types + +instance Show Signature where + showsPrec d sig = showParen (d > 10) $ + showString "Signature " . + shows (signatureText sig) + +signatureText :: Signature -> Text +signatureText = Data.Text.Encoding.decodeUtf8 + . Data.ByteString.Char8.pack + . concatMap typeCode + . signatureTypes + +typeCode :: Type -> String +typeCode TypeBoolean = "b" +typeCode TypeWord8 = "y" +typeCode TypeWord16 = "q" +typeCode TypeWord32 = "u" +typeCode TypeWord64 = "t" +typeCode TypeInt16 = "n" +typeCode TypeInt32 = "i" +typeCode TypeInt64 = "x" +typeCode TypeDouble = "d" +typeCode TypeString = "s" +typeCode TypeSignature = "g" +typeCode TypeObjectPath = "o" +typeCode TypeVariant = "v" +typeCode (TypeArray t) = 'a' : typeCode t +typeCode (TypeDictionary kt vt) = concat + [ "a{", typeCode kt , typeCode vt, "}"] + +typeCode (TypeStructure ts) = concat + ["(", concatMap typeCode ts, ")"] + +instance Data.String.IsString Signature where + fromString = signature_ . Data.Text.pack + +signature :: Text -> Maybe Signature +signature text = parseSignature bytes where + bytes = Data.Text.Encoding.encodeUtf8 text + +signature_ :: Text -> Signature +signature_ = tryParse "signature" signature + +parseSignature :: ByteString -> Maybe Signature +parseSignature bytes = + case Data.ByteString.length bytes of + 0 -> Just (Signature []) + 1 -> parseSigFast bytes + len | len <= 255 -> parseSigFull bytes + _ -> Nothing + +checkSignature :: [Type] -> Maybe Signature +checkSignature = check where + check ts = if sumLen ts > 255 + then Nothing + else Just (Signature ts) + sumLen :: [Type] -> Int + sumLen = sum . map len + + len (TypeArray t) = 1 + len t + len (TypeDictionary kt vt) = 3 + len kt + len vt + len (TypeStructure ts) = 2 + sumLen ts + len _ = 1 + +parseSigFast :: ByteString -> Maybe Signature +parseSigFast bytes = + let byte = Data.ByteString.head bytes in + parseAtom byte + (\t -> Just (Signature [t])) + (case byte of + 0x76 -> Just (Signature [TypeVariant]) + _ -> Nothing) + +parseAtom :: Word8 -> (Type -> a) -> a -> a +parseAtom byte yes no = case byte of + 0x62 -> yes TypeBoolean + 0x6E -> yes TypeInt16 + 0x69 -> yes TypeInt32 + 0x78 -> yes TypeInt64 + 0x79 -> yes TypeWord8 + 0x71 -> yes TypeWord16 + 0x75 -> yes TypeWord32 + 0x74 -> yes TypeWord64 + 0x64 -> yes TypeDouble + 0x73 -> yes TypeString + 0x67 -> yes TypeSignature + 0x6F -> yes TypeObjectPath + _ -> no + +parseSigFull :: ByteString -> Maybe Signature +parseSigFull bytes = unsafePerformIO io where + io = Data.ByteString.Unsafe.unsafeUseAsCStringLen bytes castBuf + castBuf (ptr, len) = parseSigBuf (Foreign.castPtr ptr, len) + parseSigBuf (buf, len) = mainLoop [] 0 where + + mainLoop acc ii | ii >= len = return (Just (Signature (reverse acc))) + mainLoop acc ii = do + c <- Foreign.peekElemOff buf ii + let next t = mainLoop (t : acc) (ii + 1) + parseAtom c next $ case c of + 0x76 -> next TypeVariant + 0x28 -> do -- '(' + mt <- structure (ii + 1) + case mt of + Just (ii', t) -> mainLoop (t : acc) ii' + Nothing -> return Nothing + 0x61 -> do -- 'a' + mt <- array (ii + 1) + case mt of + Just (ii', t) -> mainLoop (t : acc) ii' + Nothing -> return Nothing + _ -> return Nothing + + structure :: Int -> IO (Maybe (Int, Type)) + structure = loop [] where + loop _ ii | ii >= len = return Nothing + loop acc ii = do + c <- Foreign.peekElemOff buf ii + let next t = loop (t : acc) (ii + 1) + parseAtom c next $ case c of + 0x76 -> next TypeVariant + 0x28 -> do -- '(' + mt <- structure (ii + 1) + case mt of + Just (ii', t) -> loop (t : acc) ii' + Nothing -> return Nothing + 0x61 -> do -- 'a' + mt <- array (ii + 1) + case mt of + Just (ii', t) -> loop (t : acc) ii' + Nothing -> return Nothing + -- ')' + 0x29 -> return $ case acc of + [] -> Nothing + _ -> Just $ (ii + 1, TypeStructure (reverse acc)) + _ -> return Nothing + + array :: Int -> IO (Maybe (Int, Type)) + array ii | ii >= len = return Nothing + array ii = do + c <- Foreign.peekElemOff buf ii + let next t = return $ Just (ii + 1, TypeArray t) + parseAtom c next $ case c of + 0x76 -> next TypeVariant + 0x7B -> dict (ii + 1) -- '{' + 0x28 -> do -- '(' + mt <- structure (ii + 1) + case mt of + Just (ii', t) -> return $ Just (ii', TypeArray t) + Nothing -> return Nothing + 0x61 -> do -- 'a' + mt <- array (ii + 1) + case mt of + Just (ii', t) -> return $ Just (ii', TypeArray t) + Nothing -> return Nothing + _ -> return Nothing + + dict :: Int -> IO (Maybe (Int, Type)) + dict ii | ii + 1 >= len = return Nothing + dict ii = do + c1 <- Foreign.peekElemOff buf ii + c2 <- Foreign.peekElemOff buf (ii + 1) + + let next t = return (Just (ii + 2, t)) + mt2 <- parseAtom c2 next $ case c2 of + 0x76 -> next TypeVariant + 0x28 -> structure (ii + 2) -- '(' + 0x61 -> array (ii + 2) -- 'a' + _ -> return Nothing + + case mt2 of + Nothing -> return Nothing + Just (ii', t2) -> if ii' >= len + then return Nothing + else do + c3 <- Foreign.peekElemOff buf ii' + return $ do + if c3 == 0x7D then Just () else Nothing + t1 <- parseAtom c1 Just Nothing + Just (ii' + 1, TypeDictionary t1 t2) + +class IsVariant a where + toVariant :: a -> Variant + fromVariant :: Variant -> Maybe a + +class IsVariant a => IsValue a where + typeOf :: a -> Type + toValue :: a -> Value + fromValue :: Value -> Maybe a + +class IsValue a => IsAtom a where + toAtom :: a -> Atom + fromAtom :: Atom -> Maybe a + + +-- | 'Variant's may contain any other built‐in D‐Bus value. Besides +-- representing native @VARIANT@ values, they allow type‐safe storage and +-- deconstruction of heterogeneous collections. + +newtype Variant = Variant Value + deriving (Eq) + +data Value + = ValueAtom Atom + | ValueVariant Variant + | ValueBytes ByteString + | ValueVector Type (Vector Value) + | ValueMap Type Type (Map Atom Value) + | ValueStructure [Value] + deriving (Show) + +data Atom + = AtomBool Bool + | AtomWord8 Word8 + | AtomWord16 Word16 + | AtomWord32 Word32 + | AtomWord64 Word64 + | AtomInt16 Int16 + | AtomInt32 Int32 + | AtomInt64 Int64 + | AtomDouble Double + | AtomText Text + | AtomSignature Signature + | AtomObjectPath ObjectPath + deriving (Show, Eq, Ord) + +instance Eq Value where + (==) (ValueBytes x) y = case y of + ValueBytes y' -> x == y' + ValueVector TypeWord8 y' -> x == vectorToBytes y' + _ -> False + + (==) (ValueVector TypeWord8 x) y = case y of + ValueBytes y' -> vectorToBytes x == y' + ValueVector TypeWord8 y' -> x == y' + _ -> False + + (==) (ValueAtom x) (ValueAtom y) = x == y + (==) (ValueVariant x) (ValueVariant y) = x == y + (==) (ValueVector tx x) (ValueVector ty y) = tx == ty && x == y + (==) (ValueMap ktx vtx x) (ValueMap kty vty y) = ktx == kty && vtx == vty && x == y + (==) (ValueStructure x) (ValueStructure y) = x == y + (==) _ _ = False + +showAtom :: Bool -> Atom -> String +showAtom _ (AtomBool x) = show x +showAtom _ (AtomWord8 x) = show x +showAtom _ (AtomWord16 x) = show x +showAtom _ (AtomWord32 x) = show x +showAtom _ (AtomWord64 x) = show x +showAtom _ (AtomInt16 x) = show x +showAtom _ (AtomInt32 x) = show x +showAtom _ (AtomInt64 x) = show x +showAtom _ (AtomDouble x) = show x +showAtom _ (AtomText x) = show x +showAtom p (AtomSignature x) = showsPrec (if p then 11 else 0) x "" +showAtom p (AtomObjectPath x) = showsPrec (if p then 11 else 0) x "" + +showValue :: Bool -> Value -> String +showValue p (ValueAtom x) = showAtom p x +showValue p (ValueVariant x) = showsPrec (if p then 11 else 0) x "" +showValue _ (ValueBytes xs) = 'b' : show xs +showValue _ (ValueVector TypeWord8 xs) = 'b' : show (vectorToBytes xs) +showValue _ (ValueVector _ xs) = showThings "[" (showValue False) "]" (Data.Vector.toList xs) +showValue _ (ValueMap _ _ xs) = showThings "{" showPair "}" (Data.Map.toList xs) where + showPair (k, v) = showAtom False k ++ ": " ++ showValue False v +showValue _ (ValueStructure xs) = showThings "(" (showValue False) ")" xs + +showThings :: String -> (a -> String) -> String -> [a] -> String +showThings a s z xs = a ++ intercalate ", " (map s xs) ++ z + +vectorToBytes :: Vector Value -> ByteString +vectorToBytes = Data.ByteString.pack + . Data.Vector.toList + . Data.Vector.map (\(ValueAtom (AtomWord8 x)) -> x) + +instance Show Variant where + showsPrec d (Variant x) = showParen (d > 10) $ + showString "Variant " . showString (showValue True x) + + +-- | Every variant is strongly‐typed; that is, the type of its contained +-- value is known at all times. This function retrieves that type, so that +-- the correct cast can be used to retrieve the value. + +variantType :: Variant -> Type +variantType (Variant val) = valueType val + +valueType :: Value -> Type +valueType (ValueAtom x) = atomType x +valueType (ValueVariant _) = TypeVariant +valueType (ValueVector t _) = TypeArray t +valueType (ValueBytes _) = TypeArray TypeWord8 +valueType (ValueMap kt vt _) = TypeDictionary kt vt +valueType (ValueStructure vs) = TypeStructure (map valueType vs) + +atomType :: Atom -> Type +atomType (AtomBool _) = TypeBoolean +atomType (AtomWord8 _) = TypeWord8 +atomType (AtomWord16 _) = TypeWord16 +atomType (AtomWord32 _) = TypeWord32 +atomType (AtomWord64 _) = TypeWord64 +atomType (AtomInt16 _) = TypeInt16 +atomType (AtomInt32 _) = TypeInt32 +atomType (AtomInt64 _) = TypeInt64 +atomType (AtomDouble _) = TypeDouble +atomType (AtomText _) = TypeString +atomType (AtomSignature _) = TypeSignature +atomType (AtomObjectPath _) = TypeObjectPath + +#define IS_ATOM(HsType, AtomCons, TypeCons) \ + instance IsAtom HsType where \ + { toAtom = AtomCons \ + ; fromAtom (AtomCons x) = Just x \ + ; fromAtom _ = Nothing \ + }; \ + instance IsValue HsType where \ + { typeOf _ = TypeCons \ + ; toValue = ValueAtom . toAtom \ + ; fromValue (ValueAtom x) = fromAtom x \ + ; fromValue _ = Nothing \ + }; \ + instance IsVariant HsType where \ + { toVariant = Variant . toValue \ + ; fromVariant (Variant val) = fromValue val \ + } + +IS_ATOM(Bool, AtomBool, TypeBoolean) +IS_ATOM(Word8, AtomWord8, TypeWord8) +IS_ATOM(Word16, AtomWord16, TypeWord16) +IS_ATOM(Word32, AtomWord32, TypeWord32) +IS_ATOM(Word64, AtomWord64, TypeWord64) +IS_ATOM(Int16, AtomInt16, TypeInt16) +IS_ATOM(Int32, AtomInt32, TypeInt32) +IS_ATOM(Int64, AtomInt64, TypeInt64) +IS_ATOM(Double, AtomDouble, TypeDouble) +IS_ATOM(Text, AtomText, TypeString) +IS_ATOM(Signature, AtomSignature, TypeSignature) +IS_ATOM(ObjectPath, AtomObjectPath, TypeObjectPath) + +instance IsValue Variant where + typeOf _ = TypeVariant + toValue = ValueVariant + fromValue (ValueVariant x) = Just x + fromValue _ = Nothing + +instance IsVariant Variant where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val + +instance IsAtom Data.Text.Lazy.Text where + toAtom = toAtom . Data.Text.Lazy.toStrict + fromAtom = fmap Data.Text.Lazy.fromStrict . fromAtom + +instance IsValue Data.Text.Lazy.Text where + typeOf _ = TypeString + toValue = ValueAtom . toAtom + fromValue (ValueAtom x) = fromAtom x + fromValue _ = Nothing + +instance IsVariant Data.Text.Lazy.Text where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val + +instance IsAtom String where + toAtom = toAtom . Data.Text.pack + fromAtom = fmap Data.Text.unpack . fromAtom + +instance IsValue String where + typeOf _ = TypeString + toValue = ValueAtom . toAtom + fromValue (ValueAtom x) = fromAtom x + fromValue _ = Nothing + +instance IsVariant String where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val + +instance IsValue a => IsValue (Vector a) where + typeOf v = TypeArray (vectorItemType v) + toValue v = ValueVector (vectorItemType v) (Data.Vector.map toValue v) + fromValue (ValueVector _ v) = Data.Vector.mapM fromValue v + fromValue _ = Nothing + +vectorItemType :: IsValue a => Vector a -> Type +vectorItemType v = typeOf (undefined `asTypeOf` Data.Vector.head v) + +instance IsValue a => IsVariant (Vector a) where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val + +instance IsValue a => IsValue [a] where + typeOf v = TypeArray (typeOf (undefined `asTypeOf` head v)) + toValue = toValue . Data.Vector.fromList + fromValue = fmap Data.Vector.toList . fromValue + +instance IsValue a => IsVariant [a] where + toVariant = toVariant . Data.Vector.fromList + fromVariant = fmap Data.Vector.toList . fromVariant + +instance IsValue ByteString where + typeOf _ = TypeArray TypeWord8 + toValue = ValueBytes + fromValue (ValueBytes bs) = Just bs + fromValue (ValueVector TypeWord8 v) = Just (vectorToBytes v) + fromValue _ = Nothing + +instance IsVariant ByteString where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val + +instance IsValue Data.ByteString.Lazy.ByteString where + typeOf _ = TypeArray TypeWord8 + toValue = toValue + . Data.ByteString.concat + . Data.ByteString.Lazy.toChunks + fromValue = fmap (\bs -> Data.ByteString.Lazy.fromChunks [bs]) + . fromValue + +instance IsVariant Data.ByteString.Lazy.ByteString where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val + +instance (Ord k, IsAtom k, IsValue v) => IsValue (Map k v) where + typeOf m = TypeDictionary kt vt where + (kt, vt) = mapItemType m + + toValue m = ValueMap kt vt (bimap box m) where + (kt, vt) = mapItemType m + box k v = (toAtom k, toValue v) + + fromValue (ValueMap _ _ m) = bimapM unbox m where + unbox k v = do + k' <- fromAtom k + v' <- fromValue v + return (k', v') + fromValue _ = Nothing + +bimap :: Ord k' => (k -> v -> (k', v')) -> Map k v -> Map k' v' +bimap f = Data.Map.fromList . map (\(k, v) -> f k v) . Data.Map.toList + +bimapM :: (Monad m, Ord k') => (k -> v -> m (k', v')) -> Map k v -> m (Map k' v') +bimapM f = liftM Data.Map.fromList . mapM (\(k, v) -> f k v) . Data.Map.toList + +mapItemType :: (IsValue k, IsValue v) => Map k v -> (Type, Type) +mapItemType m = (typeOf k, typeOf v) where + mapItem :: Map k v -> (k, v) + mapItem _ = (undefined, undefined) + (k, v) = mapItem m + +instance (Ord k, IsAtom k, IsValue v) => IsVariant (Map k v) where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val + +instance (IsValue a1, IsValue a2) => IsValue (a1, a2) where + typeOf ~(a1, a2) = TypeStructure [typeOf a1, typeOf a2] + toValue (a1, a2) = ValueStructure [toValue a1, toValue a2] + fromValue (ValueStructure [a1, a2]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + return (a1', a2') + fromValue _ = Nothing + +instance (IsVariant a1, IsVariant a2) => IsVariant (a1, a2) where + toVariant (a1, a2) = Variant (ValueStructure [varToVal a1, varToVal a2]) + fromVariant (Variant (ValueStructure [a1, a2])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + return (a1', a2') + fromVariant _ = Nothing + +varToVal :: IsVariant a => a -> Value +varToVal a = case toVariant a of + Variant val -> val + +newtype ObjectPath = ObjectPath Text + deriving (Eq, Ord, Show) + +objectPathText :: ObjectPath -> Text +objectPathText (ObjectPath text) = text + +objectPath :: Text -> Maybe ObjectPath +objectPath text = do + runParser parseObjectPath text + return (ObjectPath text) + +objectPath_ :: Text -> ObjectPath +objectPath_ = tryParse "object path" objectPath + +instance Data.String.IsString ObjectPath where + fromString = objectPath_ . Data.Text.pack + +parseObjectPath :: Parsec.Parser () +parseObjectPath = root <|> object where + root = Parsec.try $ do + slash + Parsec.eof + + object = do + slash + skipSepBy1 element slash + Parsec.eof + + element = Parsec.skipMany1 (oneOf chars) + + slash = void (Parsec.char '/') + chars = concat [ ['a'..'z'] + , ['A'..'Z'] + , ['0'..'9'] + , "_"] + +newtype InterfaceName = InterfaceName Text + deriving (Eq, Ord, Show) + +interfaceNameText :: InterfaceName -> Text +interfaceNameText (InterfaceName text) = text + +interfaceName :: Text -> Maybe InterfaceName +interfaceName text = do + when (Data.Text.length text > 255) Nothing + runParser parseInterfaceName text + return (InterfaceName text) + +interfaceName_ :: Text -> InterfaceName +interfaceName_ = tryParse "interface name" interfaceName + +instance Data.String.IsString InterfaceName where + fromString = interfaceName_ . Data.Text.pack + +instance IsVariant InterfaceName where + toVariant = toVariant . interfaceNameText + fromVariant = fromVariant >=> interfaceName + +parseInterfaceName :: Parsec.Parser () +parseInterfaceName = name >> Parsec.eof where + alpha = ['a'..'z'] ++ ['A'..'Z'] ++ "_" + alphanum = alpha ++ ['0'..'9'] + element = do + void (oneOf alpha) + Parsec.skipMany (oneOf alphanum) + name = do + element + void (Parsec.char '.') + skipSepBy1 element (Parsec.char '.') + +newtype MemberName = MemberName Text + deriving (Eq, Ord, Show) + +memberNameText :: MemberName -> Text +memberNameText (MemberName text) = text + +memberName :: Text -> Maybe MemberName +memberName text = do + when (Data.Text.length text > 255) Nothing + runParser parseMemberName text + return (MemberName text) + +memberName_ :: Text -> MemberName +memberName_ = tryParse "member name" memberName + +instance Data.String.IsString MemberName where + fromString = memberName_ . Data.Text.pack + +instance IsVariant MemberName where + toVariant = toVariant . memberNameText + fromVariant = fromVariant >=> memberName + +parseMemberName :: Parsec.Parser () +parseMemberName = name >> Parsec.eof where + alpha = ['a'..'z'] ++ ['A'..'Z'] ++ "_" + alphanum = alpha ++ ['0'..'9'] + name = do + void (oneOf alpha) + Parsec.skipMany (oneOf alphanum) + +newtype ErrorName = ErrorName Text + deriving (Eq, Ord, Show) + +errorNameText :: ErrorName -> Text +errorNameText (ErrorName text) = text + +errorName :: Text -> Maybe ErrorName +errorName text = do + when (Data.Text.length text > 255) Nothing + runParser parseInterfaceName text + return (ErrorName text) + +errorName_ :: Text -> ErrorName +errorName_ = tryParse "error name" errorName + +instance Data.String.IsString ErrorName where + fromString = errorName_ . Data.Text.pack + +instance IsVariant ErrorName where + toVariant = toVariant . errorNameText + fromVariant = fromVariant >=> errorName + +newtype BusName = BusName Text + deriving (Eq, Ord, Show) + +busNameText :: BusName -> Text +busNameText (BusName text) = text + +busName :: Text -> Maybe BusName +busName text = do + when (Data.Text.length text > 255) Nothing + runParser parseBusName text + return (BusName text) + +busName_ :: Text -> BusName +busName_ = tryParse "bus name" busName + +instance Data.String.IsString BusName where + fromString = busName_ . Data.Text.pack + +instance IsVariant BusName where + toVariant = toVariant . busNameText + fromVariant = fromVariant >=> busName + +parseBusName :: Parsec.Parser () +parseBusName = name >> Parsec.eof where + alpha = ['a'..'z'] ++ ['A'..'Z'] ++ "_-" + alphanum = alpha ++ ['0'..'9'] + + name = unique <|> wellKnown + unique = do + void (Parsec.char ':') + elements alphanum + + wellKnown = elements alpha + + elements start = do + element start + Parsec.skipMany1 $ do + void (Parsec.char '.') + element start + + element start = do + void (oneOf start) + Parsec.skipMany (oneOf alphanum) + +newtype Structure = Structure [Value] + deriving (Eq) + +instance Show Structure where + show (Structure xs) = showValue True (ValueStructure xs) + +instance IsVariant Structure where + toVariant (Structure xs) = Variant (ValueStructure xs) + fromVariant (Variant (ValueStructure xs)) = Just (Structure xs) + fromVariant _ = Nothing + +structureItems :: Structure -> [Variant] +structureItems (Structure xs) = map Variant xs + +data Array + = Array Type (Vector Value) + | ArrayBytes ByteString + +instance Show Array where + show (Array t xs) = showValue True (ValueVector t xs) + show (ArrayBytes xs) = showValue True (ValueBytes xs) + +instance Eq Array where + x == y = norm x == norm y where + norm (Array TypeWord8 xs) = Left (vectorToBytes xs) + norm (Array t xs) = Right (t, xs) + norm (ArrayBytes xs) = Left xs + +instance IsVariant Array where + toVariant (Array t xs) = Variant (ValueVector t xs) + toVariant (ArrayBytes bs) = Variant (ValueBytes bs) + fromVariant (Variant (ValueVector t xs)) = Just (Array t xs) + fromVariant (Variant (ValueBytes bs)) = Just (ArrayBytes bs) + fromVariant _ = Nothing + +arrayItems :: Array -> [Variant] +arrayItems (Array _ xs) = map Variant (Data.Vector.toList xs) +arrayItems (ArrayBytes bs) = map toVariant (Data.ByteString.unpack bs) + +data Dictionary = Dictionary Type Type (Map Atom Value) + deriving (Eq) + +instance Show Dictionary where + show (Dictionary kt vt xs) = showValue True (ValueMap kt vt xs) + +instance IsVariant Dictionary where + toVariant (Dictionary kt vt xs) = Variant (ValueMap kt vt xs) + fromVariant (Variant (ValueMap kt vt xs)) = Just (Dictionary kt vt xs) + fromVariant _ = Nothing + +dictionaryItems :: Dictionary -> [(Variant, Variant)] +dictionaryItems (Dictionary _ _ xs) = do + (k, v) <- Data.Map.toList xs + return (Variant (ValueAtom k), Variant v) + +instance (IsValue a1, IsValue a2, IsValue a3) => IsValue (a1, a2, a3) where + typeOf ~(a1, a2, a3) = TypeStructure [typeOf a1, typeOf a2, typeOf a3] + toValue (a1, a2, a3) = ValueStructure [toValue a1, toValue a2, toValue a3] + fromValue (ValueStructure [a1, a2, a3]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + return (a1', a2', a3') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4) => IsValue (a1, a2, a3, a4) where + typeOf ~(a1, a2, a3, a4) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4] + toValue (a1, a2, a3, a4) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4] + fromValue (ValueStructure [a1, a2, a3, a4]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + return (a1', a2', a3', a4') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5) => IsValue (a1, a2, a3, a4, a5) where + typeOf ~(a1, a2, a3, a4, a5) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5] + toValue (a1, a2, a3, a4, a5) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5] + fromValue (ValueStructure [a1, a2, a3, a4, a5]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + return (a1', a2', a3', a4', a5') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6) => IsValue (a1, a2, a3, a4, a5, a6) where + typeOf ~(a1, a2, a3, a4, a5, a6) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6] + toValue (a1, a2, a3, a4, a5, a6) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + return (a1', a2', a3', a4', a5', a6') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7) => IsValue (a1, a2, a3, a4, a5, a6, a7) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7] + toValue (a1, a2, a3, a4, a5, a6, a7) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + return (a1', a2', a3', a4', a5', a6', a7') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8] + toValue (a1, a2, a3, a4, a5, a6, a7, a8) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + return (a1', a2', a3', a4', a5', a6', a7', a8') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9, IsValue a10) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9, typeOf a10] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9, toValue a10] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + a10' <- fromValue a10 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9, IsValue a10, IsValue a11) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9, typeOf a10, typeOf a11] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9, toValue a10, toValue a11] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + a10' <- fromValue a10 + a11' <- fromValue a11 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9, IsValue a10, IsValue a11, IsValue a12) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9, typeOf a10, typeOf a11, typeOf a12] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9, toValue a10, toValue a11, toValue a12] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + a10' <- fromValue a10 + a11' <- fromValue a11 + a12' <- fromValue a12 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9, IsValue a10, IsValue a11, IsValue a12, IsValue a13) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9, typeOf a10, typeOf a11, typeOf a12, typeOf a13] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9, toValue a10, toValue a11, toValue a12, toValue a13] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + a10' <- fromValue a10 + a11' <- fromValue a11 + a12' <- fromValue a12 + a13' <- fromValue a13 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12', a13') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9, IsValue a10, IsValue a11, IsValue a12, IsValue a13, IsValue a14) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9, typeOf a10, typeOf a11, typeOf a12, typeOf a13, typeOf a14] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9, toValue a10, toValue a11, toValue a12, toValue a13, toValue a14] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + a10' <- fromValue a10 + a11' <- fromValue a11 + a12' <- fromValue a12 + a13' <- fromValue a13 + a14' <- fromValue a14 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12', a13', a14') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9, IsValue a10, IsValue a11, IsValue a12, IsValue a13, IsValue a14, IsValue a15) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9, typeOf a10, typeOf a11, typeOf a12, typeOf a13, typeOf a14, typeOf a15] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9, toValue a10, toValue a11, toValue a12, toValue a13, toValue a14, toValue a15] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + a10' <- fromValue a10 + a11' <- fromValue a11 + a12' <- fromValue a12 + a13' <- fromValue a13 + a14' <- fromValue a14 + a15' <- fromValue a15 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12', a13', a14', a15') + fromValue _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3) => IsVariant (a1, a2, a3) where + toVariant (a1, a2, a3) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3]) + fromVariant (Variant (ValueStructure [a1, a2, a3])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + return (a1', a2', a3') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4) => IsVariant (a1, a2, a3, a4) where + toVariant (a1, a2, a3, a4) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + return (a1', a2', a3', a4') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5) => IsVariant (a1, a2, a3, a4, a5) where + toVariant (a1, a2, a3, a4, a5) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + return (a1', a2', a3', a4', a5') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6) => IsVariant (a1, a2, a3, a4, a5, a6) where + toVariant (a1, a2, a3, a4, a5, a6) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + return (a1', a2', a3', a4', a5', a6') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7) => IsVariant (a1, a2, a3, a4, a5, a6, a7) where + toVariant (a1, a2, a3, a4, a5, a6, a7) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + return (a1', a2', a3', a4', a5', a6', a7') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + return (a1', a2', a3', a4', a5', a6', a7', a8') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9, IsVariant a10) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9, varToVal a10]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + a10' <- (fromVariant . Variant) a10 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9, IsVariant a10, IsVariant a11) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9, varToVal a10, varToVal a11]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + a10' <- (fromVariant . Variant) a10 + a11' <- (fromVariant . Variant) a11 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9, IsVariant a10, IsVariant a11, IsVariant a12) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9, varToVal a10, varToVal a11, varToVal a12]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + a10' <- (fromVariant . Variant) a10 + a11' <- (fromVariant . Variant) a11 + a12' <- (fromVariant . Variant) a12 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9, IsVariant a10, IsVariant a11, IsVariant a12, IsVariant a13) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9, varToVal a10, varToVal a11, varToVal a12, varToVal a13]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + a10' <- (fromVariant . Variant) a10 + a11' <- (fromVariant . Variant) a11 + a12' <- (fromVariant . Variant) a12 + a13' <- (fromVariant . Variant) a13 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12', a13') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9, IsVariant a10, IsVariant a11, IsVariant a12, IsVariant a13, IsVariant a14) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9, varToVal a10, varToVal a11, varToVal a12, varToVal a13, varToVal a14]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + a10' <- (fromVariant . Variant) a10 + a11' <- (fromVariant . Variant) a11 + a12' <- (fromVariant . Variant) a12 + a13' <- (fromVariant . Variant) a13 + a14' <- (fromVariant . Variant) a14 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12', a13', a14') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9, IsVariant a10, IsVariant a11, IsVariant a12, IsVariant a13, IsVariant a14, IsVariant a15) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9, varToVal a10, varToVal a11, varToVal a12, varToVal a13, varToVal a14, varToVal a15]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + a10' <- (fromVariant . Variant) a10 + a11' <- (fromVariant . Variant) a11 + a12' <- (fromVariant . Variant) a12 + a13' <- (fromVariant . Variant) a13 + a14' <- (fromVariant . Variant) a14 + a15' <- (fromVariant . Variant) a15 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12', a13', a14', a15') + fromVariant _ = Nothing + + +skipSepBy1 :: Parsec.Parser a -> Parsec.Parser b -> Parsec.Parser () +skipSepBy1 p sep = do + void p + Parsec.skipMany (sep >> p) + +runParser :: Parsec.Parser a -> Text -> Maybe a +runParser parser text = case Parsec.parse parser "" (Data.Text.unpack text) of + Left _ -> Nothing + Right a -> Just a + +tryParse :: String -> (Text -> Maybe a) -> Text -> a +tryParse label parse text = case parse text of + Just x -> x + Nothing -> error ("Invalid " ++ label ++ ": " ++ show text) diff --git a/hs/DBus/UUID.hs b/hs/DBus/UUID.hs deleted file mode 100644 --- a/hs/DBus/UUID.hs +++ /dev/null @@ -1,50 +0,0 @@ - - --- Copyright (C) 2009-2010 John Millikin --- --- 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 --- 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 . - -module DBus.UUID - ( UUID - , toHex - , fromHex - ) where - -import Data.Text.Lazy (Text) -import qualified Data.Text.Lazy as TL - - -newtype UUID = UUID Text -- TODO: (Word64, Word64)? - deriving (Eq) - -instance Show UUID where - showsPrec d uuid = showParen (d > 10) $ - showString "UUID " . shows (toHex uuid) - -toHex :: UUID -> Text -toHex (UUID text) = text - -fromHex :: Text -> Maybe UUID -fromHex text = if validUUID text - then Just $ UUID text - else Nothing - -validUUID :: Text -> Bool -validUUID text = valid where - valid = and [TL.length text == 32, TL.all validChar text] - validChar c = or - [ c >= '0' && c <= '9' - , c >= 'a' && c <= 'f' - , c >= 'A' && c <= 'F' - ] diff --git a/hs/DBus/Util.hs b/hs/DBus/Util.hs --- a/hs/DBus/Util.hs +++ b/hs/DBus/Util.hs @@ -1,6 +1,6 @@ --- Copyright (C) 2009-2010 John Millikin +-- Copyright (C) 2009-2011 John Millikin -- -- 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 @@ -15,34 +15,20 @@ -- You should have received a copy of the GNU General Public License -- along with this program. If not, see . -module DBus.Util where -import Text.ParserCombinators.Parsec (Parser, parse) +module DBus.Util + ( hexToInt + , maybeIndex + , readUntil + , dropEnd + , void + , untilM + ) where import Data.Char (digitToInt) import Data.List (isPrefixOf) -checkLength :: Int -> String -> Maybe String -checkLength length' s | length s <= length' = Just s -checkLength _ _ = Nothing - -parseMaybe :: Parser a -> String -> Maybe a -parseMaybe p = either (const Nothing) Just . parse p "" - -mkUnsafe :: Show a => String -> (a -> Maybe b) -> a -> b -mkUnsafe label f x = case f x of - Just x' -> x' - Nothing -> error $ "Invalid " ++ label ++ ": " ++ show x - hexToInt :: String -> Int hexToInt = foldl ((+) . (16 *)) 0 . map digitToInt -eitherToMaybe :: Either a b -> Maybe b -eitherToMaybe (Left _) = Nothing -eitherToMaybe (Right x) = Just x - -fromRight :: Either a b -> b -fromRight (Right x) = x -fromRight _ = error "DBus.Util.fromRight: Left" - maybeIndex :: [a] -> Int -> Maybe a maybeIndex (x:_ ) 0 = Just x maybeIndex (_:xs) n | n > 0 = maybeIndex xs (n - 1) @@ -66,3 +52,13 @@ void :: Monad m => m a -> m () void m = m >> return () + +untilM :: Monad m => m Bool -> m a -> m [a] +untilM test comp = do + done <- test + if done + then return [] + else do + x <- comp + xs <- untilM test comp + return (x:xs) diff --git a/hs/DBus/Util/MonadError.hs b/hs/DBus/Util/MonadError.hs --- a/hs/DBus/Util/MonadError.hs +++ b/hs/DBus/Util/MonadError.hs @@ -1,6 +1,6 @@ --- Copyright (C) 2009-2010 John Millikin +-- Copyright (C) 2009-2011 John Millikin -- -- 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 diff --git a/hs/DBus/Wire.hs b/hs/DBus/Wire.hs --- a/hs/DBus/Wire.hs +++ b/hs/DBus/Wire.hs @@ -1,6 +1,6 @@ --- Copyright (C) 2009-2010 John Millikin +-- Copyright (C) 2009-2011 John Millikin -- -- 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 @@ -15,19 +15,11 @@ -- You should have received a copy of the GNU General Public License -- along with this program. If not, see . -module DBus.Wire ( - - Endianness (..) - - , MarshalError (..) - - , UnmarshalError (..) - +module DBus.Wire + ( Endianness (..) + , MarshalError + , UnmarshalError , marshalMessage - , unmarshalMessage - ) where import DBus.Wire.Internal -import DBus.Wire.Marshal -import DBus.Wire.Unmarshal diff --git a/hs/DBus/Wire/Internal.hs b/hs/DBus/Wire/Internal.hs --- a/hs/DBus/Wire/Internal.hs +++ b/hs/DBus/Wire/Internal.hs @@ -1,6 +1,7 @@ +{-# LANGUAGE OverloadedStrings #-} --- Copyright (C) 2009-2010 John Millikin +-- Copyright (C) 2009-2011 John Millikin -- -- 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 @@ -16,52 +17,739 @@ -- along with this program. If not, see . module DBus.Wire.Internal where -import Data.Word (Word8, Word64) -import qualified DBus.Types as T +import Control.Monad (liftM, when, unless) +import qualified Data.Binary.Builder +import qualified Data.Binary.Get +import Data.Binary.Put (runPut) +import Data.Bits ((.&.), (.|.)) +import qualified Data.ByteString +import Data.ByteString (ByteString) +import qualified Data.ByteString.Char8 +import qualified Data.ByteString.Lazy +import Data.Int (Int16, Int32, Int64) +import qualified Data.Map +import Data.Map (Map) +import Data.Maybe (fromJust, listToMaybe, fromMaybe) +import qualified Data.Set +import Data.Set (Set) +import qualified Data.Text +import Data.Text (Text) +import qualified Data.Text.Encoding +import qualified Data.Vector +import Data.Vector (Vector) +import Data.Word (Word8, Word16, Word32, Word64) + +import qualified Data.Binary.IEEE754 + +import DBus.Message.Internal +import DBus.Types.Internal +import DBus.Util (void, untilM) +import qualified DBus.Util.MonadError as E + + data Endianness = LittleEndian | BigEndian deriving (Show, Eq) encodeEndianness :: Endianness -> Word8 -encodeEndianness LittleEndian = 108 -encodeEndianness BigEndian = 66 +encodeEndianness LittleEndian = 0x6C +encodeEndianness BigEndian = 0x42 decodeEndianness :: Word8 -> Maybe Endianness -decodeEndianness 108 = Just LittleEndian -decodeEndianness 66 = Just BigEndian -decodeEndianness _ = Nothing +decodeEndianness 0x6C = Just LittleEndian +decodeEndianness 0x42 = Just BigEndian +decodeEndianness _ = Nothing -alignment :: T.Type -> Word8 +alignment :: Type -> Word8 +alignment TypeBoolean = 4 +alignment TypeWord8 = 1 +alignment TypeWord16 = 2 +alignment TypeWord32 = 4 +alignment TypeWord64 = 8 +alignment TypeInt16 = 2 +alignment TypeInt32 = 4 +alignment TypeInt64 = 8 +alignment TypeDouble = 8 +alignment TypeString = 4 +alignment TypeObjectPath = 4 +alignment TypeSignature = 1 +alignment (TypeArray _) = 4 +alignment (TypeDictionary _ _) = 4 +alignment (TypeStructure _) = 8 +alignment TypeVariant = 1 -alignment T.DBusByte = 1 -alignment T.DBusWord16 = 2 -alignment T.DBusWord32 = 4 -alignment T.DBusWord64 = 8 -alignment T.DBusInt16 = 2 -alignment T.DBusInt32 = 4 -alignment T.DBusInt64 = 8 -alignment T.DBusDouble = 8 +padding :: Word64 -> Word8 -> Word64 +padding current count = required where + count' = fromIntegral count + missing = mod current count' + required = if missing > 0 + then count' - missing + else 0 -alignment T.DBusBoolean = 4 +data WireR s a + = WireRL String + | WireRR a {-# UNPACK #-} !s -alignment T.DBusString = 4 -alignment T.DBusObjectPath = 4 +newtype Wire s a = Wire + { unWire :: Endianness -> s -> WireR s a + } -alignment T.DBusSignature = 1 +instance Monad (Wire s) where + {-# INLINE return #-} + return a = Wire (\_ s -> WireRR a s) + + {-# INLINE (>>=) #-} + m >>= k = Wire $ \e s -> case unWire m e s of + WireRL err -> WireRL err + WireRR a s' -> unWire (k a) e s' + + {-# INLINE (>>) #-} + m >> k = Wire $ \e s -> case unWire m e s of + WireRL err -> WireRL err + WireRR _ s' -> unWire k e s' -alignment (T.DBusArray _) = 4 +throwError :: String -> Wire s a +throwError err = Wire (\_ _ -> WireRL err) -alignment (T.DBusDictionary _ _) = 4 +{-# INLINE getState #-} +getState :: Wire s s +getState = Wire (\_ s -> WireRR s s) -alignment (T.DBusStructure _) = 8 +{-# INLINE putState #-} +putState :: s -> Wire s () +putState s = Wire (\_ _ -> WireRR () s) -alignment T.DBusVariant = 1 +{-# INLINE chooseEndian #-} +chooseEndian :: a -> a -> Wire s a +chooseEndian big little = Wire (\e s -> case e of + BigEndian -> WireRR big s + LittleEndian -> WireRR little s) +type Marshal = Wire MarshalState -padding :: Word64 -> Word8 -> Word64 -padding current count = required where - count' = fromIntegral count - missing = mod current count' - required = if missing > 0 - then count' - missing - else 0 +newtype MarshalError = MarshalError Text + deriving (Show, Eq) + +data MarshalState = MarshalState + {-# UNPACK #-} !Data.Binary.Builder.Builder + {-# UNPACK #-} !Word64 + +marshal :: Value -> Marshal () +marshal (ValueAtom x) = marshalAtom x +marshal (ValueBytes xs) = marshalStrictBytes xs +marshal (ValueVector t xs) = marshalVector t xs +marshal (ValueMap kt vt xs) = marshalMap kt vt xs +marshal (ValueStructure xs) = marshalStructure xs +marshal (ValueVariant x) = marshalVariant x + +marshalAtom :: Atom -> Marshal () +marshalAtom (AtomWord8 x) = marshalWord8 x +marshalAtom (AtomWord16 x) = marshalWord16 x +marshalAtom (AtomWord32 x) = marshalWord32 x +marshalAtom (AtomWord64 x) = marshalWord64 x +marshalAtom (AtomInt16 x) = marshalInt16 x +marshalAtom (AtomInt32 x) = marshalInt32 x +marshalAtom (AtomInt64 x) = marshalInt64 x +marshalAtom (AtomDouble x) = marshalDouble x +marshalAtom (AtomBool x) = marshalBool x +marshalAtom (AtomText x) = marshalText x +marshalAtom (AtomObjectPath x) = marshalObjectPath x +marshalAtom (AtomSignature x) = marshalSignature x + +appendB :: Word64 -> Data.Binary.Builder.Builder -> Marshal () +appendB size bytes = Wire (\_ (MarshalState builder count) -> let + builder' = Data.Binary.Builder.append builder bytes + count' = count + size + in WireRR () (MarshalState builder' count')) + +appendS :: ByteString -> Marshal () +appendS bytes = appendB + (fromIntegral (Data.ByteString.length bytes)) + (Data.Binary.Builder.fromByteString bytes) + +appendL :: Data.ByteString.Lazy.ByteString -> Marshal () +appendL bytes = appendB + (fromIntegral (Data.ByteString.Lazy.length bytes)) + (Data.Binary.Builder.fromLazyByteString bytes) + +pad :: Word8 -> Marshal () +pad count = do + (MarshalState _ existing) <- getState + let padding' = fromIntegral (padding existing count) + appendS (Data.ByteString.replicate padding' 0) + +marshalBuilder :: Word8 + -> (a -> Data.Binary.Builder.Builder) + -> (a -> Data.Binary.Builder.Builder) + -> a -> Marshal () +marshalBuilder size be le x = do + builder <- chooseEndian (be x) (le x) + pad size + appendB (fromIntegral size) builder + +type Unmarshal = Wire UnmarshalState + +newtype UnmarshalError = UnmarshalError Text + deriving (Show, Eq) + +data UnmarshalState = UnmarshalState + {-# UNPACK #-} !ByteString + {-# UNPACK #-} !Word64 + +unmarshal :: Type -> Unmarshal Value +unmarshal TypeWord8 = liftM toValue unmarshalWord8 +unmarshal TypeWord16 = liftM toValue unmarshalWord16 +unmarshal TypeWord32 = liftM toValue unmarshalWord32 +unmarshal TypeWord64 = liftM toValue unmarshalWord64 +unmarshal TypeInt16 = liftM toValue unmarshalInt16 +unmarshal TypeInt32 = liftM toValue unmarshalInt32 +unmarshal TypeInt64 = liftM toValue unmarshalInt64 +unmarshal TypeDouble = liftM toValue unmarshalDouble +unmarshal TypeBoolean = liftM toValue unmarshalBool +unmarshal TypeString = liftM toValue unmarshalText +unmarshal TypeObjectPath = liftM toValue unmarshalObjectPath +unmarshal TypeSignature = liftM toValue unmarshalSignature +unmarshal (TypeArray TypeWord8) = liftM toValue unmarshalByteArray +unmarshal (TypeArray t) = liftM (ValueVector t) (unmarshalArray t) +unmarshal (TypeDictionary kt vt) = unmarshalDictionary kt vt +unmarshal (TypeStructure ts) = unmarshalStructure ts +unmarshal TypeVariant = unmarshalVariant + +{-# INLINE consume #-} +consume :: Word64 -> Unmarshal ByteString +consume count = do + (UnmarshalState bytes offset) <- getState + let count' = fromIntegral count + let (x, bytes') = Data.ByteString.splitAt count' bytes + let lenConsumed = Data.ByteString.length x + if lenConsumed == count' + then do + putState (UnmarshalState bytes' (offset + count)) + return x + else throwError (concat + [ "Unexpected EOF at offset " + , show (offset + fromIntegral lenConsumed) + ]) + +skipPadding :: Word8 -> Unmarshal () +skipPadding count = do + (UnmarshalState _ offset) <- getState + bytes <- consume (padding offset count) + unless (Data.ByteString.all (== 0) bytes) (throwError (concat + [ "Value padding ", show bytes + , " contains invalid bytes." + ])) + +skipTerminator :: Unmarshal () +skipTerminator = do + byte <- unmarshalWord8 + when (byte /= 0) (throwError "Textual value is not NUL-terminated.") + +fromMaybeU :: Show a => String -> (a -> Maybe b) -> a -> Unmarshal b +fromMaybeU label f x = case f x of + Just x' -> return x' + Nothing -> throwError (concat ["Invalid ", label, ": ", show x]) + +unmarshalGet :: Word8 -> Data.Binary.Get.Get a -> Data.Binary.Get.Get a -> Unmarshal a +unmarshalGet count be le = do + skipPadding count + bytes <- consume (fromIntegral count) + get <- chooseEndian be le + let lazy = Data.ByteString.Lazy.fromChunks [bytes] + return (Data.Binary.Get.runGet get lazy) + +marshalWord8 :: Word8 -> Marshal () +marshalWord8 x = appendB 1 (Data.Binary.Builder.singleton x) + +unmarshalWord8 :: Unmarshal Word8 +unmarshalWord8 = liftM Data.ByteString.head (consume 1) + +marshalWord16 :: Word16 -> Marshal () +marshalWord16 = marshalBuilder 2 + Data.Binary.Builder.putWord16be + Data.Binary.Builder.putWord16le + +marshalWord32 :: Word32 -> Marshal () +marshalWord32 = marshalBuilder 4 + Data.Binary.Builder.putWord32be + Data.Binary.Builder.putWord32le + +marshalWord64 :: Word64 -> Marshal () +marshalWord64 = marshalBuilder 8 + Data.Binary.Builder.putWord64be + Data.Binary.Builder.putWord64le + +marshalInt16 :: Int16 -> Marshal () +marshalInt16 = marshalWord16 . fromIntegral + +marshalInt32 :: Int32 -> Marshal () +marshalInt32 = marshalWord32 . fromIntegral + +marshalInt64 :: Int64 -> Marshal () +marshalInt64 = marshalWord64 . fromIntegral + +unmarshalWord16 :: Unmarshal Word16 +unmarshalWord16 = unmarshalGet 2 + Data.Binary.Get.getWord16be + Data.Binary.Get.getWord16le + +unmarshalWord32 :: Unmarshal Word32 +unmarshalWord32 = unmarshalGet 4 + Data.Binary.Get.getWord32be + Data.Binary.Get.getWord32le + +unmarshalWord64 :: Unmarshal Word64 +unmarshalWord64 = unmarshalGet 8 + Data.Binary.Get.getWord64be + Data.Binary.Get.getWord64le + +unmarshalInt16 :: Unmarshal Int16 +unmarshalInt16 = liftM fromIntegral unmarshalWord16 + +unmarshalInt32 :: Unmarshal Int32 +unmarshalInt32 = liftM fromIntegral unmarshalWord32 + +unmarshalInt64 :: Unmarshal Int64 +unmarshalInt64 = liftM fromIntegral unmarshalWord64 + +marshalDouble :: Double -> Marshal () +marshalDouble x = do + put <- chooseEndian + Data.Binary.IEEE754.putFloat64be + Data.Binary.IEEE754.putFloat64le + pad 8 + appendL (runPut (put x)) + +unmarshalDouble :: Unmarshal Double +unmarshalDouble = unmarshalGet 8 + Data.Binary.IEEE754.getFloat64be + Data.Binary.IEEE754.getFloat64le + +marshalBool :: Bool -> Marshal () +marshalBool False = marshalWord32 0 +marshalBool True = marshalWord32 1 + +unmarshalBool :: Unmarshal Bool +unmarshalBool = do + word <- unmarshalWord32 + case word of + 0 -> return False + 1 -> return True + _ -> throwError (concat + [ "Invalid boolean: " + , show word + ]) + +marshalText :: Text -> Marshal () +marshalText text = do + let bytes = Data.Text.Encoding.encodeUtf8 text + when (Data.ByteString.any (== 0) bytes) (throwError (concat + [ "String " + , show text + , " contained forbidden character: '\\x00'" + ])) + marshalWord32 (fromIntegral (Data.ByteString.length bytes)) + appendS bytes + marshalWord8 0 + +unmarshalText :: Unmarshal Text +unmarshalText = do + byteCount <- unmarshalWord32 + bytes <- consume (fromIntegral byteCount) + skipTerminator + fromMaybeU "text" maybeDecodeUtf8 bytes + +maybeDecodeUtf8 :: ByteString -> Maybe Text +maybeDecodeUtf8 bs = case Data.Text.Encoding.decodeUtf8' bs of + Right text -> Just text + _ -> Nothing + +marshalObjectPath :: ObjectPath -> Marshal () +marshalObjectPath = marshalText . objectPathText + +unmarshalObjectPath :: Unmarshal ObjectPath +unmarshalObjectPath = do + text <- unmarshalText + fromMaybeU "object path" objectPath text + +signatureBytes :: Signature -> ByteString +signatureBytes (Signature ts) = Data.ByteString.Char8.pack (concatMap typeCode ts) + +marshalSignature :: Signature -> Marshal () +marshalSignature x = do + let bytes = signatureBytes x + marshalWord8 (fromIntegral (Data.ByteString.length bytes)) + appendS bytes + marshalWord8 0 + +unmarshalSignature :: Unmarshal Signature +unmarshalSignature = do + byteCount <- unmarshalWord8 + bytes <- consume (fromIntegral byteCount) + skipTerminator + fromMaybeU "signature" parseSignature bytes + +arrayMaximumLength :: Int64 +arrayMaximumLength = 67108864 + +marshalVector :: Type -> Vector Value -> Marshal () +marshalVector t x = do + (arrayPadding, arrayBytes) <- getArrayBytes t x + let arrayLen = Data.ByteString.Lazy.length arrayBytes + when (arrayLen > arrayMaximumLength) (throwError (concat + [ "Marshaled array size (" + , show arrayLen + , " bytes) exceeds maximum limit of (" + , show arrayMaximumLength + , " bytes)." + ])) + marshalWord32 (fromIntegral arrayLen) + appendL (Data.ByteString.Lazy.replicate arrayPadding 0) + appendL arrayBytes + +marshalStrictBytes :: ByteString -> Marshal () +marshalStrictBytes bytes = do + let arrayLen = Data.ByteString.length bytes + when (fromIntegral arrayLen > arrayMaximumLength) (throwError (concat + [ "Marshaled array size (" + , show arrayLen + , " bytes) exceeds maximum limit of (" + , show arrayMaximumLength + , " bytes)." + ])) + marshalWord32 (fromIntegral arrayLen) + appendS bytes + +getArrayBytes :: Type -> Vector Value -> Marshal (Int64, Data.ByteString.Lazy.ByteString) +getArrayBytes itemType vs = do + s <- getState + (MarshalState _ afterLength) <- marshalWord32 0 >> getState + (MarshalState _ afterPadding) <- pad (alignment itemType) >> getState + + putState (MarshalState Data.Binary.Builder.empty afterPadding) + (MarshalState itemBuilder _) <- Data.Vector.mapM_ marshal vs >> getState + + let itemBytes = Data.Binary.Builder.toLazyByteString itemBuilder + paddingSize = fromIntegral (afterPadding - afterLength) + + putState s + return (paddingSize, itemBytes) + +unmarshalByteArray :: Unmarshal ByteString +unmarshalByteArray = do + byteCount <- unmarshalWord32 + consume (fromIntegral byteCount) + +unmarshalArray :: Type -> Unmarshal (Vector Value) +unmarshalArray itemType = do + let getOffset = do + (UnmarshalState _ o) <- getState + return o + byteCount <- unmarshalWord32 + skipPadding (alignment itemType) + start <- getOffset + let end = start + fromIntegral byteCount + vs <- untilM (liftM (>= end) getOffset) (unmarshal itemType) + end' <- getOffset + when (end' > end) (throwError (concat + [ "Array data size exeeds array size of " + , show end + ])) + return (Data.Vector.fromList vs) + +dictionaryToArray :: Map Atom Value -> Vector Value +dictionaryToArray = Data.Vector.fromList . map step . Data.Map.toList where + step (k, v) = ValueStructure [ValueAtom k, v] + +arrayToDictionary :: Vector Value -> Map Atom Value +arrayToDictionary = Data.Map.fromList . map step . Data.Vector.toList where + step (ValueStructure [ValueAtom k, v]) = (k, v) + step _ = error "arrayToDictionary: internal error" + +marshalMap :: Type -> Type -> Map Atom Value -> Marshal () +marshalMap kt vt x = let + structType = TypeStructure [kt, vt] + array = dictionaryToArray x + in marshalVector structType array + +unmarshalDictionary :: Type -> Type -> Unmarshal Value +unmarshalDictionary kt vt = do + let pairType = TypeStructure [kt, vt] + array <- unmarshalArray pairType + return (ValueMap kt vt (arrayToDictionary array)) + +marshalStructure :: [Value] -> Marshal () +marshalStructure vs = do + pad 8 + mapM_ marshal vs + +unmarshalStructure :: [Type] -> Unmarshal Value +unmarshalStructure ts = do + skipPadding 8 + liftM ValueStructure (mapM unmarshal ts) + +marshalVariant :: Variant -> Marshal () +marshalVariant var@(Variant val) = do + sig <- case checkSignature [valueType val] of + Just x' -> return x' + Nothing -> throwError (concat + [ "Signature " + , show (typeCode (valueType val)) + , " for variant " + , show var + , " is malformed or too large." + ]) + marshalSignature sig + marshal val + +unmarshalVariant :: Unmarshal Value +unmarshalVariant = do + let getType sig = case signatureTypes sig of + [t] -> Just t + _ -> Nothing + + t <- fromMaybeU "variant signature" getType =<< unmarshalSignature + (toValue . Variant) `liftM` unmarshal t + +protocolVersion :: Word8 +protocolVersion = 1 + +messageMaximumLength :: Word64 +messageMaximumLength = 134217728 + +encodeFlags :: Set Flag -> Word8 +encodeFlags flags = foldr (.|.) 0 (map flagValue (Data.Set.toList flags)) where + flagValue NoReplyExpected = 0x1 + flagValue NoAutoStart = 0x2 + +decodeFlags :: Word8 -> Set Flag +decodeFlags word = Data.Set.fromList flags where + flagSet = [ (0x1, NoReplyExpected) + , (0x2, NoAutoStart) + ] + flags = flagSet >>= \(x, y) -> [y | word .&. x > 0] + +encodeField :: HeaderField -> Value +encodeField (HeaderPath x) = encodeField' 1 x +encodeField (HeaderInterface x) = encodeField' 2 x +encodeField (HeaderMember x) = encodeField' 3 x +encodeField (HeaderErrorName x) = encodeField' 4 x +encodeField (HeaderReplySerial x) = encodeField' 5 x +encodeField (HeaderDestination x) = encodeField' 6 x +encodeField (HeaderSender x) = encodeField' 7 x +encodeField (HeaderSignature x) = encodeField' 8 x + +encodeField' :: IsVariant a => Word8 -> a -> Value +encodeField' code x = toValue (code, toVariant x) + +decodeField :: (Word8, Variant) + -> E.ErrorM UnmarshalError [HeaderField] +decodeField struct = case struct of + (1, x) -> decodeField' x HeaderPath "path" + (2, x) -> decodeField' x HeaderInterface "interface" + (3, x) -> decodeField' x HeaderMember "member" + (4, x) -> decodeField' x HeaderErrorName "error name" + (5, x) -> decodeField' x HeaderReplySerial "reply serial" + (6, x) -> decodeField' x HeaderDestination "destination" + (7, x) -> decodeField' x HeaderSender "sender" + (8, x) -> decodeField' x HeaderSignature "signature" + _ -> return [] + +decodeField' :: IsVariant a => Variant -> (a -> b) -> Text + -> E.ErrorM UnmarshalError [b] +decodeField' x f label = case fromVariant x of + Just x' -> return [f x'] + Nothing -> E.throwErrorM (UnmarshalError (Data.Text.pack (concat + [ "Header field " + , show label + , " contains invalid value " + , show x + ]))) + + +-- | Convert a 'Message' into a 'ByteString'. Although unusual, it is +-- possible for marshaling to fail; if this occurs, an error will be +-- returned instead. + +marshalMessage :: Message a => Endianness -> Serial -> a + -> Either MarshalError Data.ByteString.ByteString +marshalMessage e serial msg = runMarshal where + body = messageBody msg + marshaler = do + sig <- checkBodySig body + empty <- getState + mapM_ (marshal . (\(Variant x) -> x)) body + (MarshalState bodyBytesB _) <- getState + putState empty + marshal (toValue (encodeEndianness e)) + let bodyBytes = Data.Binary.Builder.toLazyByteString bodyBytesB + marshalHeader msg serial sig (fromIntegral (Data.ByteString.Lazy.length bodyBytes)) + pad 8 + appendL bodyBytes + checkMaximumSize + emptyState = MarshalState Data.Binary.Builder.empty 0 + runMarshal = case unWire marshaler e emptyState of + WireRL err -> Left (MarshalError (Data.Text.pack err)) + WireRR _ (MarshalState builder _) -> Right (toStrict builder) + toStrict = Data.ByteString.concat + . Data.ByteString.Lazy.toChunks + . Data.Binary.Builder.toLazyByteString + +checkBodySig :: [Variant] -> Marshal Signature +checkBodySig vs = case checkSignature (map variantType vs) of + Just x -> return x + Nothing -> throwError (concat + [ "Message body ", show vs + , " has too many items" + ]) + +marshalHeader :: Message a => a -> Serial -> Signature -> Word32 + -> Marshal () +marshalHeader msg serial bodySig bodyLength = do + let fields = HeaderSignature bodySig : messageHeaderFields msg + marshalWord8 (messageTypeCode msg) + marshalWord8 (encodeFlags (messageFlags msg)) + marshalWord8 protocolVersion + marshalWord32 bodyLength + marshalWord32 (serialValue serial) + let fieldType = TypeStructure [TypeWord8, TypeVariant] + marshalVector fieldType (Data.Vector.fromList (map encodeField fields)) + +checkMaximumSize :: Marshal () +checkMaximumSize = do + (MarshalState _ messageLength) <- getState + when (messageLength > messageMaximumLength) (throwError (concat + [ "Marshaled message size (", show messageLength + , " bytes) exeeds maximum limit of (" + , show messageMaximumLength, " bytes)." + ])) + +unmarshalMessageM :: Monad m => (Word32 -> m ByteString) + -> m (Either UnmarshalError ReceivedMessage) +unmarshalMessageM getBytes' = E.runErrorT $ do + let getBytes = E.ErrorT . liftM Right . getBytes' + + + let fixedSig = "yyyyuuu" + fixedBytes <- getBytes 16 + + let messageVersion = Data.ByteString.index fixedBytes 3 + when (messageVersion /= protocolVersion) (E.throwErrorT (UnmarshalError (Data.Text.pack (concat + [ "Unsupported protocol version: " + , show messageVersion + ])))) + + let eByte = Data.ByteString.index fixedBytes 0 + endianness <- case decodeEndianness eByte of + Just x' -> return x' + Nothing -> E.throwErrorT (UnmarshalError (Data.Text.pack (concat + [ "Invalid endianness: " + , show eByte + ]))) + + let unmarshalSig = mapM unmarshal . signatureTypes + let unmarshal' x bytes = case unWire (unmarshalSig x) endianness (UnmarshalState bytes 0) of + WireRR x' _ -> return x' + WireRL err -> E.throwErrorT (UnmarshalError (Data.Text.pack err)) + fixed <- unmarshal' fixedSig fixedBytes + let messageType = fromJust (fromValue (fixed !! 1)) + let flags = decodeFlags (fromJust (fromValue (fixed !! 2))) + let bodyLength = fromJust (fromValue (fixed !! 4)) + let serial = fromJust (fromVariant (Variant (fixed !! 5))) + + let fieldByteCount = fromJust (fromValue (fixed !! 6)) + + + let headerSig = "yyyyuua(yv)" + fieldBytes <- getBytes fieldByteCount + let headerBytes = Data.ByteString.append fixedBytes fieldBytes + header <- unmarshal' headerSig headerBytes + + let fieldArray = Data.Vector.toList (fromJust (fromValue (header !! 6))) + fields <- case E.runErrorM $ concat `liftM` mapM decodeField fieldArray of + Left err -> E.throwErrorT err + Right x -> return x + + + let bodyPadding = padding (fromIntegral fieldByteCount + 16) 8 + void (getBytes (fromIntegral bodyPadding)) + + let bodySig = findBodySignature fields + + bodyBytes <- getBytes bodyLength + body <- unmarshal' bodySig bodyBytes + + + y <- case E.runErrorM (buildReceivedMessage messageType fields) of + Right x -> return x + Left err -> E.throwErrorT (UnmarshalError (Data.Text.pack (concat + [ "Header field " + , show err + , " is required, but missing" + ]))) + return (y serial flags (map Variant body)) + +findBodySignature :: [HeaderField] -> Signature +findBodySignature fields = fromMaybe "" (listToMaybe [x | HeaderSignature x <- fields]) + +buildReceivedMessage :: Word8 -> [HeaderField] -> E.ErrorM Text + (Serial -> (Set Flag) -> [Variant] + -> ReceivedMessage) + +buildReceivedMessage 1 fields = do + path <- require "path" [x | HeaderPath x <- fields] + member <- require "member name" [x | HeaderMember x <- fields] + return $ \serial flags body -> let + iface = listToMaybe [x | HeaderInterface x <- fields] + dest = listToMaybe [x | HeaderDestination x <- fields] + sender = listToMaybe [x | HeaderSender x <- fields] + msg = MethodCall path member iface dest flags body + in ReceivedMethodCall serial sender msg + +buildReceivedMessage 2 fields = do + replySerial <- require "reply serial" [x | HeaderReplySerial x <- fields] + return $ \serial _ body -> let + dest = listToMaybe [x | HeaderDestination x <- fields] + sender = listToMaybe [x | HeaderSender x <- fields] + msg = MethodReturn replySerial dest body + in ReceivedMethodReturn serial sender msg + +buildReceivedMessage 3 fields = do + name <- require "error name" [x | HeaderErrorName x <- fields] + replySerial <- require "reply serial" [x | HeaderReplySerial x <- fields] + return $ \serial _ body -> let + dest = listToMaybe [x | HeaderDestination x <- fields] + sender = listToMaybe [x | HeaderSender x <- fields] + msg = Error name replySerial dest body + in ReceivedError serial sender msg + +buildReceivedMessage 4 fields = do + path <- require "path" [x | HeaderPath x <- fields] + member <- require "member name" [x | HeaderMember x <- fields] + iface <- require "interface" [x | HeaderInterface x <- fields] + return $ \serial _ body -> let + dest = listToMaybe [x | HeaderDestination x <- fields] + sender = listToMaybe [x | HeaderSender x <- fields] + msg = Signal dest path iface member body + in ReceivedSignal serial sender msg + +buildReceivedMessage messageType fields = return $ \serial flags body -> let + sender = listToMaybe [x | HeaderSender x <- fields] + msg = Unknown messageType flags body + in ReceivedUnknown serial sender msg + +require :: Text -> [a] -> E.ErrorM Text a +require _ (x:_) = return x +require label _ = E.throwErrorM label + + +-- | Parse a 'ByteString' into a 'ReceivedMessage'. The result can be +-- inspected to see what type of message was parsed. Unknown message types +-- can still be parsed successfully, as long as they otherwise conform to +-- the D‐Bus standard. + +unmarshalMessage :: ByteString -> Either UnmarshalError ReceivedMessage +unmarshalMessage = Data.Binary.Get.runGet get . toLazy where + get = unmarshalMessageM getBytes + getBytes = Data.Binary.Get.getByteString . fromIntegral + toLazy bs = Data.ByteString.Lazy.fromChunks [bs] diff --git a/hs/DBus/Wire/Marshal.hs b/hs/DBus/Wire/Marshal.hs deleted file mode 100644 --- a/hs/DBus/Wire/Marshal.hs +++ /dev/null @@ -1,311 +0,0 @@ - - --- Copyright (C) 2009-2010 John Millikin --- --- 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 --- 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 . - -{-# LANGUAGE TypeFamilies #-} -module DBus.Wire.Marshal where - -import Data.Text.Lazy (Text) -import qualified Data.Text.Lazy as TL - - -import qualified Data.ByteString as BS -import qualified Data.ByteString.Lazy as L -import qualified Data.Binary.Builder as B - -import Data.Binary.Put (runPut) -import qualified Data.Binary.IEEE754 as IEEE - -import DBus.Wire.Unicode (maybeEncodeUtf8) - -import qualified DBus.Constants as C - -import qualified DBus.Message.Internal as M - -import Data.Bits ((.|.)) -import qualified Data.Set as Set - -import DBus.Wire.Internal -import Control.Monad (when) -import Data.Maybe (fromJust) -import Data.Word (Word8, Word32, Word64) -import Data.Int (Int64) - -import qualified DBus.Types as T -import qualified DBus.Types.Internal as T - -data MarshalState = MarshalState {-# UNPACK #-} !B.Builder {-# UNPACK #-} !Word64 - -data MarshalR a = MarshalRL MarshalError | MarshalRR a {-# UNPACK #-} !MarshalState - -type Marshal = MarshalM () -newtype MarshalM a = MarshalM { unMarshalM :: Endianness -> MarshalState -> MarshalR a } - -instance Monad MarshalM where - {-# INLINE return #-} - return a = MarshalM $ \_ s -> MarshalRR a s - - {-# INLINE (>>=) #-} - m >>= k = MarshalM $ \e s -> case unMarshalM m e s of - MarshalRL err -> MarshalRL err - MarshalRR a s' -> unMarshalM (k a) e s' - - {-# INLINE (>>) #-} - m >> k = MarshalM $ \e s -> case unMarshalM m e s of - MarshalRL err -> MarshalRL err - MarshalRR _ s' -> unMarshalM k e s' - -throwError :: MarshalError -> MarshalM a -throwError err = MarshalM $ \_ _ -> MarshalRL err - -{-# INLINE getState #-} -getState :: MarshalM MarshalState -getState = MarshalM $ \_ s -> MarshalRR s s - -{-# INLINE putState #-} -putState :: MarshalState -> MarshalM () -putState s = MarshalM $ \_ _ -> MarshalRR () s - -runMarshal :: Marshal -> Endianness -> Either MarshalError L.ByteString -runMarshal m e = case unMarshalM m e (MarshalState B.empty 0) of - MarshalRL err -> Left err - MarshalRR _ (MarshalState builder _) -> Right $ B.toLazyByteString builder - -marshal :: T.Variant -> Marshal -marshal v = case v of - - T.VarBoxWord8 x -> marshalWord8 x - T.VarBoxWord16 x -> marshalBuilder 2 B.putWord16be B.putWord16le x - T.VarBoxWord32 x -> marshalWord32 x - T.VarBoxWord64 x -> marshalBuilder 8 B.putWord64be B.putWord64le x - T.VarBoxInt16 x -> marshalBuilder 2 B.putWord16be B.putWord16le $ fromIntegral x - T.VarBoxInt32 x -> marshalBuilder 4 B.putWord32be B.putWord32le $ fromIntegral x - T.VarBoxInt64 x -> marshalBuilder 8 B.putWord64be B.putWord64le $ fromIntegral x - - T.VarBoxDouble x -> marshalDouble x - - T.VarBoxBool x -> marshalWord32 $ if x then 1 else 0 - - T.VarBoxString x -> marshalText x - T.VarBoxObjectPath x -> marshalText . T.strObjectPath $ x - - T.VarBoxSignature x -> marshalSignature x - - T.VarBoxArray x -> marshalArray x - - T.VarBoxDictionary x -> marshalArray (T.dictionaryToArray x) - - T.VarBoxStructure (T.Structure vs) -> do - pad 8 - mapM_ marshal vs - - T.VarBoxVariant x -> do - let textSig = T.typeCode . T.variantType $ x - sig <- case T.variantSignature x of - Just x' -> return x' - Nothing -> throwError $ InvalidVariantSignature textSig - marshalSignature sig - marshal x - -appendS :: BS.ByteString -> Marshal -appendS bytes = MarshalM $ \_ (MarshalState builder count) -> let - builder' = B.append builder $ B.fromByteString bytes - count' = count + fromIntegral (BS.length bytes) - in MarshalRR () (MarshalState builder' count') - -appendL :: L.ByteString -> Marshal -appendL bytes = MarshalM $ \_ (MarshalState builder count) -> let - builder' = B.append builder $ B.fromLazyByteString bytes - count' = count + fromIntegral (L.length bytes) - in MarshalRR () (MarshalState builder' count') - -pad :: Word8 -> Marshal -pad count = MarshalM $ \e s@(MarshalState _ existing) -> let - padding' = fromIntegral $ padding existing count - bytes = BS.replicate padding' 0 - in unMarshalM (appendS bytes) e s - -marshalBuilder :: Word8 -> (a -> B.Builder) -> (a -> B.Builder) -> a -> Marshal -marshalBuilder size be le x = do - pad size - MarshalM $ \e (MarshalState builder count) -> let - builder' = B.append builder $ case e of - BigEndian -> be x - LittleEndian -> le x - size' = fromIntegral size - in MarshalRR () (MarshalState builder' (count + size')) - -data MarshalError - = MessageTooLong Word64 - | ArrayTooLong Word64 - | InvalidBodySignature Text - | InvalidVariantSignature Text - | InvalidText Text - deriving (Eq) - -instance Show MarshalError where - show (MessageTooLong x) = concat - ["Message too long (", show x, " bytes)."] - show (ArrayTooLong x) = concat - ["Array too long (", show x, " bytes)."] - show (InvalidBodySignature x) = concat - ["Invalid body signature: ", show x] - show (InvalidVariantSignature x) = concat - ["Invalid variant signature: ", show x] - show (InvalidText x) = concat - ["Text cannot be marshaled: ", show x] - -marshalWord32 :: Word32 -> Marshal -marshalWord32 = marshalBuilder 4 B.putWord32be B.putWord32le - -{-# INLINE marshalWord8 #-} -marshalWord8 :: Word8 -> Marshal -marshalWord8 x = MarshalM $ \_ (MarshalState builder count) -> let - builder' = B.append builder $ B.singleton x - in MarshalRR () (MarshalState builder' (count + 1)) - -marshalDouble :: Double -> Marshal -marshalDouble x = do - pad 8 - MarshalM $ \e s -> let - put = case e of - BigEndian -> IEEE.putFloat64be - LittleEndian -> IEEE.putFloat64le - bytes = runPut $ put x - in unMarshalM (appendL bytes) e s - -marshalText :: Text -> Marshal -marshalText x = do - bytes <- case maybeEncodeUtf8 x of - Just x' -> return x' - Nothing -> throwError $ InvalidText x - when (L.any (== 0) bytes) $ - throwError $ InvalidText x - marshalWord32 . fromIntegral . L.length $ bytes - appendL bytes - marshalWord8 0 - -marshalSignature :: T.Signature -> Marshal -marshalSignature x = do - let bytes = T.bytesSignature x - let size = fromIntegral . BS.length $ bytes - marshalWord8 size - appendS bytes - marshalWord8 0 - -marshalArray :: T.Array -> Marshal -marshalArray x = do - (arrayPadding, arrayBytes) <- getArrayBytes (T.arrayType x) x - let arrayLen = L.length arrayBytes - when (arrayLen > fromIntegral C.arrayMaximumLength) - (throwError $ ArrayTooLong $ fromIntegral arrayLen) - marshalWord32 $ fromIntegral arrayLen - appendL $ L.replicate arrayPadding 0 - appendL arrayBytes - -getArrayBytes :: T.Type -> T.Array -> MarshalM (Int64, L.ByteString) -getArrayBytes T.DBusByte x = return (0, bytes) where - Just bytes = T.arrayToBytes x - -getArrayBytes itemType x = do - let vs = T.arrayItems x - s <- getState - (MarshalState _ afterLength) <- marshalWord32 0 >> getState - (MarshalState _ afterPadding) <- pad (alignment itemType) >> getState - - putState $ MarshalState B.empty afterPadding - (MarshalState itemBuilder _) <- mapM_ marshal vs >> getState - - let itemBytes = B.toLazyByteString itemBuilder - paddingSize = fromIntegral $ afterPadding - afterLength - - putState s - return (paddingSize, itemBytes) - -encodeFlags :: Set.Set M.Flag -> Word8 -encodeFlags flags = foldr (.|.) 0 $ map flagValue $ Set.toList flags where - flagValue M.NoReplyExpected = 0x1 - flagValue M.NoAutoStart = 0x2 - -encodeField :: M.HeaderField -> T.Structure -encodeField (M.Path x) = encodeField' 1 x -encodeField (M.Interface x) = encodeField' 2 x -encodeField (M.Member x) = encodeField' 3 x -encodeField (M.ErrorName x) = encodeField' 4 x -encodeField (M.ReplySerial x) = encodeField' 5 x -encodeField (M.Destination x) = encodeField' 6 x -encodeField (M.Sender x) = encodeField' 7 x -encodeField (M.Signature x) = encodeField' 8 x - -encodeField' :: T.Variable a => Word8 -> a -> T.Structure -encodeField' code x = T.Structure - [ T.toVariant code - , T.toVariant $ T.toVariant x - ] - - --- | Convert a 'M.Message' into a 'L.ByteString'. Although unusual, it is --- possible for marshaling to fail -- if this occurs, an appropriate error --- will be returned instead. - -marshalMessage :: M.Message a => Endianness -> M.Serial -> a - -> Either MarshalError L.ByteString -marshalMessage e serial msg = runMarshal marshaler e where - body = M.messageBody msg - marshaler = do - sig <- checkBodySig body - empty <- getState - mapM_ marshal body - (MarshalState bodyBytesB _) <- getState - putState empty - marshalEndianness e - let bodyBytes = B.toLazyByteString bodyBytesB - marshalHeader msg serial sig - $ fromIntegral . L.length $ bodyBytes - pad 8 - appendL bodyBytes - checkMaximumSize - -checkBodySig :: [T.Variant] -> MarshalM T.Signature -checkBodySig vs = let - textSig = TL.concat . map (T.typeCode . T.variantType) $ vs - bytesSig = BS.concat . map (T.typeCodeB . T.variantType) $ vs - invalid = throwError $ InvalidBodySignature textSig - in case T.mkBytesSignature bytesSig of - Just x -> return x - Nothing -> invalid - -marshalHeader :: M.Message a => a -> M.Serial -> T.Signature -> Word32 - -> Marshal -marshalHeader msg serial bodySig bodyLength = do - let fields = M.Signature bodySig : M.messageHeaderFields msg - marshalWord8 . M.messageTypeCode $ msg - marshalWord8 . encodeFlags . M.messageFlags $ msg - marshalWord8 C.protocolVersion - marshalWord32 bodyLength - marshalWord32 . M.serialValue $ serial - let fieldType = T.DBusStructure [T.DBusByte, T.DBusVariant] - marshalArray . fromJust . T.toArray fieldType - $ map encodeField fields - -marshalEndianness :: Endianness -> Marshal -marshalEndianness = marshal . T.toVariant . encodeEndianness - -checkMaximumSize :: Marshal -checkMaximumSize = do - (MarshalState _ messageLength) <- getState - when (messageLength > fromIntegral C.messageMaximumLength) - (throwError $ MessageTooLong $ fromIntegral messageLength) diff --git a/hs/DBus/Wire/Unicode.hs b/hs/DBus/Wire/Unicode.hs deleted file mode 100644 --- a/hs/DBus/Wire/Unicode.hs +++ /dev/null @@ -1,38 +0,0 @@ - - --- Copyright (C) 2009-2010 John Millikin --- --- 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 --- 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 . - -module DBus.Wire.Unicode - ( maybeEncodeUtf8 - , maybeDecodeUtf8) where -import Data.ByteString.Lazy (ByteString) -import Data.Text.Lazy (Text) -import Data.Text.Lazy.Encoding (encodeUtf8, decodeUtf8) -import Data.Text.Encoding.Error (UnicodeException) -import qualified Control.Exception as Exc -import System.IO.Unsafe (unsafePerformIO) - -excToMaybe :: a -> Maybe a -excToMaybe x = unsafePerformIO $ fmap Just (Exc.evaluate x) `Exc.catch` unicodeError - -unicodeError :: UnicodeException -> IO (Maybe a) -unicodeError = const $ return Nothing - -maybeEncodeUtf8 :: Text -> Maybe ByteString -maybeEncodeUtf8 = excToMaybe . encodeUtf8 - -maybeDecodeUtf8 :: ByteString -> Maybe Text -maybeDecodeUtf8 = excToMaybe . decodeUtf8 diff --git a/hs/DBus/Wire/Unmarshal.hs b/hs/DBus/Wire/Unmarshal.hs deleted file mode 100644 --- a/hs/DBus/Wire/Unmarshal.hs +++ /dev/null @@ -1,414 +0,0 @@ - - --- Copyright (C) 2009-2010 John Millikin --- --- 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 --- 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 . - - -{-# LANGUAGE OverloadedStrings #-} - -{-# LANGUAGE TypeFamilies #-} -module DBus.Wire.Unmarshal where - -import Data.Text.Lazy (Text) -import qualified Data.Text.Lazy as TL - - -import Control.Monad (liftM) -import qualified DBus.Util.MonadError as E -import qualified Data.ByteString as B -import qualified Data.ByteString.Lazy as BL - -import qualified Data.Binary.Get as G - -import qualified Data.Binary.IEEE754 as IEEE - -import DBus.Wire.Unicode (maybeDecodeUtf8) - -import qualified DBus.Message.Internal as M - -import Data.Bits ((.&.)) -import qualified Data.Set as Set - -import qualified DBus.Constants as C - -import Control.Monad (when, unless) -import Data.Maybe (fromJust, listToMaybe, fromMaybe) -import Data.Word (Word8, Word32, Word64) -import Data.Int (Int16, Int32, Int64) - -import DBus.Wire.Internal -import qualified DBus.Types.Internal as T -import DBus.Util (void) - -data UnmarshalState = UnmarshalState BL.ByteString {-# UNPACK #-} !Word64 - -data UnmarshalR a = UnmarshalRL UnmarshalError | UnmarshalRR a {-# UNPACK #-} !UnmarshalState - -newtype Unmarshal a = Unmarshal { unUnmarshal :: Endianness -> UnmarshalState -> UnmarshalR a } - -instance Monad Unmarshal where - {-# INLINE return #-} - return a = Unmarshal $ \_ s -> UnmarshalRR a s - - {-# INLINE (>>=) #-} - m >>= k = Unmarshal $ \e s -> case unUnmarshal m e s of - UnmarshalRL err -> UnmarshalRL err - UnmarshalRR a s' -> unUnmarshal (k a) e s' - - {-# INLINE (>>) #-} - m >> k = Unmarshal $ \e s -> case unUnmarshal m e s of - UnmarshalRL err -> UnmarshalRL err - UnmarshalRR _ s' -> unUnmarshal k e s' - -throwError :: UnmarshalError -> Unmarshal a -throwError err = Unmarshal $ \_ _ -> UnmarshalRL err - -{-# INLINE getState #-} -getState :: Unmarshal UnmarshalState -getState = Unmarshal $ \_ s -> UnmarshalRR s s - -{-# INLINE putState #-} -putState :: UnmarshalState -> Unmarshal () -putState s = Unmarshal $ \_ _ -> UnmarshalRR () s - -runUnmarshal :: Unmarshal a -> Endianness -> BL.ByteString -> Either UnmarshalError a -runUnmarshal m e bytes = case unUnmarshal m e (UnmarshalState bytes 0) of - UnmarshalRL err -> Left err - UnmarshalRR a _ -> Right a - -unmarshal :: T.Signature -> Unmarshal [T.Variant] -unmarshal = mapM unmarshalType . T.signatureTypes - -unmarshalType :: T.Type -> Unmarshal T.Variant - -unmarshalType T.DBusByte = liftM (T.toVariant . BL.head) $ consume 1 -unmarshalType T.DBusWord16 = unmarshalGet' 2 G.getWord16be G.getWord16le -unmarshalType T.DBusWord32 = unmarshalGet' 4 G.getWord32be G.getWord32le -unmarshalType T.DBusWord64 = unmarshalGet' 8 G.getWord64be G.getWord64le - -unmarshalType T.DBusInt16 = do - x <- unmarshalGet 2 G.getWord16be G.getWord16le - return . T.toVariant $ (fromIntegral x :: Int16) - -unmarshalType T.DBusInt32 = do - x <- unmarshalGet 4 G.getWord32be G.getWord32le - return . T.toVariant $ (fromIntegral x :: Int32) - -unmarshalType T.DBusInt64 = do - x <- unmarshalGet 8 G.getWord64be G.getWord64le - return . T.toVariant $ (fromIntegral x :: Int64) - -unmarshalType T.DBusDouble = unmarshalGet' 8 IEEE.getFloat64be IEEE.getFloat64le - -unmarshalType T.DBusBoolean = unmarshalWord32 >>= - fromMaybeU' "boolean" (\x -> case x of - 0 -> Just False - 1 -> Just True - _ -> Nothing) - -unmarshalType T.DBusString = liftM T.toVariant unmarshalText - -unmarshalType T.DBusObjectPath = unmarshalText >>= - fromMaybeU' "object path" T.mkObjectPath - -unmarshalType T.DBusSignature = liftM T.toVariant unmarshalSignature - -unmarshalType (T.DBusArray t) = T.toVariant `liftM` unmarshalArray t - -unmarshalType (T.DBusDictionary kt vt) = do - let pairType = T.DBusStructure [kt, vt] - array <- unmarshalArray pairType - fromMaybeU' "dictionary" T.arrayToDictionary array - -unmarshalType (T.DBusStructure ts) = do - skipPadding 8 - liftM (T.toVariant . T.Structure) $ mapM unmarshalType ts - -unmarshalType T.DBusVariant = do - let getType sig = case T.signatureTypes sig of - [t] -> Just t - _ -> Nothing - - t <- fromMaybeU "variant signature" getType =<< unmarshalSignature - T.toVariant `liftM` unmarshalType t - -{-# INLINE consume #-} -consume :: Word64 -> Unmarshal BL.ByteString -consume count = Unmarshal $ \_ (UnmarshalState bytes offset) -> let - count' = fromIntegral count - (x, bytes') = BL.splitAt count' bytes - in if BL.length x == count' - then UnmarshalRR x (UnmarshalState bytes' (offset + count)) - else UnmarshalRL $ UnexpectedEOF offset - -skipPadding :: Word8 -> Unmarshal () -skipPadding count = do - (UnmarshalState _ offset) <- getState - bytes <- consume $ padding offset count - unless (BL.all (== 0) bytes) $ - throwError $ InvalidPadding offset - -skipTerminator :: Unmarshal () -skipTerminator = do - (UnmarshalState _ offset) <- getState - bytes <- consume 1 - unless (BL.all (== 0) bytes) $ - throwError $ MissingTerminator offset - -fromMaybeU :: Show a => Text -> (a -> Maybe b) -> a -> Unmarshal b -fromMaybeU label f x = case f x of - Just x' -> return x' - Nothing -> throwError . Invalid label . TL.pack . show $ x - -fromMaybeU' :: (Show a, T.Variable b) => Text -> (a -> Maybe b) -> a - -> Unmarshal T.Variant -fromMaybeU' label f x = do - x' <- fromMaybeU label f x - return $ T.toVariant x' - -unmarshalGet :: Word8 -> G.Get a -> G.Get a -> Unmarshal a -unmarshalGet count be le = do - skipPadding count - bs <- consume . fromIntegral $ count - - Unmarshal $ \e s -> let - get = case e of - BigEndian -> be - LittleEndian -> le - in UnmarshalRR (G.runGet get bs) s - -unmarshalGet' :: T.Variable a => Word8 -> G.Get a -> G.Get a - -> Unmarshal T.Variant -unmarshalGet' count be le = T.toVariant `liftM` unmarshalGet count be le - -untilM :: Monad m => m Bool -> m a -> m [a] -untilM test comp = do - done <- test - if done - then return [] - else do - x <- comp - xs <- untilM test comp - return $ x:xs - -data UnmarshalError - = UnsupportedProtocolVersion Word8 - | UnexpectedEOF Word64 - | Invalid Text Text - | MissingHeaderField Text - | InvalidHeaderField Text T.Variant - | InvalidPadding Word64 - | MissingTerminator Word64 - | ArraySizeMismatch - deriving (Eq) - -instance Show UnmarshalError where - show (UnsupportedProtocolVersion x) = concat - ["Unsupported protocol version: ", show x] - show (UnexpectedEOF pos) = concat - ["Unexpected EOF at position ", show pos] - show (Invalid label x) = TL.unpack $ TL.concat - ["Invalid ", label, ": ", x] - show (MissingHeaderField x) = concat - ["Required field " , show x , " is missing."] - show (InvalidHeaderField x got) = concat - [ "Invalid header field ", show x, ": ", show got] - show (InvalidPadding pos) = concat - ["Invalid padding at position ", show pos] - show (MissingTerminator pos) = concat - ["Missing NUL terminator at position ", show pos] - show ArraySizeMismatch = "Array size mismatch" - -unmarshalWord32 :: Unmarshal Word32 -unmarshalWord32 = unmarshalGet 4 G.getWord32be G.getWord32le - -unmarshalText :: Unmarshal Text -unmarshalText = do - byteCount <- unmarshalWord32 - bytes <- consume . fromIntegral $ byteCount - skipTerminator - fromMaybeU "text" maybeDecodeUtf8 bytes - -unmarshalSignature :: Unmarshal T.Signature -unmarshalSignature = do - byteCount <- BL.head `liftM` consume 1 - lazy <- consume $ fromIntegral byteCount - skipTerminator - let bytes = B.concat $ BL.toChunks lazy - fromMaybeU "signature" T.mkBytesSignature bytes - -unmarshalArray :: T.Type -> Unmarshal T.Array -unmarshalArray T.DBusByte = do - byteCount <- unmarshalWord32 - T.arrayFromBytes `liftM` consume (fromIntegral byteCount) - -unmarshalArray itemType = do - let getOffset = do - (UnmarshalState _ o) <- getState - return o - byteCount <- unmarshalWord32 - skipPadding (alignment itemType) - start <- getOffset - let end = start + fromIntegral byteCount - vs <- untilM (liftM (>= end) getOffset) (unmarshalType itemType) - end' <- getOffset - when (end' > end) $ - throwError ArraySizeMismatch - fromMaybeU "array" (T.arrayFromItems itemType) vs - -decodeFlags :: Word8 -> Set.Set M.Flag -decodeFlags word = Set.fromList flags where - flagSet = [ (0x1, M.NoReplyExpected) - , (0x2, M.NoAutoStart) - ] - flags = flagSet >>= \(x, y) -> [y | word .&. x > 0] - -decodeField :: T.Structure - -> E.ErrorM UnmarshalError [M.HeaderField] -decodeField struct = case unpackField struct of - (1, x) -> decodeField' x M.Path "path" - (2, x) -> decodeField' x M.Interface "interface" - (3, x) -> decodeField' x M.Member "member" - (4, x) -> decodeField' x M.ErrorName "error name" - (5, x) -> decodeField' x M.ReplySerial "reply serial" - (6, x) -> decodeField' x M.Destination "destination" - (7, x) -> decodeField' x M.Sender "sender" - (8, x) -> decodeField' x M.Signature "signature" - _ -> return [] - -decodeField' :: T.Variable a => T.Variant -> (a -> b) -> Text - -> E.ErrorM UnmarshalError [b] -decodeField' x f label = case T.fromVariant x of - Just x' -> return [f x'] - Nothing -> E.throwErrorM $ InvalidHeaderField label x - -unpackField :: T.Structure -> (Word8, T.Variant) -unpackField struct = (c', v') where - T.Structure [c, v] = struct - c' = fromJust . T.fromVariant $ c - v' = fromJust . T.fromVariant $ v - - --- | Read bytes from a monad until a complete message has been received. - -unmarshalMessage :: Monad m => (Word32 -> m BL.ByteString) - -> m (Either UnmarshalError M.ReceivedMessage) -unmarshalMessage getBytes' = E.runErrorT $ do - let getBytes = E.ErrorT . liftM Right . getBytes' - - - let fixedSig = "yyyyuuu" - fixedBytes <- getBytes 16 - - let messageVersion = BL.index fixedBytes 3 - when (messageVersion /= C.protocolVersion) $ - E.throwErrorT $ UnsupportedProtocolVersion messageVersion - - let eByte = BL.index fixedBytes 0 - endianness <- case decodeEndianness eByte of - Just x' -> return x' - Nothing -> E.throwErrorT . Invalid "endianness" . TL.pack . show $ eByte - - let unmarshal' x bytes = case runUnmarshal (unmarshal x) endianness bytes of - Right x' -> return x' - Left e -> E.throwErrorT e - fixed <- unmarshal' fixedSig fixedBytes - let typeCode = fromJust . T.fromVariant $ fixed !! 1 - let flags = decodeFlags . fromJust . T.fromVariant $ fixed !! 2 - let bodyLength = fromJust . T.fromVariant $ fixed !! 4 - let serial = fromJust . T.fromVariant $ fixed !! 5 - - let fieldByteCount = fromJust . T.fromVariant $ fixed !! 6 - - - let headerSig = "yyyyuua(yv)" - fieldBytes <- getBytes fieldByteCount - let headerBytes = BL.append fixedBytes fieldBytes - header <- unmarshal' headerSig headerBytes - - let fieldArray = fromJust . T.fromVariant $ header !! 6 - let fieldStructures = fromJust . T.fromArray $ fieldArray - fields <- case E.runErrorM $ concat `liftM` mapM decodeField fieldStructures of - Left err -> E.throwErrorT err - Right x -> return x - - - let bodyPadding = padding (fromIntegral fieldByteCount + 16) 8 - void (getBytes (fromIntegral bodyPadding)) - - let bodySig = findBodySignature fields - - bodyBytes <- getBytes bodyLength - body <- unmarshal' bodySig bodyBytes - - - y <- case E.runErrorM $ buildReceivedMessage typeCode fields of - Right x -> return x - Left err -> E.throwErrorT $ MissingHeaderField err - return $ y serial flags body - -findBodySignature :: [M.HeaderField] -> T.Signature -findBodySignature fields = fromMaybe "" signature where - signature = listToMaybe [x | M.Signature x <- fields] - -buildReceivedMessage :: Word8 -> [M.HeaderField] -> E.ErrorM Text - (M.Serial -> (Set.Set M.Flag) -> [T.Variant] - -> M.ReceivedMessage) - -buildReceivedMessage 1 fields = do - path <- require "path" [x | M.Path x <- fields] - member <- require "member name" [x | M.Member x <- fields] - return $ \serial flags body -> let - iface = listToMaybe [x | M.Interface x <- fields] - dest = listToMaybe [x | M.Destination x <- fields] - sender = listToMaybe [x | M.Sender x <- fields] - msg = M.MethodCall path member iface dest flags body - in M.ReceivedMethodCall serial sender msg - -buildReceivedMessage 2 fields = do - replySerial <- require "reply serial" [x | M.ReplySerial x <- fields] - return $ \serial _ body -> let - dest = listToMaybe [x | M.Destination x <- fields] - sender = listToMaybe [x | M.Sender x <- fields] - msg = M.MethodReturn replySerial dest body - in M.ReceivedMethodReturn serial sender msg - -buildReceivedMessage 3 fields = do - name <- require "error name" [x | M.ErrorName x <- fields] - replySerial <- require "reply serial" [x | M.ReplySerial x <- fields] - return $ \serial _ body -> let - dest = listToMaybe [x | M.Destination x <- fields] - sender = listToMaybe [x | M.Sender x <- fields] - msg = M.Error name replySerial dest body - in M.ReceivedError serial sender msg - -buildReceivedMessage 4 fields = do - path <- require "path" [x | M.Path x <- fields] - member <- require "member name" [x | M.Member x <- fields] - iface <- require "interface" [x | M.Interface x <- fields] - return $ \serial _ body -> let - dest = listToMaybe [x | M.Destination x <- fields] - sender = listToMaybe [x | M.Sender x <- fields] - msg = M.Signal path member iface dest body - in M.ReceivedSignal serial sender msg - -buildReceivedMessage typeCode fields = return $ \serial flags body -> let - sender = listToMaybe [x | M.Sender x <- fields] - msg = M.Unknown typeCode flags body - in M.ReceivedUnknown serial sender msg - -require :: Text -> [a] -> E.ErrorM Text a -require _ (x:_) = return x -require label _ = E.throwErrorM label diff --git a/hs/Tests.hs b/hs/Tests.hs deleted file mode 100644 --- a/hs/Tests.hs +++ /dev/null @@ -1,520 +0,0 @@ - - --- Copyright (C) 2009-2010 John Millikin --- --- 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 --- 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 . - - -{-# LANGUAGE OverloadedStrings #-} - -module Main (tests, main) where - -import Test.QuickCheck -import qualified Test.Framework as F -import Test.Framework.Providers.QuickCheck2 (testProperty) - -import Control.Arrow ((&&&)) -import Control.Monad (replicateM) -import qualified Data.Binary.Get as G -import Data.Char (isPrint) -import Data.String -import Data.List (intercalate, isInfixOf) -import Data.Maybe (fromJust, isJust, isNothing) -import qualified Data.Map as Map -import qualified Data.Set as Set -import qualified Data.Text as T -import qualified Data.Text.Lazy as TL -import Data.Word (Word8, Word16, Word32, Word64) -import Data.Int (Int16, Int32, Int64) - -import DBus.Address -import DBus.Message.Internal -import DBus.Types -import DBus.Wire.Internal -import DBus.Wire.Marshal -import DBus.Wire.Unmarshal -import qualified DBus.Introspection as I - - -tests :: [F.Test] -tests = [ F.testGroup "dummy" [] - - , F.testGroup "String" - [ testProperty "String -> strict Text" - $ funEq (fromVariant . toVariant) (Just . T.pack) - , testProperty "String <- strict Text" - $ funEq (fromVariant . toVariant) (Just . T.unpack) - , testProperty "String -> lazy Text" - $ funEq (fromVariant . toVariant) (Just . TL.pack) - , testProperty "String <- lazy Text" - $ funEq (fromVariant . toVariant) (Just . TL.unpack) - , testProperty "Strict Text -> lazy Text" - $ funEq (fromVariant . toVariant) (Just . TL.pack . T.unpack) - , testProperty "Strict Text <- lazy Text" - $ funEq (fromVariant . toVariant) (Just . T.pack . TL.unpack) - ] - - , F.testGroup "Signature" - [ testProperty "Signature identity" - $ funEq (mkSignature . strSignature) Just - ] - - , F.testGroup "ObjectPath" - [ testProperty "ObjectPath identity" - $ funEq (mkObjectPath . strObjectPath) Just - ] - - , F.testGroup "Array" - [ testProperty "Array identity" - $ \x -> Just x == arrayFromItems (arrayType x) (arrayItems x) - , testProperty "Array homogeneity" prop_ArrayHomogeneous - ] - - , F.testGroup "Dictionary" - [ testProperty "Dictionary identity" - $ \x -> Just x == dictionaryFromItems - (dictionaryKeyType x) - (dictionaryValueType x) - (dictionaryItems x) - , testProperty "Dictionary homogeneity" prop_DictionaryHomogeneous - , testProperty "Dictionary must have atomic keys" - $ \vt -> forAll containerType $ \kt -> - isNothing (dictionaryFromItems kt vt []) - , testProperty "Dictionary <-> Array conversion" - $ funEq (arrayToDictionary . dictionaryToArray) Just - ] - - , F.testGroup "BusName" - [ testProperty "BusName identity" - $ funEq (mkBusName . strBusName) Just - ] - - , F.testGroup "InterfaceName" - [ testProperty "InterfaceName identity" - $ funEq (mkInterfaceName . strInterfaceName) Just - ] - - , F.testGroup "ErrorName" - [ testProperty "ErrorName identity" - $ funEq (mkErrorName . strErrorName) Just - ] - - , F.testGroup "MemberName" - [ testProperty "MemberName identity" - $ funEq (mkMemberName . strMemberName) Just - ] - - , F.testGroup "Wire format" - [ testProperty "Marshal -> Ummarshal" prop_Unmarshal - , F.testGroup "Messages" - [ testProperty "Method calls" prop_WireMethodCall - , testProperty "Method returns" prop_WireMethodReturn - , testProperty "Errors" prop_WireError - , testProperty "Signals" prop_WireSignal - ] - ] - - , F.testGroup "Addresses" - [ testProperty "Address identity" - $ \x -> mkAddresses (strAddress x) == Just [x] - , testProperty "Multiple addresses" - $ \x y -> let - joined = TL.concat [strAddress x, ";", strAddress y] - in mkAddresses joined == Just [x, y] - , testProperty "Ignore trailing semicolon" - $ \x -> mkAddresses (TL.append (strAddress x) ";") == Just [x] - , testProperty "Ignore trailing comma" - $ \x -> let - hasParams = not . Map.null . addressParameters $ x - parsed = mkAddresses (TL.append (strAddress x) ",") - in hasParams ==> parsed == Just [x] - , F.testGroup "Valid addresses" - [ test "colon" $ isJust . mkAddresses $ ":" - , test "just scheme" $ isJust . mkAddresses $ "a:" - , test "param" $ isJust . mkAddresses $ "a:b=c" - , test "trailing semicolon" $ isJust . mkAddresses $ "a:;" - , test "two schemes" $ isJust . mkAddresses $ "a:;b:" - , test "trailing comma" $ isJust . mkAddresses $ "a:b=c," - ] - , F.testGroup "Invalid addresses" - [ test "empty" $ isNothing . mkAddresses $ "" - , test "no colon" $ isNothing . mkAddresses $ "a" - , test "no equals" $ isNothing . mkAddresses $ "a:b" - , test "no param" $ isNothing . mkAddresses $ "a:b=" - , test "no param" $ isNothing . mkAddresses $ "a:," - ] - ] - - , F.testGroup "Introspection" - [ testProperty "Generate -> Parse" - $ \x@(I.Object path _ _) -> let - xml = I.toXML x - Just xml' = xml - parsed = I.fromXML path xml' - in isJust xml ==> I.fromXML path xml' == Just x - ] - - ] - -main :: IO () -main = F.defaultMain tests - -instance Arbitrary Type where - arbitrary = oneof [atomicType, containerType] - -atomicType :: Gen Type -atomicType = elements - [ DBusBoolean - , DBusByte - , DBusWord16 - , DBusWord32 - , DBusWord64 - , DBusInt16 - , DBusInt32 - , DBusInt64 - , DBusDouble - , DBusString - , DBusObjectPath - , DBusSignature - ] - -containerType :: Gen Type -containerType = do - c <- choose (0,3) :: Gen Int - case c of - 0 -> fmap DBusArray arbitrary - 1 -> do - kt <- atomicType - vt <- arbitrary - return $ DBusDictionary kt vt - 2 -> fmap DBusStructure $ halfSized arbitrary - 3 -> return DBusVariant - -instance Arbitrary Variant where - arbitrary = arbitrary >>= genVariant - -genVariant :: Type -> Gen Variant -genVariant t = case t of - DBusBoolean -> fmap toVariant (arbitrary :: Gen Bool) - DBusByte -> fmap toVariant (arbitrary :: Gen Word8) - DBusWord16 -> fmap toVariant (arbitrary :: Gen Word16) - DBusWord32 -> fmap toVariant (arbitrary :: Gen Word32) - DBusWord64 -> fmap toVariant (arbitrary :: Gen Word64) - DBusInt16 -> fmap toVariant (arbitrary :: Gen Int16) - DBusInt32 -> fmap toVariant (arbitrary :: Gen Int32) - DBusInt64 -> fmap toVariant (arbitrary :: Gen Int64) - DBusDouble -> fmap toVariant (arbitrary :: Gen Double) - DBusString -> fmap toVariant (arbitrary :: Gen String) - DBusObjectPath -> fmap toVariant (arbitrary :: Gen ObjectPath) - DBusSignature -> fmap toVariant (arbitrary :: Gen Signature) - (DBusArray _) -> fmap toVariant (arbitrary :: Gen Array) - (DBusDictionary _ _) -> fmap toVariant (arbitrary :: Gen Dictionary) - (DBusStructure _) -> fmap toVariant (arbitrary :: Gen Structure) - DBusVariant -> fmap toVariant (arbitrary :: Gen Variant) - -instance Arbitrary Signature where - arbitrary = sizedText 255 $ fmap (TL.concat . map typeCode) arbitrary - -instance Arbitrary ObjectPath where - arbitrary = fmap (mkObjectPath_ . TL.pack) path' where - c = ['a'..'z'] ++ ['A'..'Z'] ++ ['0'..'9'] ++ "_" - path = fmap (intercalate "/" . ([] :)) genElements - path' = frequency [(1, return "/"), (9, path)] - genElements = atLeast 1 (atLeast 1 (elements c)) - -instance Arbitrary Array where - arbitrary = do - t <- atomicType - xs <- listOf $ genVariant t - return . fromJust $ arrayFromItems t xs - -prop_ArrayHomogeneous vs = isJust array == homogeneousTypes where - array = arrayFromItems firstType vs - homogeneousTypes = all (== firstType) types - types = map variantType vs - firstType = if null types - then DBusByte - else head types - -instance Arbitrary Dictionary where - arbitrary = do - kt <- atomicType - vt <- atomicType - ks <- listOf $ genVariant kt - vs <- vectorOf (length ks) $ genVariant vt - - return . fromJust $ dictionaryFromItems kt vt $ zip ks vs - -prop_DictionaryHomogeneous x = all correctType pairs where - pairs = dictionaryItems x - kType = dictionaryKeyType x - vType = dictionaryValueType x - correctType (k, v) = variantType k == kType && - variantType v == vType - -instance Arbitrary Structure where - arbitrary = fmap Structure $ halfSized arbitrary - -instance Arbitrary BusName where - arbitrary = sizedText 255 (oneof [unique, wellKnown]) where - c = ['a'..'z'] ++ ['A'..'Z'] ++ "_-" - c' = c ++ ['0'..'9'] - - unique = do - elems' <- atLeast 2 $ elems c' - return . TL.pack $ ':' : intercalate "." elems' - - wellKnown = do - elems' <- atLeast 2 $ elems c - return . TL.pack $ intercalate "." elems' - - elems start = do - x <- elements start - xs <- atLeast 0 (elements c') - return (x:xs) - -instance Arbitrary InterfaceName where - arbitrary = sizedText 255 genName where - c = ['a'..'z'] ++ ['A'..'Z'] ++ "_" - c' = c ++ ['0'..'9'] - - genName = fmap (TL.pack . intercalate ".") genElements - genElements = atLeast 2 genElement - genElement = do - x <- elements c - xs <- atLeast 0 (elements c') - return (x:xs) - -instance Arbitrary ErrorName where - arbitrary = fmap (mkErrorName_ . strInterfaceName) arbitrary - -instance Arbitrary MemberName where - arbitrary = sizedText 255 genName where - c = ['a'..'z'] ++ ['A'..'Z'] ++ "_" - c' = c ++ ['0'..'9'] - - genName = do - x <- elements c - xs <- atLeast 0 (elements c') - return . TL.pack $ (x:xs) - -instance Arbitrary Flag where - arbitrary = elements [NoReplyExpected, NoAutoStart] - -instance Arbitrary Serial where - arbitrary = fmap Serial arbitrary - -instance Arbitrary MethodCall where - arbitrary = do - path <- arbitrary - member <- arbitrary - iface <- arbitrary - dest <- arbitrary - flags <- fmap Set.fromList arbitrary - Structure body <- arbitrary - return $ MethodCall path member iface dest flags body - -instance Arbitrary MethodReturn where - arbitrary = do - serial <- arbitrary - dest <- arbitrary - Structure body <- arbitrary - return $ MethodReturn serial dest body - -instance Arbitrary Error where - arbitrary = do - name <- arbitrary - serial <- arbitrary - dest <- arbitrary - Structure body <- arbitrary - return $ Error name serial dest body - -instance Arbitrary Signal where - arbitrary = do - path <- arbitrary - member <- arbitrary - iface <- arbitrary - dest <- arbitrary - Structure body <- arbitrary - return $ Signal path member iface dest body - -instance Arbitrary Endianness where - arbitrary = elements [LittleEndian, BigEndian] - -prop_Unmarshal :: Endianness -> Variant -> Property -prop_Unmarshal e x = valid ==> unmarshaled == Right [x] where - sig = mkSignature . typeCode . variantType $ x - Just sig' = sig - - bytes = runMarshal (marshal x) e - Right bytes' = bytes - - valid = isJust sig && isRight bytes - unmarshaled = runUnmarshal (unmarshal sig') e bytes' - -prop_MarshalMessage e serial msg expected = valid ==> correct where - bytes = marshalMessage e serial msg - Right bytes' = bytes - - getBytes = G.getLazyByteString . fromIntegral - unmarshaled = G.runGet (unmarshalMessage getBytes) bytes' - - valid = isRight bytes - correct = unmarshaled == Right expected - -prop_WireMethodCall e serial msg = prop_MarshalMessage e serial msg - $ ReceivedMethodCall serial Nothing msg - -prop_WireMethodReturn e serial msg = prop_MarshalMessage e serial msg - $ ReceivedMethodReturn serial Nothing msg - -prop_WireError e serial msg = prop_MarshalMessage e serial msg - $ ReceivedError serial Nothing msg - -prop_WireSignal e serial msg = prop_MarshalMessage e serial msg - $ ReceivedSignal serial Nothing msg - -instance Arbitrary Address where - arbitrary = genAddress where - optional = ['0'..'9'] ++ ['a'..'z'] ++ ['A'..'Z'] ++ "-_/\\*." - methodChars = filter (flip notElem ":;") ['!'..'~'] - keyChars = filter (flip notElem "=;,") ['!'..'~'] - - genMethod = atLeast 0 $ elements methodChars - genParam = do - key <- genKey - value <- genValue - return . concat $ [key, "=", value] - - genKey = atLeast 1 $ elements keyChars - genValue = oneof [encodedValue, plainValue] - genHex = elements $ ['0'..'9'] ++ ['a'..'f'] ++ ['A'..'F'] - encodedValue = do - x1 <- genHex - x2 <- genHex - return ['%', x1, x2] - plainValue = atLeast 1 $ elements optional - - genParams = do - params <- atLeast 0 genParam - let params' = intercalate "," params - extraComma <- if null params - then return "" - else elements ["", ","] - return $ concat [params', extraComma] - - genAddress = do - m <- genMethod - params <- genParams - extraSemicolon <- elements ["", ";"] - let addrStr = concat [m, ":", params, extraSemicolon] - let Just [addr] = mkAddresses $ TL.pack addrStr - return addr - -subObject :: ObjectPath -> Gen I.Object -subObject parentPath = sized $ \n -> resize (min n 4) $ do - let nonRoot = do - x <- arbitrary - case strObjectPath x of - "/" -> nonRoot - x' -> return x' - - thisPath <- nonRoot - let path' = case strObjectPath parentPath of - "/" -> thisPath - x -> TL.append x thisPath - let path = mkObjectPath_ path' - ifaces <- arbitrary - children <- halfSized . listOf . subObject $ path - return $ I.Object path ifaces children - -instance Arbitrary I.Object where - arbitrary = arbitrary >>= subObject - -instance Arbitrary I.Interface where - arbitrary = do - name <- arbitrary - methods <- arbitrary - signals <- arbitrary - properties <- arbitrary - return $ I.Interface name methods signals properties - -instance Arbitrary I.Method where - arbitrary = do - name <- arbitrary - inParams <- arbitrary - outParams <- arbitrary - return $ I.Method name inParams outParams - -instance Arbitrary I.Signal where - arbitrary = do - name <- arbitrary - params <- arbitrary - return $ I.Signal name params - -singleType :: Gen Signature -singleType = do - t <- arbitrary - case mkSignature $ typeCode t of - Just x -> return x - Nothing -> singleType - -instance Arbitrary I.Parameter where - arbitrary = do - name <- listOf $ arbitrary `suchThat` isPrint - sig <- singleType - return $ I.Parameter (TL.pack name) sig - -instance Arbitrary I.Property where - arbitrary = do - name <- listOf $ arbitrary `suchThat` isPrint - sig <- singleType - access <- elements - [[], [I.Read], [I.Write], - [I.Read, I.Write]] - return $ I.Property (TL.pack name) sig access - -halfSized :: Gen a -> Gen a -halfSized gen = sized $ \n -> if n > 0 then - resize (n `div` 2) gen - else gen - -funEq :: Eq b => (a -> b) -> (a -> b) -> a -> Bool -funEq f g x = f x == g x - -sizedText :: (IsString a, Arbitrary a) => Integer -> Gen TL.Text -> Gen a -sizedText maxSize gen = step where - step = do - s <- gen - if toInteger (TL.length s) > maxSize - then halfSized step - else return . fromString . TL.unpack $ s - -atLeast :: Int -> Gen a -> Gen [a] -atLeast minSize g = sized $ \n -> do - count <- choose (minSize, max minSize n) - replicateM count g - -isRight :: Either a b -> Bool -isRight = either (const False) (const True) - -test :: Testable a => F.TestName -> a -> F.Test -test name prop = F.plusTestOptions options (testProperty name prop) where - options = F.TestOptions Nothing (Just 1) Nothing Nothing - -instance Arbitrary T.Text where - arbitrary = fmap T.pack arbitrary - -instance Arbitrary TL.Text where - arbitrary = fmap TL.pack arbitrary diff --git a/latex/figure_1.svg b/latex/figure_1.svg new file mode 100644 --- /dev/null +++ b/latex/figure_1.svg @@ -0,0 +1,4840 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + Exaile(via dbus-python) + + D-Bus Server + + XMonad(via dbus-core) + + + + + + + + + + Linux(via HAL) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/latex/geometry.sty b/latex/geometry.sty new file mode 100644 --- /dev/null +++ b/latex/geometry.sty @@ -0,0 +1,1130 @@ +%% +%% This is file `geometry.sty', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% geometry.dtx (with options: `package') +%% +%% Copyright (C) 1996-2010 +%% by Hideo Umeki +%% +%% This work may be distributed and/or modified under the conditions of +%% the LaTeX Project Public License, either version 1.3c of this license +%% or (at your option) any later version. The latest version of this +%% license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.3c or later is part of all distributions of LaTeX +%% version 2005/12/01 or later. +%% +%% This work is "maintained" (as per the LPPL maintenance status) +%% by Hideo Umeki. +%% +%% This work consists of the files geometry.dtx and +%% the derived files: geometry.{sty,ins,drv}, geometry-samples.tex. +%% +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{geometry} + [2010/09/12 v5.6 Page Geometry] +\RequirePackage{keyval}% +\RequirePackage{ifpdf}% +\RequirePackage{ifvtex}% +\RequirePackage{ifxetex}% +\newif\ifGm@verbose +\newif\ifGm@landscape +\newif\ifGm@swap@papersize +\newif\ifGm@includehead +\newif\ifGm@includefoot +\newif\ifGm@includemp +\newif\ifGm@hbody +\newif\ifGm@vbody +\newif\ifGm@heightrounded +\newif\ifGm@showframe +\newif\ifGm@showcrop +\newif\ifGm@pass +\newif\ifGm@resetpaper +\newif\ifGm@layout +\newif\ifGm@newgm +\newcount\Gm@cnth +\newcount\Gm@cntv +\newcount\c@Gm@tempcnt +\newdimen\Gm@bindingoffset +\newdimen\Gm@wd@mp +\newdimen\Gm@odd@mp +\newdimen\Gm@even@mp +\newdimen\Gm@layoutwidth +\newdimen\Gm@layoutheight +\newdimen\Gm@layouthoffset +\newdimen\Gm@layoutvoffset +\newtoks\Gm@dimlist +\def\Gm@warning#1{\PackageWarningNoLine{geometry}{#1}}% +\def\ifGm@preamble#1{% + \ifGm@newgm + \Gm@warning{`#1': not available in `\string\newgeometry'; skipped}% + \else + \expandafter\@firstofone + \fi}% +\def\Gm@Dhratio{1:1}% = left:right default for oneside +\def\Gm@Dhratiotwo{2:3}% = inner:outer default for twoside. +\def\Gm@Dvratio{2:3}% = top:bottom default +\def\Gm@Dhscale{0.7}% +\def\Gm@Dvscale{0.7}% +\def\Gm@dvips{dvips}% +\def\Gm@dvipdfm{dvipdfm}% +\def\Gm@pdftex{pdftex}% +\def\Gm@xetex{xetex}% +\def\Gm@vtex{vtex}% +\def\Gm@true{true}% +\def\Gm@false{false}% +\edef\Gm@orgpw{\the\paperwidth}% +\edef\Gm@orgph{\the\paperheight}% +\def\Gm@savelength#1{% + \g@addto@macro\Gm@restore{\expandafter\noexpand\expandafter\csname + #1\endcsname\expandafter=\expandafter\the\csname #1\endcsname\relax}}% +\def\Gm@saveboolean#1{% + \csname if#1\endcsname + \g@addto@macro\Gm@restore{\expandafter\noexpand\csname #1true\endcsname}% + \else + \g@addto@macro\Gm@restore{\expandafter\noexpand\csname #1false\endcsname}% + \fi}% +\def\Gm@restore{}% +\def\Gm@save{% + \Gm@savelength{paperwidth}% + \Gm@savelength{paperheight}% + \Gm@savelength{textwidth}% + \Gm@savelength{textheight}% + \Gm@savelength{evensidemargin}% + \Gm@savelength{oddsidemargin}% + \Gm@savelength{topmargin}% + \Gm@savelength{headheight}% + \Gm@savelength{headsep}% + \Gm@savelength{topskip}% + \Gm@savelength{footskip}% + \Gm@savelength{baselineskip}% + \Gm@savelength{marginparwidth}% + \Gm@savelength{marginparsep}% + \Gm@savelength{columnsep}% + \Gm@savelength{hoffset}% + \Gm@savelength{voffset} + \Gm@savelength{Gm@layoutwidth}% + \Gm@savelength{Gm@layoutheight}% + \Gm@savelength{Gm@layouthoffset}% + \Gm@savelength{Gm@layoutvoffset}% + \Gm@saveboolean{@twocolumn}% + \Gm@saveboolean{@twoside}% + \Gm@saveboolean{@mparswitch}% + \Gm@saveboolean{@reversemargin}}% +\def\Gm@initnewgm{% + \Gm@passfalse + \Gm@swap@papersizefalse + \Gm@dimlist={} + \Gm@hbodyfalse + \Gm@vbodyfalse + \Gm@heightroundedfalse + \Gm@includeheadfalse + \Gm@includefootfalse + \Gm@includempfalse + \let\Gm@width\@undefined + \let\Gm@height\@undefined + \let\Gm@textwidth\@undefined + \let\Gm@textheight\@undefined + \let\Gm@lines\@undefined + \let\Gm@hscale\@undefined + \let\Gm@vscale\@undefined + \let\Gm@hmarginratio\@undefined + \let\Gm@vmarginratio\@undefined + \let\Gm@lmargin\@undefined + \let\Gm@rmargin\@undefined + \let\Gm@tmargin\@undefined + \let\Gm@bmargin\@undefined + \Gm@layoutfalse + \Gm@layouthoffset\z@ + \Gm@layoutvoffset\z@ + \Gm@bindingoffset\z@}% +\def\Gm@initall{% + \let\Gm@driver\@empty + \let\Gm@truedimen\@empty + \let\Gm@paper\@undefined + \Gm@resetpaperfalse + \Gm@landscapefalse + \Gm@verbosefalse + \Gm@showframefalse + \Gm@showcropfalse + \Gm@newgmfalse + \Gm@initnewgm}% +\def\Gm@setdriver#1{% + \expandafter\let\expandafter\Gm@driver\csname Gm@#1\endcsname}% +\def\Gm@unsetdriver#1{% + \expandafter\ifx\csname Gm@#1\endcsname\Gm@driver\let\Gm@driver\@empty\fi}% +\def\Gm@setbool{\@dblarg\Gm@@setbool}% +\def\Gm@setboolrev{\@dblarg\Gm@@setboolrev}% +\def\Gm@@setbool[#1]#2#3{\Gm@doif{#1}{#3}{\csname Gm@#2\Gm@bool\endcsname}}% +\def\Gm@@setboolrev[#1]#2#3{\Gm@doifelse{#1}{#3}% + {\csname Gm@#2\Gm@false\endcsname}{\csname Gm@#2\Gm@true\endcsname}}% +\def\Gm@doif#1#2#3{% + \lowercase{\def\Gm@bool{#2}}% + \ifx\Gm@bool\@empty + \let\Gm@bool\Gm@true + \fi + \ifx\Gm@bool\Gm@true + \else + \ifx\Gm@bool\Gm@false + \else + \let\Gm@bool\relax + \fi + \fi + \ifx\Gm@bool\relax + \Gm@warning{`#1' should be set to `true' or `false'}% + \else + #3 + \fi}% +\def\Gm@doifelse#1#2#3#4{% + \Gm@doif{#1}{#2}{\ifx\Gm@bool\Gm@true #3\else #4\fi}}% +\def\Gm@reverse#1{% + \csname ifGm@#1\endcsname + \csname Gm@#1false\endcsname\else\csname Gm@#1true\endcsname\fi}% +\def\Gm@defbylen#1#2{% + \begingroup\setlength\@tempdima{#2}% + \expandafter\xdef\csname Gm@#1\endcsname{\the\@tempdima}\endgroup}% +\def\Gm@defbycnt#1#2{% + \begingroup\setcounter{Gm@tempcnt}{#2}% + \expandafter\xdef\csname Gm@#1\endcsname{\the\value{Gm@tempcnt}}\endgroup}% +\def\Gm@sep@ratio#1:#2{\@tempcnta=#1\@tempcntb=#2}% +\def\Gm@setbyratio[#1]#2#3#4{% determine #4 by ratio + \expandafter\Gm@sep@ratio\Gm@mratio\relax + \if#1b + \edef\@@tempa{\the\@tempcnta}% + \@tempcnta=\@tempcntb + \@tempcntb=\@@tempa\relax + \fi + \expandafter\setlength\expandafter\@tempdimb\expandafter + {\csname Gm@#3\endcsname}% + \ifnum\@tempcntb>\z@ + \multiply\@tempdimb\@tempcnta + \divide\@tempdimb\@tempcntb + \fi + \expandafter\edef\csname Gm@#4\endcsname{\the\@tempdimb}}% +\def\Gm@detiv#1#2#3#4{% determine #4. + \expandafter\setlength\expandafter\@tempdima\expandafter + {\csname Gm@layout#1\endcsname}% + \expandafter\setlength\expandafter\@tempdimb\expandafter + {\csname Gm@#2\endcsname}% + \addtolength\@tempdima{-\@tempdimb}% + \expandafter\setlength\expandafter\@tempdimb\expandafter + {\csname Gm@#3\endcsname}% + \addtolength\@tempdima{-\@tempdimb}% + \ifdim\@tempdima<\z@ + \Gm@warning{`#4' results in NEGATIVE (\the\@tempdima).% + ^^J\@spaces `#2' or `#3' should be shortened in length}% + \fi + \expandafter\edef\csname Gm@#4\endcsname{\the\@tempdima}}% +\def\Gm@detiiandiii#1#2#3{% determine #2 and #3. + \expandafter\setlength\expandafter\@tempdima\expandafter + {\csname Gm@layout#1\endcsname}% + \expandafter\setlength\expandafter\@tempdimb\expandafter + {\csname Gm@#1\endcsname}% + \addtolength\@tempdima{-\@tempdimb}% + \ifdim\@tempdima<\z@ + \Gm@warning{`#2' and `#3' result in NEGATIVE (\the\@tempdima).% + ^^J\@spaces `#1' should be shortened in length}% + \fi + \ifx\Gm@mratio\@undefined + \expandafter\Gm@sep@ratio\Gm@Dmratio\relax + \else + \expandafter\Gm@sep@ratio\Gm@mratio\relax + \ifnum\@tempcntb>\z@\else + \Gm@warning{margin ratio a:b should be non-zero; default used}% + \expandafter\Gm@sep@ratio\Gm@Dmratio\relax + \fi + \fi + \@tempdimb=\@tempdima + \advance\@tempcntb\@tempcnta + \divide\@tempdima\@tempcntb + \multiply\@tempdima\@tempcnta + \advance\@tempdimb-\@tempdima + \expandafter\edef\csname Gm@#2\endcsname{\the\@tempdima}% + \expandafter\edef\csname Gm@#3\endcsname{\the\@tempdimb}}% +\def\Gm@detall#1#2#3#4{% + \@tempcnta\z@ + \if#1h + \let\Gm@mratio\Gm@hmarginratio + \edef\Gm@Dmratio{\if@twoside\Gm@Dhratiotwo\else\Gm@Dhratio\fi}% + \else + \let\Gm@mratio\Gm@vmarginratio + \edef\Gm@Dmratio{\Gm@Dvratio}% + \fi + \if#1h + \ifx\Gm@lmargin\@undefined\else\advance\@tempcnta4\relax\fi + \ifGm@hbody\advance\@tempcnta2\relax\fi + \ifx\Gm@rmargin\@undefined\else\advance\@tempcnta1\relax\fi + \Gm@cnth\@tempcnta + \else + \ifx\Gm@tmargin\@undefined\else\advance\@tempcnta4\relax\fi + \ifGm@vbody\advance\@tempcnta2\relax\fi + \ifx\Gm@bmargin\@undefined\else\advance\@tempcnta1\relax\fi + \Gm@cntv\@tempcnta + \fi + \ifcase\@tempcnta + \if#1h + \Gm@defbylen{width}{\Gm@Dhscale\Gm@layoutwidth}% + \else + \Gm@defbylen{height}{\Gm@Dvscale\Gm@layoutheight}% + \fi + \Gm@detiiandiii{#2}{#3}{#4}% + \or + \ifx\Gm@mratio\@undefined + \if#1h + \Gm@defbylen{width}{\Gm@Dhscale\Gm@layoutwidth}% + \else + \Gm@defbylen{height}{\Gm@Dvscale\Gm@layoutheight}% + \fi + \setlength\@tempdimc{\@nameuse{Gm@#4}}% + \Gm@detiiandiii{#2}{#3}{#4}% + \expandafter\let\csname Gm@#2\endcsname\@undefined + \Gm@defbylen{#4}{\@tempdimc}% + \else + \Gm@setbyratio[f]{#1}{#4}{#3}% + \fi + \Gm@detiv{#2}{#3}{#4}{#2}% + \or\Gm@detiiandiii{#2}{#3}{#4}% + \or\Gm@detiv{#2}{#2}{#4}{#3}% + \or + \ifx\Gm@mratio\@undefined + \if#1h + \Gm@defbylen{width}{\Gm@Dhscale\Gm@layoutwidth}% + \else + \Gm@defbylen{height}{\Gm@Dvscale\Gm@layoutheight}% + \fi + \setlength\@tempdimc{\@nameuse{Gm@#3}}% + \Gm@detiiandiii{#2}{#4}{#3}% + \expandafter\let\csname Gm@#2\endcsname\@undefined + \Gm@defbylen{#3}{\@tempdimc}% + \else + \Gm@setbyratio[b]{#1}{#3}{#4}% + \fi + \Gm@detiv{#2}{#3}{#4}{#2}% + \or\Gm@detiv{#2}{#3}{#4}{#2}% + \or\Gm@detiv{#2}{#2}{#3}{#4}% + \or\Gm@warning{Over-specification in `#1'-direction.% + ^^J\@spaces `#2' (\@nameuse{Gm@#2}) is ignored}% + \Gm@detiv{#2}{#3}{#4}{#2}% + \else\fi}% +\def\Gm@clean{% + \ifnum\Gm@cnth<4\let\Gm@lmargin\@undefined\fi + \ifodd\Gm@cnth\else\let\Gm@rmargin\@undefined\fi + \ifnum\Gm@cntv<4\let\Gm@tmargin\@undefined\fi + \ifodd\Gm@cntv\else\let\Gm@bmargin\@undefined\fi + \ifGm@hbody\else + \let\Gm@hscale\@undefined + \let\Gm@width\@undefined + \let\Gm@textwidth\@undefined + \fi + \ifGm@vbody\else + \let\Gm@vscale\@undefined + \let\Gm@height\@undefined + \let\Gm@textheight\@undefined + \fi + }% +\def\Gm@parse@divide#1#2#3#4{% + \def\Gm@star{*}% + \@tempcnta\z@ + \@for\Gm@tmp:=#1\do{% + \expandafter\KV@@sp@def\expandafter\Gm@frag\expandafter{\Gm@tmp}% + \edef\Gm@value{\Gm@frag}% + \ifcase\@tempcnta\relax\edef\Gm@key{#2}% + \or\edef\Gm@key{#3}% + \else\edef\Gm@key{#4}% + \fi + \@nameuse{Gm@set\Gm@key false}% + \ifx\empty\Gm@value\else + \ifx\Gm@star\Gm@value\else + \setkeys{Gm}{\Gm@key=\Gm@value}% + \fi\fi + \advance\@tempcnta\@ne}% + \let\Gm@star\relax}% +\def\Gm@branch#1#2#3{% + \@tempcnta\z@ + \@for\Gm@tmp:=#1\do{% + \KV@@sp@def\Gm@frag{\Gm@tmp}% + \edef\Gm@value{\Gm@frag}% + \ifcase\@tempcnta\relax% cnta == 0 + \setkeys{Gm}{#2=\Gm@value}% + \or% cnta == 1 + \setkeys{Gm}{#3=\Gm@value}% + \else\fi + \advance\@tempcnta\@ne}% + \ifnum\@tempcnta=\@ne + \setkeys{Gm}{#3=\Gm@value}% + \fi}% +\def\Gm@magtooffset{% + \@tempdima=\mag\Gm@truedimen sp% + \@tempdimb=1\Gm@truedimen in% + \divide\@tempdimb\@tempdima + \multiply\@tempdimb\@m + \addtolength{\hoffset}{1\Gm@truedimen in}% + \addtolength{\voffset}{1\Gm@truedimen in}% + \addtolength{\hoffset}{-\the\@tempdimb}% + \addtolength{\voffset}{-\the\@tempdimb}}% +\def\Gm@setlength#1#2{% + \let\Gm@len=\relax\let\Gm@td=\relax + \edef\addtolist{\noexpand\Gm@dimlist=% + {\the\Gm@dimlist \Gm@len{#1}{#2}}}\addtolist}% +\def\Gm@expandlengths{% + \def\Gm@td{\Gm@truedimen}% + \def\Gm@len##1##2{\setlength{##1}{##2}}% + \the\Gm@dimlist}% +\def\Gm@setsize#1(#2,#3)#4{% + \let\Gm@td\relax + \expandafter\Gm@setlength\csname #1width\endcsname{#2\Gm@td #4}% + \expandafter\Gm@setlength\csname #1height\endcsname{#3\Gm@td #4}% + \ifGm@landscape\Gm@swap@papersizetrue\else\Gm@swap@papersizefalse\fi}% +\def\Gm@setpaper@ifpre#1{% + \ifGm@preamble{#1}{\def\Gm@paper{#1}\@nameuse{Gm@#1}{paper}}}% +\@namedef{Gm@a0paper}#1{\Gm@setsize{#1}(841,1189){mm}}% ISO A0 +\@namedef{Gm@a1paper}#1{\Gm@setsize{#1}(594,841){mm}}% ISO A1 +\@namedef{Gm@a2paper}#1{\Gm@setsize{#1}(420,594){mm}}% ISO A2 +\@namedef{Gm@a3paper}#1{\Gm@setsize{#1}(297,420){mm}}% ISO A3 +\@namedef{Gm@a4paper}#1{\Gm@setsize{#1}(210,297){mm}}% ISO A4 +\@namedef{Gm@a5paper}#1{\Gm@setsize{#1}(148,210){mm}}% ISO A5 +\@namedef{Gm@a6paper}#1{\Gm@setsize{#1}(105,148){mm}}% ISO A6 +\@namedef{Gm@b0paper}#1{\Gm@setsize{#1}(1000,1414){mm}}% ISO B0 +\@namedef{Gm@b1paper}#1{\Gm@setsize{#1}(707,1000){mm}}% ISO B1 +\@namedef{Gm@b2paper}#1{\Gm@setsize{#1}(500,707){mm}}% ISO B2 +\@namedef{Gm@b3paper}#1{\Gm@setsize{#1}(353,500){mm}}% ISO B3 +\@namedef{Gm@b4paper}#1{\Gm@setsize{#1}(250,353){mm}}% ISO B4 +\@namedef{Gm@b5paper}#1{\Gm@setsize{#1}(176,250){mm}}% ISO B5 +\@namedef{Gm@b6paper}#1{\Gm@setsize{#1}(125,176){mm}}% ISO B6 +\@namedef{Gm@c0paper}#1{\Gm@setsize{#1}(917,1297){mm}}% ISO C0 +\@namedef{Gm@c1paper}#1{\Gm@setsize{#1}(648,917){mm}}% ISO C1 +\@namedef{Gm@c2paper}#1{\Gm@setsize{#1}(458,648){mm}}% ISO C2 +\@namedef{Gm@c3paper}#1{\Gm@setsize{#1}(324,458){mm}}% ISO C3 +\@namedef{Gm@c4paper}#1{\Gm@setsize{#1}(229,324){mm}}% ISO C4 +\@namedef{Gm@c5paper}#1{\Gm@setsize{#1}(162,229){mm}}% ISO C5 +\@namedef{Gm@c6paper}#1{\Gm@setsize{#1}(114,162){mm}}% ISO C6 +\@namedef{Gm@b0j}#1{\Gm@setsize{#1}(1030,1456){mm}}% JIS B0 +\@namedef{Gm@b1j}#1{\Gm@setsize{#1}(728,1030){mm}}% JIS B1 +\@namedef{Gm@b2j}#1{\Gm@setsize{#1}(515,728){mm}}% JIS B2 +\@namedef{Gm@b3j}#1{\Gm@setsize{#1}(364,515){mm}}% JIS B3 +\@namedef{Gm@b4j}#1{\Gm@setsize{#1}(257,364){mm}}% JIS B4 +\@namedef{Gm@b5j}#1{\Gm@setsize{#1}(182,257){mm}}% JIS B5 +\@namedef{Gm@b6j}#1{\Gm@setsize{#1}(128,182){mm}}% JIS B6 +\@namedef{Gm@ansiapaper}#1{\Gm@setsize{#1}(8.5,11){in}}% +\@namedef{Gm@ansibpaper}#1{\Gm@setsize{#1}(11,17){in}}% +\@namedef{Gm@ansicpaper}#1{\Gm@setsize{#1}(17,22){in}}% +\@namedef{Gm@ansidpaper}#1{\Gm@setsize{#1}(22,34){in}}% +\@namedef{Gm@ansiepaper}#1{\Gm@setsize{#1}(34,44){in}}% +\@namedef{Gm@letterpaper}#1{\Gm@setsize{#1}(8.5,11){in}}% +\@namedef{Gm@legalpaper}#1{\Gm@setsize{#1}(8.5,14){in}}% +\@namedef{Gm@executivepaper}#1{\Gm@setsize{#1}(7.25,10.5){in}}% +\@namedef{Gm@screen}#1{\Gm@setsize{#1}(225,180){mm}}% +\define@key{Gm}{paper}{\setkeys{Gm}{#1}}% +\let\KV@Gm@papername\KV@Gm@paper +\define@key{Gm}{a0paper}[true]{\Gm@setpaper@ifpre{a0paper}}% +\define@key{Gm}{a1paper}[true]{\Gm@setpaper@ifpre{a1paper}}% +\define@key{Gm}{a2paper}[true]{\Gm@setpaper@ifpre{a2paper}}% +\define@key{Gm}{a3paper}[true]{\Gm@setpaper@ifpre{a3paper}}% +\define@key{Gm}{a4paper}[true]{\Gm@setpaper@ifpre{a4paper}}% +\define@key{Gm}{a5paper}[true]{\Gm@setpaper@ifpre{a5paper}}% +\define@key{Gm}{a6paper}[true]{\Gm@setpaper@ifpre{a6paper}}% +\define@key{Gm}{b0paper}[true]{\Gm@setpaper@ifpre{b0paper}}% +\define@key{Gm}{b1paper}[true]{\Gm@setpaper@ifpre{b1paper}}% +\define@key{Gm}{b2paper}[true]{\Gm@setpaper@ifpre{b2paper}}% +\define@key{Gm}{b3paper}[true]{\Gm@setpaper@ifpre{b3paper}}% +\define@key{Gm}{b4paper}[true]{\Gm@setpaper@ifpre{b4paper}}% +\define@key{Gm}{b5paper}[true]{\Gm@setpaper@ifpre{b5paper}}% +\define@key{Gm}{b6paper}[true]{\Gm@setpaper@ifpre{b6paper}}% +\define@key{Gm}{c0paper}[true]{\Gm@setpaper@ifpre{c0paper}}% +\define@key{Gm}{c1paper}[true]{\Gm@setpaper@ifpre{c1paper}}% +\define@key{Gm}{c2paper}[true]{\Gm@setpaper@ifpre{c2paper}}% +\define@key{Gm}{c3paper}[true]{\Gm@setpaper@ifpre{c3paper}}% +\define@key{Gm}{c4paper}[true]{\Gm@setpaper@ifpre{c4paper}}% +\define@key{Gm}{c5paper}[true]{\Gm@setpaper@ifpre{c5paper}}% +\define@key{Gm}{c6paper}[true]{\Gm@setpaper@ifpre{c6paper}}% +\define@key{Gm}{b0j}[true]{\Gm@setpaper@ifpre{b0j}}% +\define@key{Gm}{b1j}[true]{\Gm@setpaper@ifpre{b1j}}% +\define@key{Gm}{b2j}[true]{\Gm@setpaper@ifpre{b2j}}% +\define@key{Gm}{b3j}[true]{\Gm@setpaper@ifpre{b3j}}% +\define@key{Gm}{b4j}[true]{\Gm@setpaper@ifpre{b4j}}% +\define@key{Gm}{b5j}[true]{\Gm@setpaper@ifpre{b5j}}% +\define@key{Gm}{b6j}[true]{\Gm@setpaper@ifpre{b6j}}% +\define@key{Gm}{ansiapaper}[true]{\Gm@setpaper@ifpre{ansiapaper}}% +\define@key{Gm}{ansibpaper}[true]{\Gm@setpaper@ifpre{ansibpaper}}% +\define@key{Gm}{ansicpaper}[true]{\Gm@setpaper@ifpre{ansicpaper}}% +\define@key{Gm}{ansidpaper}[true]{\Gm@setpaper@ifpre{ansidpaper}}% +\define@key{Gm}{ansiepaper}[true]{\Gm@setpaper@ifpre{ansiepaper}}% +\define@key{Gm}{letterpaper}[true]{\Gm@setpaper@ifpre{letterpaper}}% +\define@key{Gm}{legalpaper}[true]{\Gm@setpaper@ifpre{legalpaper}}% +\define@key{Gm}{executivepaper}[true]{\Gm@setpaper@ifpre{executivepaper}}% +\define@key{Gm}{screen}[true]{\Gm@setpaper@ifpre{screen}}% +\define@key{Gm}{paperwidth}{\ifGm@preamble{paperwidth}{% + \def\Gm@paper{custom}\Gm@setlength\paperwidth{#1}}}% +\define@key{Gm}{paperheight}{\ifGm@preamble{paperheight}{% + \def\Gm@paper{custom}\Gm@setlength\paperheight{#1}}}% +\define@key{Gm}{papersize}{\ifGm@preamble{papersize}{% + \def\Gm@paper{custom}\Gm@branch{#1}{paperwidth}{paperheight}}}% +\define@key{Gm}{layout}{\Gm@layouttrue\@nameuse{Gm@#1}{Gm@layout}}% +\let\KV@Gm@layoutname\KV@Gm@layout +\define@key{Gm}{layoutwidth}{\Gm@layouttrue\Gm@setlength\Gm@layoutwidth{#1}}% +\define@key{Gm}{layoutheight}{\Gm@layouttrue\Gm@setlength\Gm@layoutheight{#1}}% +\define@key{Gm}{layoutsize}{\Gm@branch{#1}{layoutwidth}{layoutheight}}% +\define@key{Gm}{landscape}[true]{\ifGm@preamble{landscape}{% + \Gm@doifelse{landscape}{#1}% + {\ifGm@landscape\else\Gm@landscapetrue\Gm@reverse{swap@papersize}\fi}% + {\ifGm@landscape\Gm@landscapefalse\Gm@reverse{swap@papersize}\fi}}}% +\define@key{Gm}{portrait}[true]{\ifGm@preamble{portrait}{% + \Gm@doifelse{portrait}{#1}% + {\ifGm@landscape\Gm@landscapefalse\Gm@reverse{swap@papersize}\fi}% + {\ifGm@landscape\else\Gm@landscapetrue\Gm@reverse{swap@papersize}\fi}}}% +\define@key{Gm}{hscale}{\Gm@hbodytrue\edef\Gm@hscale{#1}}% +\define@key{Gm}{vscale}{\Gm@vbodytrue\edef\Gm@vscale{#1}}% +\define@key{Gm}{scale}{\Gm@branch{#1}{hscale}{vscale}}% +\define@key{Gm}{width}{\Gm@hbodytrue\Gm@defbylen{width}{#1}}% +\define@key{Gm}{height}{\Gm@vbodytrue\Gm@defbylen{height}{#1}}% +\define@key{Gm}{total}{\Gm@branch{#1}{width}{height}}% +\let\KV@Gm@totalwidth\KV@Gm@width +\let\KV@Gm@totalheight\KV@Gm@height +\define@key{Gm}{textwidth}{\Gm@hbodytrue\Gm@defbylen{textwidth}{#1}}% +\define@key{Gm}{textheight}{\Gm@vbodytrue\Gm@defbylen{textheight}{#1}}% +\define@key{Gm}{text}{\Gm@branch{#1}{textwidth}{textheight}}% +\let\KV@Gm@body\KV@Gm@text +\define@key{Gm}{lines}{\Gm@vbodytrue\Gm@defbycnt{lines}{#1}}% +\define@key{Gm}{includehead}[true]{\Gm@setbool{includehead}{#1}}% +\define@key{Gm}{includefoot}[true]{\Gm@setbool{includefoot}{#1}}% +\define@key{Gm}{includeheadfoot}[true]{\Gm@doifelse{includeheadfoot}{#1}% + {\Gm@includeheadtrue\Gm@includefoottrue}% + {\Gm@includeheadfalse\Gm@includefootfalse}}% +\define@key{Gm}{includemp}[true]{\Gm@setbool{includemp}{#1}}% +\define@key{Gm}{includeall}[true]{\Gm@doifelse{includeall}{#1}% + {\Gm@includeheadtrue\Gm@includefoottrue\Gm@includemptrue}% + {\Gm@includeheadfalse\Gm@includefootfalse\Gm@includempfalse}}% +\define@key{Gm}{ignorehead}[true]{% + \Gm@setboolrev[ignorehead]{includehead}{#1}}% +\define@key{Gm}{ignorefoot}[true]{% + \Gm@setboolrev[ignorefoot]{includefoot}{#1}}% +\define@key{Gm}{ignoreheadfoot}[true]{\Gm@doifelse{ignoreheadfoot}{#1}% + {\Gm@includeheadfalse\Gm@includefootfalse}% + {\Gm@includeheadtrue\Gm@includefoottrue}}% +\define@key{Gm}{ignoremp}[true]{% + \Gm@setboolrev[ignoremp]{includemp}{#1}}% +\define@key{Gm}{ignoreall}[true]{\Gm@doifelse{ignoreall}{#1}% + {\Gm@includeheadfalse\Gm@includefootfalse\Gm@includempfalse}% + {\Gm@includeheadtrue\Gm@includefoottrue\Gm@includemptrue}}% +\define@key{Gm}{heightrounded}[true]{\Gm@setbool{heightrounded}{#1}}% +\define@key{Gm}{hdivide}{\Gm@parse@divide{#1}{lmargin}{width}{rmargin}}% +\define@key{Gm}{vdivide}{\Gm@parse@divide{#1}{tmargin}{height}{bmargin}}% +\define@key{Gm}{divide}{\Gm@parse@divide{#1}{lmargin}{width}{rmargin}% + \Gm@parse@divide{#1}{tmargin}{height}{bmargin}}% +\define@key{Gm}{lmargin}{\Gm@defbylen{lmargin}{#1}}% +\define@key{Gm}{rmargin}{\Gm@defbylen{rmargin}{#1}}% +\let\KV@Gm@left\KV@Gm@lmargin +\let\KV@Gm@inner\KV@Gm@lmargin +\let\KV@Gm@innermargin\KV@Gm@lmargin +\let\KV@Gm@right\KV@Gm@rmargin +\let\KV@Gm@outer\KV@Gm@rmargin +\let\KV@Gm@outermargin\KV@Gm@rmargin +\define@key{Gm}{tmargin}{\Gm@defbylen{tmargin}{#1}}% +\define@key{Gm}{bmargin}{\Gm@defbylen{bmargin}{#1}}% +\let\KV@Gm@top\KV@Gm@tmargin +\let\KV@Gm@bottom\KV@Gm@bmargin +\define@key{Gm}{hmargin}{\Gm@branch{#1}{lmargin}{rmargin}}% +\define@key{Gm}{vmargin}{\Gm@branch{#1}{tmargin}{bmargin}}% +\define@key{Gm}{margin}{\Gm@branch{#1}{lmargin}{tmargin}% + \Gm@branch{#1}{rmargin}{bmargin}}% +\define@key{Gm}{hmarginratio}{\edef\Gm@hmarginratio{#1}}% +\define@key{Gm}{vmarginratio}{\edef\Gm@vmarginratio{#1}}% +\define@key{Gm}{marginratio}{\Gm@branch{#1}{hmarginratio}{vmarginratio}}% +\let\KV@Gm@hratio\KV@Gm@hmarginratio +\let\KV@Gm@vratio\KV@Gm@vmarginratio +\let\KV@Gm@ratio\KV@Gm@marginratio +\define@key{Gm}{hcentering}[true]{\Gm@doifelse{hcentering}{#1}% + {\def\Gm@hmarginratio{1:1}}{}}% +\define@key{Gm}{vcentering}[true]{\Gm@doifelse{vcentering}{#1}% + {\def\Gm@vmarginratio{1:1}}{}}% +\define@key{Gm}{centering}[true]{\Gm@doifelse{centering}{#1}% + {\def\Gm@hmarginratio{1:1}\def\Gm@vmarginratio{1:1}}{}}% +\define@key{Gm}{twoside}[true]{\Gm@doifelse{twoside}{#1}% + {\@twosidetrue\@mparswitchtrue}{\@twosidefalse\@mparswitchfalse}}% +\define@key{Gm}{asymmetric}[true]{\Gm@doifelse{asymmetric}{#1}% + {\@twosidetrue\@mparswitchfalse}{}}% +\define@key{Gm}{bindingoffset}{\Gm@setlength\Gm@bindingoffset{#1}}% +\define@key{Gm}{headheight}{\Gm@setlength\headheight{#1}}% +\define@key{Gm}{headsep}{\Gm@setlength\headsep{#1}}% +\define@key{Gm}{footskip}{\Gm@setlength\footskip{#1}}% +\let\KV@Gm@head\KV@Gm@headheight +\let\KV@Gm@foot\KV@Gm@footskip +\define@key{Gm}{nohead}[true]{\Gm@doifelse{nohead}{#1}% + {\Gm@setlength\headheight\z@\Gm@setlength\headsep\z@}{}}% +\define@key{Gm}{nofoot}[true]{\Gm@doifelse{nofoot}{#1}% + {\Gm@setlength\footskip\z@}{}}% +\define@key{Gm}{noheadfoot}[true]{\Gm@doifelse{noheadfoot}{#1}% + {\Gm@setlength\headheight\z@\Gm@setlength\headsep + \z@\Gm@setlength\footskip\z@}{}}% +\define@key{Gm}{footnotesep}{\Gm@setlength{\skip\footins}{#1}}% +\define@key{Gm}{marginparwidth}{\Gm@setlength\marginparwidth{#1}}% +\let\KV@Gm@marginpar\KV@Gm@marginparwidth +\define@key{Gm}{marginparsep}{\Gm@setlength\marginparsep{#1}}% +\define@key{Gm}{nomarginpar}[true]{\Gm@doifelse{nomarginpar}{#1}% + {\Gm@setlength\marginparwidth\z@\Gm@setlength\marginparsep\z@}{}}% +\define@key{Gm}{columnsep}{\Gm@setlength\columnsep{#1}}% +\define@key{Gm}{hoffset}{\Gm@setlength\hoffset{#1}}% +\define@key{Gm}{voffset}{\Gm@setlength\voffset{#1}}% +\define@key{Gm}{offset}{\Gm@branch{#1}{hoffset}{voffset}}% +\define@key{Gm}{layouthoffset}{\Gm@setlength\Gm@layouthoffset{#1}}% +\define@key{Gm}{layoutvoffset}{\Gm@setlength\Gm@layoutvoffset{#1}}% +\define@key{Gm}{layoutoffset}{\Gm@branch{#1}{layouthoffset}{layoutvoffset}}% +\define@key{Gm}{twocolumn}[true]{% + \Gm@doif{twocolumn}{#1}{\csname @twocolumn\Gm@bool\endcsname}}% +\define@key{Gm}{onecolumn}[true]{% + \Gm@doifelse{onecolumn}{#1}{\@twocolumnfalse}{\@twocolumntrue}}% +\define@key{Gm}{reversemp}[true]{% + \Gm@doif{reversemp}{#1}{\csname @reversemargin\Gm@bool\endcsname}}% +\define@key{Gm}{reversemarginpar}[true]{% + \Gm@doif{reversemarginpar}{#1}{\csname @reversemargin\Gm@bool\endcsname}}% +\define@key{Gm}{driver}{\ifGm@preamble{driver}{% + \edef\@@tempa{#1}\edef\@@auto{auto}\edef\@@none{none}% + \ifx\@@tempa\@empty\let\Gm@driver\relax\else + \ifx\@@tempa\@@none\let\Gm@driver\relax\else + \ifx\@@tempa\@@auto\let\Gm@driver\@empty\else + \setkeys{Gm}{#1}\fi\fi\fi\let\@@auto\relax\let\@@none\relax}}% +\define@key{Gm}{dvips}[true]{\ifGm@preamble{dvips}{% + \Gm@doifelse{dvips}{#1}{\Gm@setdriver{dvips}}{\Gm@unsetdriver{dvips}}}}% +\define@key{Gm}{dvipdfm}[true]{\ifGm@preamble{dvipdfm}{% + \Gm@doifelse{dvipdfm}{#1}{\Gm@setdriver{dvipdfm}}{\Gm@unsetdriver{dvipdfm}}}}% +\define@key{Gm}{pdftex}[true]{\ifGm@preamble{pdftex}{% + \Gm@doifelse{pdftex}{#1}{\Gm@setdriver{pdftex}}{\Gm@unsetdriver{pdftex}}}}% +\define@key{Gm}{xetex}[true]{\ifGm@preamble{xetex}{% + \Gm@doifelse{xetex}{#1}{\Gm@setdriver{xetex}}{\Gm@unsetdriver{xetex}}}}% +\define@key{Gm}{vtex}[true]{\ifGm@preamble{vtex}{% + \Gm@doifelse{vtex}{#1}{\Gm@setdriver{vtex}}{\Gm@unsetdriver{vtex}}}}% +\define@key{Gm}{verbose}[true]{\ifGm@preamble{verbose}{\Gm@setbool{verbose}{#1}}}% +\define@key{Gm}{reset}[true]{\ifGm@preamble{reset}{% + \Gm@doifelse{reset}{#1}{\Gm@restore@org\Gm@initall + \ProcessOptionsKV[c]{Gm}\Gm@setdefaultpaper}{}}}% +\define@key{Gm}{resetpaper}[true]{\ifGm@preamble{resetpaper}{% + \Gm@setbool{resetpaper}{#1}}}% +\define@key{Gm}{mag}{\ifGm@preamble{mag}{\mag=#1}}% +\define@key{Gm}{truedimen}[true]{\ifGm@preamble{truedimen}{% + \Gm@doifelse{truedimen}{#1}{\let\Gm@truedimen\Gm@true}% + {\let\Gm@truedimen\@empty}}}% +\define@key{Gm}{pass}[true]{\ifGm@preamble{pass}{\Gm@setbool{pass}{#1}}}% +\define@key{Gm}{showframe}[true]{\Gm@setbool{showframe}{#1}}% +\define@key{Gm}{showcrop}[true]{\Gm@setbool{showcrop}{#1}}% +\def\Gm@setdefaultpaper{% + \ifx\Gm@paper\@undefined + \Gm@setsize{paper}(\strip@pt\paperwidth,\strip@pt\paperheight){pt}% + \Gm@setsize{Gm@layout}(\strip@pt\paperwidth,\strip@pt\paperheight){pt}% + \Gm@swap@papersizefalse + \fi}% +\def\Gm@adjustpaper{% + \ifdim\paperwidth>\p@\else + \PackageError{geometry}{% + \string\paperwidth\space(\the\paperwidth) too short}{% + Set a paper type (e.g., `a4paper').}% + \fi + \ifdim\paperheight>\p@\else + \PackageError{geometry}{% + \string\paperheight\space(\the\paperheight) too short}{% + Set a paper type (e.g., `a4paper').}% + \fi + \ifGm@swap@papersize + \setlength\@tempdima{\paperwidth}% + \setlength\paperwidth{\paperheight}% + \setlength\paperheight{\@tempdima}% + \fi + \ifGm@layout\else + \setlength\Gm@layoutwidth{\paperwidth}% + \setlength\Gm@layoutheight{\paperheight}% + \fi}% +\def\Gm@checkmp{% + \ifGm@includemp\else + \@tempcnta\z@\@tempcntb\@ne + \if@twocolumn + \@tempcnta\@ne + \else + \if@reversemargin + \@tempcnta\@ne\@tempcntb\z@ + \fi + \fi + \@tempdima\marginparwidth + \advance\@tempdima\marginparsep + \ifnum\@tempcnta=\@ne + \@tempdimc\@tempdima + \setlength\@tempdimb{\Gm@lmargin}% + \advance\@tempdimc-\@tempdimb + \ifdim\@tempdimc>\z@ + \Gm@warning{The marginal notes overrun the paper edge.^^J + \@spaces Add \the\@tempdimc\space and more to the left margin}% + \fi + \fi + \ifnum\@tempcntb=\@ne + \@tempdimc\@tempdima + \setlength\@tempdimb{\Gm@rmargin}% + \advance\@tempdimc-\@tempdimb + \ifdim\@tempdimc>\z@ + \Gm@warning{The marginal notes overrun the paper.^^J + \@spaces Add \the\@tempdimc\space and more to the right margin}% + \fi + \fi + \fi}% +\def\Gm@adjustmp{% + \ifGm@includemp + \@tempdimb\marginparwidth + \advance\@tempdimb\marginparsep + \Gm@wd@mp\@tempdimb + \Gm@odd@mp\z@ + \Gm@even@mp\z@ + \if@twocolumn + \Gm@wd@mp2\@tempdimb + \Gm@odd@mp\@tempdimb + \Gm@even@mp\@tempdimb + \else + \if@reversemargin + \Gm@odd@mp\@tempdimb + \if@mparswitch\else + \Gm@even@mp\@tempdimb + \fi + \else + \if@mparswitch + \Gm@even@mp\@tempdimb + \fi + \fi + \fi + \fi}% +\def\Gm@adjustbody{ + \ifGm@hbody + \ifx\Gm@width\@undefined + \ifx\Gm@hscale\@undefined + \Gm@defbylen{width}{\Gm@Dhscale\Gm@layoutwidth}% + \else + \Gm@defbylen{width}{\Gm@hscale\Gm@layoutwidth}% + \fi + \fi + \ifx\Gm@textwidth\@undefined\else + \setlength\@tempdima{\Gm@textwidth}% + \ifGm@includemp + \advance\@tempdima\Gm@wd@mp + \fi + \edef\Gm@width{\the\@tempdima}% + \fi + \fi + \ifGm@vbody + \ifx\Gm@height\@undefined + \ifx\Gm@vscale\@undefined + \Gm@defbylen{height}{\Gm@Dvscale\Gm@layoutheight}% + \else + \Gm@defbylen{height}{\Gm@vscale\Gm@layoutheight}% + \fi + \fi + \ifx\Gm@lines\@undefined\else + \ifdim\topskip<\ht\strutbox + \setlength\@tempdima{\topskip}% + \setlength\topskip{\ht\strutbox}% + \Gm@warning{\noexpand\topskip was changed from \the\@tempdima\space + to \the\topskip}% + \fi + \setlength\@tempdima{\baselineskip}% + \multiply\@tempdima\Gm@lines + \addtolength\@tempdima{\topskip}% + \addtolength\@tempdima{-\baselineskip}% + \edef\Gm@textheight{\the\@tempdima}% + \fi + \ifx\Gm@textheight\@undefined\else + \setlength\@tempdima{\Gm@textheight}% + \ifGm@includehead + \addtolength\@tempdima{\headheight}% + \addtolength\@tempdima{\headsep}% + \fi + \ifGm@includefoot + \addtolength\@tempdima{\footskip}% + \fi + \edef\Gm@height{\the\@tempdima}% + \fi + \fi}% +\def\Gm@process{% + \ifGm@pass + \Gm@restore@org + \else + \Gm@@process + \fi}% +\def\Gm@@process{% + \Gm@expandlengths + \Gm@adjustpaper + \addtolength\Gm@layoutwidth{-\Gm@bindingoffset}% + \Gm@adjustmp + \Gm@adjustbody + \Gm@detall{h}{width}{lmargin}{rmargin}% + \Gm@detall{v}{height}{tmargin}{bmargin}% + \setlength\textwidth{\Gm@width}% + \setlength\textheight{\Gm@height}% + \setlength\topmargin{\Gm@tmargin}% + \setlength\oddsidemargin{\Gm@lmargin}% + \addtolength\oddsidemargin{-1\Gm@truedimen in}% + \ifGm@includemp + \advance\textwidth-\Gm@wd@mp + \advance\oddsidemargin\Gm@odd@mp + \fi + \if@mparswitch + \setlength\evensidemargin{\Gm@rmargin}% + \addtolength\evensidemargin{-1\Gm@truedimen in}% + \ifGm@includemp + \advance\evensidemargin\Gm@even@mp + \fi + \else + \evensidemargin\oddsidemargin + \fi + \advance\oddsidemargin\Gm@bindingoffset + \addtolength\topmargin{-1\Gm@truedimen in}% + \ifGm@includehead + \addtolength\textheight{-\headheight}% + \addtolength\textheight{-\headsep}% + \else + \addtolength\topmargin{-\headheight}% + \addtolength\topmargin{-\headsep}% + \fi + \ifGm@includefoot + \addtolength\textheight{-\footskip}% + \fi + \ifGm@heightrounded + \setlength\@tempdima{\textheight}% + \addtolength\@tempdima{-\topskip}% + \@tempcnta\@tempdima + \@tempcntb\baselineskip + \divide\@tempcnta\@tempcntb + \setlength\@tempdimb{\baselineskip}% + \multiply\@tempdimb\@tempcnta + \advance\@tempdima-\@tempdimb + \multiply\@tempdima\tw@ + \ifdim\@tempdima>\baselineskip + \addtolength\@tempdimb{\baselineskip}% + \fi + \addtolength\@tempdimb{\topskip}% + \textheight\@tempdimb + \fi + \advance\oddsidemargin\Gm@layouthoffset% + \advance\evensidemargin\Gm@layouthoffset% + \advance\topmargin\Gm@layoutvoffset% + \addtolength\Gm@layoutwidth{\Gm@bindingoffset}% + }% end of \Gm@@process +\def\Gm@detectdriver{% + \ifx\Gm@driver\@empty + \typeout{*geometry* driver: auto-detecting}% + \ifpdf + \Gm@setdriver{pdftex}% + \else + \Gm@setdriver{dvips}% + \fi + \ifvtex + \Gm@setdriver{vtex}% + \fi + \ifxetex + \Gm@setdriver{xetex} + \fi + \else + \ifx\Gm@driver\Gm@xetex %% + \ifxetex\else + \Gm@warning{Wrong driver setting: `xetex'; trying `pdftex' driver}% + \Gm@setdriver{pdftex} + \fi + \fi + \ifx\Gm@driver\Gm@vtex + \ifvtex\else + \Gm@warning{Wrong driver setting: `vtex'; trying `dvips' driver}% + \Gm@setdriver{dvips}% + \fi + \fi + \fi + \ifx\Gm@driver\relax + \typeout{*geometry* detected driver: }% + \else + \typeout{*geometry* detected driver: \Gm@driver}% + \fi}% +\def\Gm@showparams#1{% + \ifGm@verbose\expandafter\typeout\else\expandafter\wlog\fi + {\Gm@logcontent{#1}}}% +\def\Gm@showdim#1{* \string#1=\the#1^^J}% +\def\Gm@showbool#1{\@nameuse{ifGm@#1}#1\space\fi}% +\def\Gm@logcontent#1{% + *geometry* verbose mode - [ #1 ] result:^^J% + \ifGm@pass * pass: disregarded the geometry package!^^J% + \else + * driver: \if\Gm@driver\else\Gm@driver\fi^^J% + * paper: \ifx\Gm@paper\@undefined\else\Gm@paper\fi^^J% + * layout: \ifGm@layout\else\fi^^J% + \ifGm@layout + * layout(width,height): (\the\Gm@layoutwidth,\the\Gm@layoutheight)^^J% + \fi + * layoutoffset:(h,v)=(\the\Gm@layouthoffset,\the\Gm@layoutvoffset)^^J% + \@ifundefined{Gm@lines}{}{* lines: \Gm@lines^^J}% + \@ifundefined{Gm@hmarginratio}{}{* hratio: \Gm@hmarginratio^^J}% + \@ifundefined{Gm@vmarginratio}{}{* vratio: \Gm@vmarginratio^^J}% + \ifdim\Gm@bindingoffset=\z@\else + * bindingoffset: \the\Gm@bindingoffset^^J\fi + * modes: % + \Gm@showbool{landscape}% + \Gm@showbool{includehead}% + \Gm@showbool{includefoot}% + \Gm@showbool{includemp}% + \if@twoside twoside\space\fi% + \if@mparswitch\else\if@twoside asymmetric\space\fi\fi% + \Gm@showbool{heightrounded}% + \ifx\Gm@truedimen\@empty\else truedimen\space\fi% + \Gm@showbool{showframe}% + \Gm@showbool{showcrop}% + ^^J% + * h-part:(L,W,R)=(\Gm@lmargin, \Gm@width, \Gm@rmargin)^^J% + * v-part:(T,H,B)=(\Gm@tmargin, \Gm@height, \Gm@bmargin)^^J% + \fi + \Gm@showdim{\paperwidth}% + \Gm@showdim{\paperheight}% + \Gm@showdim{\textwidth}% + \Gm@showdim{\textheight}% + \Gm@showdim{\oddsidemargin}% + \Gm@showdim{\evensidemargin}% + \Gm@showdim{\topmargin}% + \Gm@showdim{\headheight}% + \Gm@showdim{\headsep}% + \Gm@showdim{\topskip}% + \Gm@showdim{\footskip}% + \Gm@showdim{\marginparwidth}% + \Gm@showdim{\marginparsep}% + \Gm@showdim{\columnsep}% + * \string\skip\string\footins=\the\skip\footins^^J% + \Gm@showdim{\hoffset}% + \Gm@showdim{\voffset}% + \Gm@showdim{\mag}% + * \string\@twocolumn\if@twocolumn true\else false\fi^^J% + * \string\@twoside\if@twoside true\else false\fi^^J% + * \string\@mparswitch\if@mparswitch true\else false\fi^^J% + * \string\@reversemargin\if@reversemargin true\else false\fi^^J% + * (1in=72.27pt=25.4mm, 1cm=28.453pt)^^J}% +\def\Gm@cropmark(#1,#2,#3,#4){% + \begin{picture}(0,0) + \setlength\unitlength{1truemm}% + \linethickness{0.25pt}% + \put(#3,0){\line(#1,0){17}}% + \put(0,#4){\line(0,#2){17}}% + \end{picture}}% +\providecommand*\vb@xt@{\vbox to}% +\def\Gm@vrule{\vrule width 0.2pt height\textheight depth\z@}% +\def\Gm@hrule{\hrule height 0.2pt depth\z@ width\textwidth}% +\def\Gm@hruled{\hrule height\z@ depth0.2pt width\textwidth}% +\newcommand*{\Gm@vrules@mpi}{% + \hb@xt@\@tempdima{\llap{\Gm@vrule}\ignorespaces + \hskip \textwidth\Gm@vrule\hskip \marginparsep + \llap{\Gm@vrule}\hfil\Gm@vrule}}% +\newcommand*{\Gm@vrules@mpii}{% + \hb@xt@\@tempdima{\hskip-\marginparwidth\hskip-\marginparsep + \llap{\Gm@vrule}\ignorespaces + \hskip \marginparwidth\rlap{\Gm@vrule}\hskip \marginparsep + \llap{\Gm@vrule}\hskip\textwidth\rlap{\Gm@vrule}\hss}}% +\newcommand*{\Gm@pageframes}{% + \vb@xt@\z@{% + \ifGm@showcrop + \vb@xt@\z@{\vskip-1\Gm@truedimen in\vskip\Gm@layoutvoffset% + \hb@xt@\z@{\hskip-1\Gm@truedimen in\hskip\Gm@layouthoffset% + \vb@xt@\Gm@layoutheight{% + \let\protect\relax + \hb@xt@\Gm@layoutwidth{\Gm@cropmark(-1,1,-3,3)\hfil\Gm@cropmark(1,1,3,3)}% + \vfil + \hb@xt@\Gm@layoutwidth{\Gm@cropmark(-1,-1,-3,-3)\hfil\Gm@cropmark(1,-1,3,-3)}}% + \hss}% + \vss}% + \fi% + \ifGm@showframe + \if@twoside + \ifodd\count\z@ + \let\@themargin\oddsidemargin + \else + \let\@themargin\evensidemargin + \fi + \fi + \moveright\@themargin% + \vb@xt@\z@{% + \vskip\topmargin\vb@xt@\z@{\vss\Gm@hrule}% + \vskip\headheight\vb@xt@\z@{\vss\Gm@hruled}% + \vskip\headsep\vb@xt@\z@{\vss\Gm@hrule}% + \@tempdima\textwidth + \advance\@tempdima by \marginparsep + \advance\@tempdima by \marginparwidth + \if@mparswitch + \ifodd\count\z@ + \Gm@vrules@mpi + \else + \Gm@vrules@mpii + \fi + \else + \Gm@vrules@mpi + \fi + \vb@xt@\z@{\vss\Gm@hrule}% + \vskip\footskip\vb@xt@\z@{\vss\Gm@hruled}% + \vss}% + \fi% + }}% +\def\ProcessOptionsKV{\@ifnextchar[%] + {\@ProcessOptionsKV}{\@ProcessOptionsKV[]}}% +\def\@ProcessOptionsKV[#1]#2{% + \let\@tempa\@empty + \@tempcnta\z@ + \if#1p\@tempcnta\@ne\else\if#1c\@tempcnta\tw@\fi\fi + \ifodd\@tempcnta + \edef\@tempa{\@ptionlist{\@currname.\@currext}}% + \else + \@for\CurrentOption:=\@classoptionslist\do{% + \@ifundefined{KV@#2@\CurrentOption}% + {}{\edef\@tempa{\@tempa,\CurrentOption,}}}% + \ifnum\@tempcnta=\z@ + \edef\@tempa{\@tempa,\@ptionlist{\@currname.\@currext}}% + \fi + \fi + \edef\@tempa{\noexpand\setkeys{#2}{\@tempa}}% + \@tempa + \AtEndOfPackage{\let\@unprocessedoptions\relax}}% +\def\Gm@setkeys{\setkeys{Gm}}% +\def\Gm@processconfig{% + \let\Gm@origExecuteOptions\ExecuteOptions + \let\ExecuteOptions\Gm@setkeys + \InputIfFileExists{geometry.cfg}{}{} + \let\ExecuteOptions\Gm@origExecuteOptions}% +\Gm@save +\edef\Gm@restore@org{\Gm@restore}% +\Gm@initall +\Gm@processconfig +\ProcessOptionsKV[c]{Gm}% +\Gm@setdefaultpaper +\ProcessOptionsKV[p]{Gm}% +\Gm@process +\AtBeginDocument{% + \Gm@savelength{paperwidth}% + \Gm@savelength{paperheight}% + \edef\Gm@restore@org{\Gm@restore}% + \ifGm@resetpaper + \edef\Gm@pw{\Gm@orgpw}% + \edef\Gm@ph{\Gm@orgph}% + \else + \edef\Gm@pw{\the\paperwidth}% + \edef\Gm@ph{\the\paperheight}% + \fi + \ifGm@pass\else + \ifnum\mag=\@m\else + \Gm@magtooffset + \divide\paperwidth\@m + \multiply\paperwidth\the\mag + \divide\paperheight\@m + \multiply\paperheight\the\mag + \fi + \fi + \Gm@detectdriver + \ifx\Gm@driver\Gm@xetex + \@ifundefined{pdfpagewidth}{}{% + \setlength\pdfpagewidth{\Gm@pw}% + \setlength\pdfpageheight{\Gm@ph}}% + \ifnum\mag=\@m\else + \ifx\Gm@truedimen\Gm@true + \setlength\paperwidth{\Gm@pw}% + \setlength\paperheight{\Gm@ph}% + \fi + \fi + \fi + \ifx\Gm@driver\Gm@pdftex + \@ifundefined{pdfpagewidth}{}{% + \setlength\pdfpagewidth{\Gm@pw}% + \setlength\pdfpageheight{\Gm@ph}}% + \ifnum\mag=\@m\else + \@tempdima=\mag sp% + \@ifundefined{pdfhorigin}{}{% + \divide\pdfhorigin\@tempdima + \multiply\pdfhorigin\@m + \divide\pdfvorigin\@tempdima + \multiply\pdfvorigin\@m}% + \ifx\Gm@truedimen\Gm@true + \setlength\paperwidth{\Gm@pw}% + \setlength\paperheight{\Gm@ph}% + \fi + \fi + \fi + \ifx\Gm@driver\Gm@vtex + \@ifundefined{mediawidth}{}{% + \mediawidth=\paperwidth + \mediaheight=\paperheight}% + \ifvtexdvi + \AtBeginDvi{\special{papersize=\the\paperwidth,\the\paperheight}}% + \fi + \fi + \ifx\Gm@driver\Gm@dvips + \AtBeginDvi{\special{papersize=\the\paperwidth,\the\paperheight}}% + \ifx\Gm@driver\Gm@dvips\ifGm@landscape + \AtBeginDvi{\special{! /landplus90 true store}}% + \fi\fi + \else\ifx\Gm@driver\Gm@dvipdfm + \ifcase\ifx\AtBeginShipoutFirst\relax\@ne\else + \ifx\AtBeginShipoutFirst\@undefined\@ne\else\z@\fi\fi + \AtBeginShipoutFirst{\special{papersize=\the\paperwidth,\the\paperheight}}% + \or + \AtBeginDvi{\special{papersize=\the\paperwidth,\the\paperheight}}% + \fi + \fi\fi + \@tempswafalse + \ifGm@showframe + \@tempswatrue + \else\ifGm@showcrop + \@tempswatrue + \fi\fi + \if@tempswa + \RequirePackage{atbegshi}% + \AtBeginShipout{\setbox\AtBeginShipoutBox=\vbox{% + \baselineskip\z@skip\lineskip\z@skip\lineskiplimit\z@ + \Gm@pageframes\box\AtBeginShipoutBox}}% + \fi + \Gm@save + \edef\Gm@restore@pkg{\Gm@restore}% + \ifGm@verbose\ifGm@pass\else\Gm@checkmp\fi\fi + \Gm@showparams{preamble}% + \let\Gm@pw\relax + \let\Gm@ph\relax + }% end of \AtBeginDocument +\newcommand{\geometry}[1]{% + \Gm@clean + \setkeys{Gm}{#1}% + \Gm@process}% +\@onlypreamble\geometry +\DeclareRobustCommand\Gm@changelayout{% + \setlength{\@colht}{\textheight} + \setlength{\@colroom}{\textheight}% + \setlength{\vsize}{\textheight} + \setlength{\columnwidth}{\textwidth}% + \if@twocolumn% + \advance\columnwidth-\columnsep + \divide\columnwidth\tw@% + \@firstcolumntrue% + \fi% + \setlength{\hsize}{\columnwidth}% + \setlength{\linewidth}{\hsize}}% +\newcommand{\newgeometry}[1]{% + \clearpage + \Gm@restore@org + \Gm@initnewgm + \Gm@newgmtrue + \setkeys{Gm}{#1}% + \Gm@newgmfalse + \Gm@process + \ifnum\mag=\@m\else\Gm@magtooffset\fi + \Gm@changelayout + \Gm@showparams{newgeometry}}% +\newcommand{\restoregeometry}{% + \clearpage + \Gm@restore@pkg + \Gm@changelayout}% +\newcommand*{\savegeometry}[1]{% + \Gm@save + \expandafter\edef\csname Gm@restore@@#1\endcsname{\Gm@restore}}% +\newcommand*{\loadgeometry}[1]{% + \clearpage + \@ifundefined{Gm@restore@@#1}{% + \PackageError{geometry}{% + \string\loadgeometry : name `#1' undefined}{% + The name `#1' should be predefined with \string\savegeometry}% + }{\@nameuse{Gm@restore@@#1}% + \Gm@changelayout}}% +\endinput +%% +%% End of file `geometry.sty'. diff --git a/latex/noweb.sty b/latex/noweb.sty new file mode 100644 --- /dev/null +++ b/latex/noweb.sty @@ -0,0 +1,983 @@ +% Noweb is copyright 1989-2000 by Norman Ramsey. All rights reserved. +% +% Noweb is protected by copyright. It is not public-domain +% software or shareware, and it is not protected by a ``copyleft'' +% agreement like the one used by the Free Software Foundation. +% +% Noweb is available free for any use in any field of endeavor. You may +% redistribute noweb in whole or in part provided you acknowledge its +% source and include this COPYRIGHT file. You may modify noweb and +% create derived works, provided you retain this copyright notice, but +% the result may not be called noweb without my written consent. +% +% You may sell noweb if you wish. For example, you may sell a CD-ROM +% including noweb. +% +% You may sell a derived work, provided that all source code for your +% derived work is available, at no additional charge, to anyone who buys +% your derived work in any form. You must give permisson for said +% source code to be used and modified under the terms of this license. +% You must state clearly that your work uses or is based on noweb and +% that noweb is available free of change. You must also request that +% bug reports on your work be reported to you. +% +% noweb.sty -- LaTeX support for noweb +% DON'T read or edit this file! Use ...noweb-source/tex/support.nw instead. +{\obeyspaces\AtBeginDocument{\global\let =\ }} % from texbook, p 381 +\def\nwopt@nomargintag{\let\nwmargintag=\@gobble} +\def\nwopt@margintag{% + \def\nwmargintag##1{\leavevmode\llap{##1\kern\nwmarginglue\kern\codemargin}}} +\def\nwopt@margintag{% + \def\nwmargintag##1{\leavevmode\kern-\codemargin\nwthemargintag{##1}\kern\codemargin}} +\def\nwthemargintag#1{\llap{#1\kern\nwmarginglue}} +\nwopt@margintag +\newdimen\nwmarginglue +\nwmarginglue=0.3in +\def\nwtagstyle{\footnotesize\Rm} +% make \hsize in code sufficient for 88 columns +\setbox0=\hbox{\tt m} +\newdimen\codehsize +\codehsize=91\wd0 % 88 columns wasn't enough; I don't know why +\newdimen\codemargin +\codemargin=0pt +\newdimen\nwdefspace +\nwdefspace=\codehsize +% need to use \textwidth in {\LaTeX} to handle styles with +% non-standard margins (David Bruce). Don't know why we sometimes +% wanted \hsize. 27 August 1997. +%% \advance\nwdefspace by -\hsize\relax +\ifx\textwidth\undefined + \advance\nwdefspace by -\hsize\relax +\else + \advance\nwdefspace by -\textwidth\relax +\fi +\chardef\other=12 +\def\setupcode{% + \chardef\\=`\\ + \chardef\{=`\{ + \chardef\}=`\} + \catcode`\$=\other + \catcode`\&=\other + \catcode`\#=\other + \catcode`\%=\other + \catcode`\~=\other + \catcode`\_=\other + \catcode`\^=\other + \catcode`\"=\other % fixes problem with german.sty + \obeyspaces\Tt +} +%\let\nwlbrace=\{ +%\let\nwrbrace=\} +\def\nwendquote{\relax\ifhmode\spacefactor=1000 \fi} +{\catcode`\^^M=\active % make CR an active character + \gdef\newlines{\catcode`\^^M=\active % make CR an active character + \def^^M{\par\startline}}% + \gdef\eatline#1^^M{\relax}% +} +%%% DON'T \gdef^^M{\par\startline}}% in case ^^M appears in a \write +\def\startline{\noindent\hskip\parindent\ignorespaces} +\def\nwnewline{\ifvmode\else\hfil\break\leavevmode\hbox{}\fi} +\def\setupmodname{% + \catcode`\$=3 + \catcode`\&=4 + \catcode`\#=6 + \catcode`\%=14 + \catcode`\~=13 + \catcode`\_=8 + \catcode`\^=7 + \catcode`\ =10 + \catcode`\^^M=5 + \let\nwlbrace\lbrace + \let\nwrbrace\rbrace + \let\{\nwlbrace + \let\}\nwrbrace + % bad news --- don't know what catcode to give " + \Rm} +\def\LA{\begingroup\maybehbox\bgroup\setupmodname\It$\langle$} +\def\RA{\/$\rangle$\egroup\endgroup} +\def\code{\leavevmode\begingroup\setupcode\newlines} +\def\edoc{\endgroup} +\let\maybehbox\relax +\newbox\equivbox +\setbox\equivbox=\hbox{$\equiv$} +\newbox\plusequivbox +\setbox\plusequivbox=\hbox{$\mathord{+}\mathord{\equiv}$} +% \moddef can't have an argument because there might be \code...\edoc +\def\moddef{\leavevmode\kern-\codemargin\LA} +\def\endmoddef{\RA\ifmmode\equiv\else\unhcopy\equivbox\fi + \nobreak\hfill\nobreak} +\def\plusendmoddef{\RA\ifmmode\mathord{+}\mathord{\equiv}\else\unhcopy\plusequivbox\fi + \nobreak\hfill\nobreak} +\def\chunklist{% +\errhelp{I changed \chunklist to \nowebchunks. +I'll try to avoid such incompatible changes in the future.}% +\errmessage{Use \string\nowebchunks\space instead of \string\chunklist}} +\def\nowebchunks{\message{}} +\def\nowebindex{\message{}} +% here is support for the new-style (capitalized) font-changing commands +% thanks to Dave Love +\ifx\documentstyle\undefined + \let\Rm=\rm \let\It=\it \let\Tt=\tt % plain +\else\ifx\selectfont\undefined + \let\Rm=\rm \let\It=\it \let\Tt=\tt % LaTeX OFSS +\else % LaTeX NFSS + \def\Rm{\reset@font\rm} + \def\It{\reset@font\it} + \def\Tt{\reset@font\tt} + \def\Bf{\reset@font\bf} +\fi\fi +\ifx\reset@font\undefined \let\reset@font=\relax \fi +\def\noweboptions#1{% + \def\@nwoptionlist{#1}% + \@for\@nwoption:=\@nwoptionlist\do{% + \@ifundefined{nwopt@\@nwoption}{% + \@latexerr{There is no such noweb option as '\@nwoption'}\@eha}{% + \csname nwopt@\@nwoption\endcsname}}} +\codemargin=10pt +\advance\codehsize by \codemargin % make room for indentation of code +\advance\nwdefspace by \codemargin % and fix adjustment for def/use +\def\setcodemargin#1{% + \advance\codehsize by -\codemargin % make room for indentation of code + \advance\nwdefspace by -\codemargin % and fix adjustment for def/use + \codemargin=#1 + \advance\codehsize by \codemargin % make room for indentation of code + \advance\nwdefspace by \codemargin % and fix adjustment for + % def/use +} +\def\nwopt@shift{% + \dimen@=-0.8in + \if@twoside % Values for two-sided printing: + \advance\evensidemargin by \dimen@ + \else % Values for one-sided printing: + \advance\evensidemargin by \dimen@ + \advance\oddsidemargin by \dimen@ + \fi +% \advance \marginparwidth -\dimen@ +} +\let\nwopt@noshift\@empty +\def\nwbegincode#1{% + \begingroup + \topsep \nwcodetopsep + \@beginparpenalty \@highpenalty + \@endparpenalty -\@highpenalty + \@begincode } +\def\nwendcode{\endtrivlist \endgroup \filbreak} % keeps code on 1 page + +\newenvironment{webcode}{% + \@begincode +}{% + \endtrivlist} +\def\@begincode{% + \trivlist \item[]% + \leftskip\@totalleftmargin \advance\leftskip\codemargin + \rightskip\hsize \advance\rightskip -\codehsize + \parskip\z@ \parindent\z@ \parfillskip\@flushglue + \linewidth\codehsize + \@@par + \def\par{\leavevmode\null \@@par \penalty\nwcodepenalty}% + \obeylines + \@noligs \ifx\verbatim@nolig@list\undefined\else + \let\do=\nw@makeother \verbatim@nolig@list \do@noligs\` + \fi + \setupcode \frenchspacing \@vobeyspaces + \nowebsize \setupcode + \let\maybehbox\mbox } + \newskip\nwcodetopsep \nwcodetopsep = 3pt plus 1.2pt minus 1pt + \let\nowebsize=\normalsize + \def\nwopt@tinycode{\let\nowebsize=\tiny} + \def\nwopt@footnotesizecode{\let\nowebsize=\footnotesize} + \def\nwopt@scriptsizecode{\let\nowebsize=\scriptsize} + \def\nwopt@smallcode{\let\nowebsize=\small} + \def\nwopt@normalsizecode{\let\nowebsize=\normalsize} + \def\nwopt@largecode{\let\nowebsize=\large} + \def\nwopt@Largecode{\let\nowebsize=\Large} + \def\nwopt@LARGEcode{\let\nowebsize=\LARGE} + \def\nwopt@hugecode{\let\nowebsize=\huge} + \def\nwopt@Hugecode{\let\nowebsize=\Huge} +\newcount\nwcodepenalty \nwcodepenalty=\@highpenalty +\def\nw@makeother#1{\catcode`#1=12 } +\def\nwbegindocs#1{\ifvmode\noindent\fi} +\let\nwenddocs=\relax +\let\nwdocspar=\filbreak +\def\@nwsemifilbreak#1{\vskip0pt plus#1\penalty-200\vskip0pt plus -#1} +\newdimen\nwbreakcodespace +\nwbreakcodespace=0.2in % by default, leave no more than this on a page +\def\nwopt@breakcode{% + \def\nwdocspar{\@nwsemifilbreak{0.2in}}% + \def\nwendcode{\endtrivlist\endgroup} % ditches filbreak +} +\raggedbottom +\def\code{\leavevmode\begingroup\setupcode\@vobeyspaces\obeylines} +\let\edoc=\endgroup +\newdimen\@original@textwidth +\def\ps@noweb{% + \@original@textwidth=\textwidth + \let\@mkboth\@gobbletwo + \def\@oddfoot{}\def\@evenfoot{}% No feet. + \if@twoside % If two-sided printing. + \def\@evenhead{\hbox to \@original@textwidth{% + \Rm \thepage\qquad{\Tt\leftmark}\hfil\today}}% Left heading. + \def\@oddhead{\hbox to \@original@textwidth{% + \Rm \today\hfil{\Tt\leftmark}\qquad\thepage}}% Right heading. + \else % If one-sided printing. + \def\@oddhead{\hbox to \@original@textwidth{% + \Rm \today\hfil{\Tt\leftmark}\qquad\thepage}}% Right heading. + \let\@evenhead\@oddhead + \fi + \let\chaptermark\@gobble + \let\sectionmark\@gobble + \let\subsectionmark\@gobble + \let\subsubsectionmark\@gobble + \let\paragraphmark\@gobble + \let\subparagraphmark\@gobble + \def\nwfilename{\begingroup\let\do\@makeother\dospecials + \catcode`\{=1 \catcode`\}=2 \nw@filename} + \def\nw@filename##1{\endgroup\markboth{##1}{##1}\let\nw@filename=\nw@laterfilename}% +} +\def\nw@laterfilename#1{\endgroup\clearpage \markboth{#1}{#1}} +\let\nwfilename=\@gobble +\def\nwcodecomment#1{\@@par\penalty\nwcodepenalty + \if@firstnwcodecomment + \vskip\nwcodecommentsep\penalty\nwcodepenalty\@firstnwcodecommentfalse + \fi% + \hspace{-\codemargin}{% + \rightskip=0pt plus1in + \interlinepenalty\nwcodepenalty + \let\\\relax\footnotesize\Rm #1\@@par\penalty\nwcodepenalty}} +\def\@nwalsodefined#1{\nwcodecomment{\@nwlangdepdef\ \nwpageprep\ \@pagesl{#1}.}} +\def\@nwused#1{\nwcodecomment{\@nwlangdepcud\ \nwpageprep\ \@pagesl{#1}.}} +\def\@nwnotused#1{\nwcodecomment{\@nwlangdeprtc.}} +\def\nwoutput#1{\nwcodecomment{\@nwlangdepcwf\ {\Tt \@stripstar#1*\stripped}.}} +\def\@stripstar#1*#2\stripped{#1} +\newcommand{\nwprevdefptr}[1]{% + \mbox{$\mathord{\triangleleft}\,\mathord{\mbox{\subpageref{#1}}}$}} +\newcommand{\nwnextdefptr}[1]{% + \mbox{$\mathord{\mbox{\subpageref{#1}}}\,\mathord{\triangleright}$}} + +\newcommand{\@nwprevnextdefs}[2]{% + {\nwtagstyle + \ifx\relax#1\else ~~\nwprevdefptr{#1}\fi + \ifx\relax#2\else ~~\nwnextdefptr{#2}\fi}} +\newcommand{\@nwusesondefline}[1]{{\nwtagstyle~~(\@pagenumsl{#1})}} +\newcommand{\@nwstartdeflinemarkup}{\nobreak\hskip 1.5em plus 1fill\nobreak} +\newcommand{\@nwenddeflinemarkup}{\nobreak\hskip \nwdefspace minus\nwdefspace\nobreak} +\def\nwopt@longxref{% + \let\nwalsodefined\@nwalsodefined + \let\nwused\@nwused + \let\nwnotused\@nwnotused + \let\nwprevnextdefs\@gobbletwo + \let\nwusesondefline\@gobble + \let\nwstartdeflinemarkup\relax + \let\nwenddeflinemarkup\relax +} +\def\nwopt@shortxref{% + \let\nwalsodefined\@gobble + \let\nwused\@gobble + \let\nwnotused\@gobble + \let\nwprevnextdefs\@nwprevnextdefs + \let\nwusesondefline\@nwusesondefline + \let\nwstartdeflinemarkup\@nwstartdeflinemarkup + \let\nwenddeflinemarkup\@nwenddeflinemarkup +} +\def\nwopt@noxref{% + \let\nwalsodefined\@gobble + \let\nwused\@gobble + \let\nwnotused\@gobble + \let\nwprevnextdefs\@gobbletwo + \let\nwusesondefline\@gobble + \let\nwstartdeflinemarkup\relax + \let\nwenddeflinemarkup\relax +} +\nwopt@shortxref % to hell with backward compatibility! +\newskip\nwcodecommentsep \nwcodecommentsep=3pt plus 1pt minus 1pt +\newif\if@firstnwcodecomment\@firstnwcodecommenttrue +\newcount\@nwlopage\newcount\@nwhipage % range lo..hi-1 +\newcount\@nwlosub % subpage of lo +\newcount\@nwhisub % subpage of hi +\def\@nwfirstpage#1#2#3{% subpage page xref-tag + \@nwlopage=#2 \@nwlosub=#1 + \def\@nwloxreftag{#3}% + \advance\@nwpagecount by \@ne + \@nwhipage=\@nwlopage\advance\@nwhipage by \@ne } +\def\@nwnextpage#1#2#3{% subpage page xref-tag + \ifnum\@nwhipage=#2 + \advance\@nwhipage by \@ne + \advance\@nwpagecount by \@ne + \@nwhisub=#1 + \def\@nwhixreftag{#3}\else + \ifnum#2<\@nwlopage \advance\@nwhipage by \m@ne + \ifnum\@nwhipage=\@nwlopage + \edef\@tempa{\noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwlosub}{\number\@nwlopage}}% + {\@nwloxreftag}}}% + \else + \count@=\@nwhipage \advance\count@ by \m@ne + \ifnum\count@=\@nwlopage % consecutive pages + \edef\@tempa{\noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwlosub}{\number\@nwlopage}}% + {\@nwloxreftag}}% + \noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwhisub}{\number\@nwhipage}} + {\@nwhixreftag}}}% + \else \ifnum\@nwlopage<110 \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}\else + \count@=\@nwlopage \divide\count@ by 100 \multiply\count@ by 100 + \ifnum\count@=\@nwlopage \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}\else + \count@=\@nwlopage \divide\count@ by 100 + \@nwpagetemp=\@nwhipage \divide\@nwpagetemp by 100 + \ifnum\count@=\@nwpagetemp % lo--least 2 digits of hi + \multiply\@nwpagetemp by 100 + \advance \@nwhipage by -\@nwpagetemp + \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}% + \else \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}% + \fi + \fi + \fi% + \fi + \fi% + \edef\@tempa{\noexpand\nwix@cons\noexpand\nw@pages{\@tempa}}\@tempa\@nwfirstpage{#1}{#2}{#3}\else + \ifnum#2>\@nwhipage \advance\@nwhipage by \m@ne + \ifnum\@nwhipage=\@nwlopage + \edef\@tempa{\noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwlosub}{\number\@nwlopage}}% + {\@nwloxreftag}}}% + \else + \count@=\@nwhipage \advance\count@ by \m@ne + \ifnum\count@=\@nwlopage % consecutive pages + \edef\@tempa{\noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwlosub}{\number\@nwlopage}}% + {\@nwloxreftag}}% + \noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwhisub}{\number\@nwhipage}} + {\@nwhixreftag}}}% + \else \ifnum\@nwlopage<110 \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}\else + \count@=\@nwlopage \divide\count@ by 100 \multiply\count@ by 100 + \ifnum\count@=\@nwlopage \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}\else + \count@=\@nwlopage \divide\count@ by 100 + \@nwpagetemp=\@nwhipage \divide\@nwpagetemp by 100 + \ifnum\count@=\@nwpagetemp % lo--least 2 digits of hi + \multiply\@nwpagetemp by 100 + \advance \@nwhipage by -\@nwpagetemp + \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}% + \else \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}% + \fi + \fi + \fi% + \fi + \fi% + \edef\@tempa{\noexpand\nwix@cons\noexpand\nw@pages{\@tempa}}\@tempa\@nwfirstpage{#1}{#2}{#3}\else + \@nwlosub=0 \@nwhisub=0 + \fi\fi\fi + } +\newcount\@nwpagetemp +\newcount\@nwpagecount +\def\@nwfirstpagel#1{% label + \@ifundefined{r@#1}{\@warning{Reference `#1' on page \thepage \space undefined}% + \nwix@cons\nw@pages{\\{\bf ??}}}{% + \edef\@tempa{\noexpand\@nwfirstpage\subpagepair{#1}{#1}}\@tempa}} +\def\@nwnextpagel#1{% label + \@ifundefined{r@#1}{\@warning{Reference `#1' on page \thepage \space undefined}% + \nwix@cons\nw@pages{\\{\bf ??}}}{% + \edef\@tempa{\noexpand\@nwnextpage\subpagepair{#1}{#1}}\@tempa}} +\def\@pagesl#1{% list of labels + \gdef\nw@pages{}\@nwpagecount=0 + \def\\##1{\@nwfirstpagel{##1}\let\\=\@nwnextpagel}#1% + \advance\@nwhipage by \m@ne + \ifnum\@nwhipage=\@nwlopage + \edef\@tempa{\noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwlosub}{\number\@nwlopage}}% + {\@nwloxreftag}}}% + \else + \count@=\@nwhipage \advance\count@ by \m@ne + \ifnum\count@=\@nwlopage % consecutive pages + \edef\@tempa{\noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwlosub}{\number\@nwlopage}}% + {\@nwloxreftag}}% + \noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwhisub}{\number\@nwhipage}} + {\@nwhixreftag}}}% + \else \ifnum\@nwlopage<110 \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}\else + \count@=\@nwlopage \divide\count@ by 100 \multiply\count@ by 100 + \ifnum\count@=\@nwlopage \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}\else + \count@=\@nwlopage \divide\count@ by 100 + \@nwpagetemp=\@nwhipage \divide\@nwpagetemp by 100 + \ifnum\count@=\@nwpagetemp % lo--least 2 digits of hi + \multiply\@nwpagetemp by 100 + \advance \@nwhipage by -\@nwpagetemp + \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}% + \else \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}% + \fi + \fi + \fi% + \fi + \fi% + \edef\@tempa{\noexpand\nwix@cons\noexpand\nw@pages{\@tempa}}\@tempa\def\\##1{\@nwhyperpagenum##1}% + \ifnum\@nwpagecount=1 \nwpageword \else \nwpagesword\fi~\commafy{\nw@pages}} +\def\@nwhyperpagenum#1#2{\nwhyperreference{#2}{#1}} + +\def\@pagenumsl#1{% list of labels -- doesn't include word `pages', commas, or `and' + \gdef\nw@pages{}\@nwpagecount=0 + \def\\##1{\@nwfirstpagel{##1}\let\\=\@nwnextpagel}#1% + \advance\@nwhipage by \m@ne + \ifnum\@nwhipage=\@nwlopage + \edef\@tempa{\noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwlosub}{\number\@nwlopage}}% + {\@nwloxreftag}}}% + \else + \count@=\@nwhipage \advance\count@ by \m@ne + \ifnum\count@=\@nwlopage % consecutive pages + \edef\@tempa{\noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwlosub}{\number\@nwlopage}}% + {\@nwloxreftag}}% + \noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwhisub}{\number\@nwhipage}} + {\@nwhixreftag}}}% + \else \ifnum\@nwlopage<110 \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}\else + \count@=\@nwlopage \divide\count@ by 100 \multiply\count@ by 100 + \ifnum\count@=\@nwlopage \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}\else + \count@=\@nwlopage \divide\count@ by 100 + \@nwpagetemp=\@nwhipage \divide\@nwpagetemp by 100 + \ifnum\count@=\@nwpagetemp % lo--least 2 digits of hi + \multiply\@nwpagetemp by 100 + \advance \@nwhipage by -\@nwpagetemp + \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}% + \else \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}% + \fi + \fi + \fi% + \fi + \fi% + \edef\@tempa{\noexpand\nwix@cons\noexpand\nw@pages{\@tempa}}\@tempa% + \def\\##1{\@nwhyperpagenum##1\let\\=\@nwpagenumslrest}\nw@pages} +\def\@nwpagenumslrest#1{~\@nwhyperpagenum#1} +\def\subpages#1{% list of {{subpage}{page}} + \gdef\nw@pages{}\@nwpagecount=0 + \def\\##1{\edef\@tempa{\noexpand\@nwfirstpage##1{}}\@tempa + \def\\####1{\edef\@tempa{\noexpand\@nwnextpage####1}\@tempa}}#1% + \advance\@nwhipage by \m@ne + \ifnum\@nwhipage=\@nwlopage + \edef\@tempa{\noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwlosub}{\number\@nwlopage}}% + {\@nwloxreftag}}}% + \else + \count@=\@nwhipage \advance\count@ by \m@ne + \ifnum\count@=\@nwlopage % consecutive pages + \edef\@tempa{\noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwlosub}{\number\@nwlopage}}% + {\@nwloxreftag}}% + \noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwhisub}{\number\@nwhipage}} + {\@nwhixreftag}}}% + \else \ifnum\@nwlopage<110 \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}\else + \count@=\@nwlopage \divide\count@ by 100 \multiply\count@ by 100 + \ifnum\count@=\@nwlopage \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}\else + \count@=\@nwlopage \divide\count@ by 100 + \@nwpagetemp=\@nwhipage \divide\@nwpagetemp by 100 + \ifnum\count@=\@nwpagetemp % lo--least 2 digits of hi + \multiply\@nwpagetemp by 100 + \advance \@nwhipage by -\@nwpagetemp + \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}% + \else \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}% + \fi + \fi + \fi% + \fi + \fi% + \edef\@tempa{\noexpand\nwix@cons\noexpand\nw@pages{\@tempa}}\@tempa\def\\##1{\@firstoftwo##1}% + \ifnum\@nwpagecount=1 \nwpageword \else \nwpagesword\fi~\commafy{\nw@pages}} +\def\@nwaddrange{\advance\@nwhipage by \m@ne + \ifnum\@nwhipage=\@nwlopage + \edef\@tempa{\noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwlosub}{\number\@nwlopage}}% + {\@nwloxreftag}}}% + \else + \count@=\@nwhipage \advance\count@ by \m@ne + \ifnum\count@=\@nwlopage % consecutive pages + \edef\@tempa{\noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwlosub}{\number\@nwlopage}}% + {\@nwloxreftag}}% + \noexpand\noexpand\noexpand\\% + {{\nwthepagenum{\number\@nwhisub}{\number\@nwhipage}} + {\@nwhixreftag}}}% + \else \ifnum\@nwlopage<110 \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}\else + \count@=\@nwlopage \divide\count@ by 100 \multiply\count@ by 100 + \ifnum\count@=\@nwlopage \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}\else + \count@=\@nwlopage \divide\count@ by 100 + \@nwpagetemp=\@nwhipage \divide\@nwpagetemp by 100 + \ifnum\count@=\@nwpagetemp % lo--least 2 digits of hi + \multiply\@nwpagetemp by 100 + \advance \@nwhipage by -\@nwpagetemp + \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}% + \else \edef\@tempa{\noexpand\noexpand\noexpand\\{{\number\@nwlopage--\number\@nwhipage}{}}}% + \fi + \fi + \fi% + \fi + \fi% + \edef\@tempa{\noexpand\nwix@cons\noexpand\nw@pages{\@tempa}}\@tempa} +\def\nwpageword{\@nwlangdepchk} % chunk, was page +\def\nwpagesword{\@nwlangdepchks} % chunk, was page +\def\nwpageprep{\@nwlangdepin} % in, was on +\newcommand\nw@genericref[2]{% what to do, name of ref + \expandafter\nw@g@nericref\csname r@#2\endcsname#1{#2}} +\newcommand\nw@g@nericref[3]{% control sequence, what to do, name + \ifx#1\relax + \ref{#3}% trigger the standard `undefined ref' mechanisms + \else + \expandafter#2#1.\\% + \fi} +\def\nw@selectone#1#2#3\\{#1} +\def\nw@selecttwo#1#2#3\\{#2} +\def\nw@selectonetwo#1#2#3\\{{#1}{#2}} +\newcommand{\subpageref}[1]{% + \nwhyperreference{#1}{\nw@genericref\@subpageref{#1}}} +\def\@subpageref#1#2#3\\{% + \@ifundefined{2on#2}{#2}{\nwthepagenum{#1}{#2}}} +\newcommand{\subpagepair}[1]{% % produces {subpage}{page} + \@ifundefined{r@#1}% + {{0}{0}}% + {\nw@genericref\@subpagepair{#1}}} +\def\@subpagepair#1#2#3\\{% + \@ifundefined{2on#2}{{0}{#2}}{{#1}{#2}}} +\newcommand{\sublabel}[1]{% + \leavevmode % needed to make \@bsphack work + \@bsphack + \nwblindhyperanchor{#1}% + \if@filesw {\let\thepage\relax + \def\protect{\noexpand\noexpand\noexpand}% + \edef\@tempa{\write\@auxout{\string + \newsublabel{#1}{{}{\thepage}}}}% + \expandafter}\@tempa + \if@nobreak \ifvmode\nobreak\fi\fi\fi\@esphack} +\newcommand{\nosublabel}[1]{% + \@bsphack\if@filesw {\let\thepage\relax + \def\protect{\noexpand\noexpand\noexpand}% + \edef\@tempa{\write\@auxout{\string + \newlabel{#1}{{0}{\thepage}}}}% + \expandafter}\@tempa + \if@nobreak \ifvmode\nobreak\fi\fi\fi\@esphack} +\newcommand\newsublabel{% + \nw@settrailers + \global\let\newsublabel\@newsublabel + \@newsublabel} +\newcommand{\@newsublabel}[2]{% + \edef\this@page{\@cdr#2\@nil}% + \ifx\this@page\last@page\else + \sub@page=\z@ + \fi + \edef\last@page{\this@page} + \advance\sub@page by \@ne + \ifnum\sub@page=\tw@ + \global\@namedef{2on\this@page}{}% + \fi + \pendingsublabel{#1}% + \edef\@tempa##1{\noexpand\newlabel{##1}% + {{\number\sub@page}{\this@page}\nw@labeltrailers}}% + \pending@sublabels + \def\pending@sublabels{}} +\newcommand\nw@settrailers{% -- won't work on first run + \@ifpackageloaded{nameref}% + {\gdef\nw@labeltrailers{{}{}{}}}% + {\gdef\nw@labeltrailers{}}} +\renewcommand\nw@settrailers{% + \@ifundefined{@secondoffive}% + {\gdef\nw@labeltrailers{}}% + {\gdef\nw@labeltrailers{{}{}{}}}} +\newcommand{\nextchunklabel}[1]{% + \nwblindhyperanchor{#1}% % looks slightly bogus --- nr + \@bsphack\if@filesw {\let\thepage\relax + \edef\@tempa{\write\@auxout{\string\pendingsublabel{#1}}}% + \expandafter}\@tempa + \if@nobreak \ifvmode\nobreak\fi\fi\fi\@esphack} +\newcommand\pendingsublabel[1]{% + \def\@tempa{\noexpand\@tempa}% + \edef\pending@sublabels{\noexpand\@tempa{#1}\pending@sublabels}} +\def\pending@sublabels{} +\def\last@page{\relax} +\newcount\sub@page +\def\@alphasubpagenum#1#2{#2\ifnum#1=0 \else\@alph{#1}\fi} +\def\@nosubpagenum#1#2{#2} +\def\@numsubpagenum#1#2{#2\ifnum#1=0 \else.\@arabic{#1}\fi} +\def\nwopt@nosubpage{\let\nwthepagenum=\@nosubpagenum\nwopt@nomargintag} +\def\nwopt@numsubpage{\let\nwthepagenum=\@numsubpagenum} +\def\nwopt@alphasubpage{\let\nwthepagenum=\@alphasubpagenum} +\nwopt@alphasubpage +\newcount\@nwalph@n +\let\@nwalph@d\@tempcnta +\let\@nwalph@bound\@tempcntb +\def\@nwlongalph#1{{% + \@nwalph@n=#1\advance\@nwalph@n by-1 + \@nwalph@bound=26 + \loop\ifnum\@nwalph@n<\@nwalph@bound\else + \advance\@nwalph@n by -\@nwalph@bound + \multiply\@nwalph@bound by 26 + \repeat + \loop\ifnum\@nwalph@bound>1 + \divide\@nwalph@bound by 26 + \@nwalph@d=\@nwalph@n\divide\@nwalph@d by \@nwalph@bound + % d := d * bound ; n -:= d; d := d / bound --- saves a temporary + \multiply\@nwalph@d by \@nwalph@bound + \advance\@nwalph@n by -\@nwalph@d + \divide\@nwalph@d by \@nwalph@bound + \advance\@nwalph@d by 1 \@alph{\@nwalph@d}% + \repeat +}} +\newcount\nw@chunkcount +\nw@chunkcount=\@ne +\newcommand{\weblabel}[1]{% + \@bsphack + \nwblindhyperanchor{#1}% + \if@filesw {\let\thepage\relax + \def\protect{\noexpand\noexpand\noexpand}% + \edef\@tempa{\write\@auxout{\string + \newsublabel{#1}{{}{\number\nw@chunkcount}}}}% + \expandafter}\@tempa + \global\advance\nw@chunkcount by \@ne + \if@nobreak \ifvmode\nobreak\fi\fi\fi\@esphack} +\def\nwopt@webnumbering{% + \let\sublabel=\weblabel + \def\nwpageword{chunk}\def\nwpagesword{chunks}% + \def\nwpageprep{in}} +% \nwindexdefn{printable name}{identifying label}{label of chunk} +% \nwindexuse{printable name}{identifying label}{label of chunk} + +\def\nwindexdefn#1#2#3{\@auxix{\protect\nwixd}{#2}{#3}} +\def\nwindexuse#1#2#3{\@auxix{\protect\nwixu}{#2}{#3}} + +\def\@auxix#1#2#3{% {marker}{id label}{subpage label} + \@bsphack\if@filesw {\let\nwixd\relax\let\nwixu\relax + \def\protect{\noexpand\noexpand\noexpand}% + \edef\@tempa{\write\@auxout{\string\nwixadd{#1}{#2}{#3}}}% + \expandafter}\@tempa + \if@nobreak \ifvmode\nobreak\fi\fi\fi\@esphack} +% \nwixadd{marker}{idlabel}{subpage label} +\def\nwixadd#1#2#3{% + \@ifundefined{nwixl@#2}% + {\global\@namedef{nwixl@#2}{#1{#3}}}% + {\expandafter\nwix@cons\csname nwixl@#2\endcsname{#1{#3}}}} +\def\@nwsubscriptident#1#2{\mbox{$\mbox{#1}_{\mathrm{\subpageref{#2}}}$}} +\def\@nwnosubscriptident#1#2{#1} +\def\@nwhyperident#1#2{\leavevmode\nwhyperreference{#2}{#1}} +\def\nwopt@subscriptidents{% + \let\nwlinkedidentq\@nwsubscriptident + \let\nwlinkedidentc\@nwsubscriptident +} +\def\nwopt@nosubscriptidents{% + \let\nwlinkedidentq\@nwnosubscriptident + \let\nwlinkedidentc\@nwnosubscriptident +} +\def\nwopt@hyperidents{% + \let\nwlinkedidentq\@nwhyperident + \let\nwlinkedidentc\@nwhyperident +} +\def\nwopt@nohyperidents{% + \let\nwlinkedidentq\@nwnosubscriptident + \let\nwlinkedidentc\@nwnosubscriptident +} +\def\nwopt@subscriptquotedidents{% + \let\nwlinkedidentq\@nwsubscriptident +} +\def\nwopt@nosubscriptquotedidents{% + \let\nwlinkedidentq\@nwnosubscriptident +} +\def\nwopt@hyperquotedidents{% + \let\nwlinkedidentq\@nwhyperident +} +\def\nwopt@nohyperquotedidents{% + \let\nwlinkedidentq\@nwnosubscriptident +} +\nwopt@hyperidents +\newcount\@commacount +\def\commafy#1{% + {\nwix@listcount{#1}\@commacount=\nwix@counter + \let\@comma@each=\\% + \ifcase\@commacount\let\\=\@comma@each\or\let\\=\@comma@each\or + \def\\{\def\\{ \@nwlangdepand\ \@comma@each}\@comma@each}\else + \def\\{\def\\{, % + \advance\@commacount by \m@ne + \ifnum\@commacount=1 \@nwlangdepand~\fi\@comma@each}\@comma@each}\fi + #1}} +\def\nwix@cons#1#2{% {list}{\marker{element}} + {\toks0=\expandafter{#1}\def\@tempa{#2}\toks2=\expandafter{\@tempa}% + \xdef#1{\the\toks0 \the\toks2 }}} +\def\nwix@uses#1{% {label} + \def\nwixu{\\}\let\nwixd\@gobble\@nameuse{nwixl@#1}} +\def\nwix@defs#1{% {label} + \def\nwixd{\\}\let\nwixu\@gobble\@nameuse{nwixl@#1}} +\newcount\nwix@counter +\def\nwix@listcount#1{% {list with \\} + {\count@=0 + \def\\##1{\advance\count@ by \@ne }% + #1\global\nwix@counter=\count@ }} +\def\nwix@usecount#1{\nwix@listcount{\nwix@uses{#1}}} +\def\nwix@defcount#1{\nwix@listcount{\nwix@defs{#1}}} +\def\nwix@id@defs#1{% index pair + {{\Tt \@car#1\@nil}% + \def\\##1{\nwix@defs@space\subpageref{##1}}\nwix@defs{\@cdr#1\@nil}}} + % useful above to change ~ into something that can break +% this option is undocumented because I think breakdefs is always right +\def\nwopt@breakdefs{\def\nwix@defs@space{\penalty200\ }} +\def\nwopt@nobreakdefs{\def\nwix@defs@space{~}} % old code +\nwopt@breakdefs +\def\nwidentuses#1{% list of index pairs + \nwcodecomment{\@nwlangdepuss\ \let\\=\nwix@id@defs\commafy{#1}.}} +\def\nwix@totaluses#1{% list of index pairs + {\count@=0 + \def\\##1{\nwix@usecount{\@cdr##1\@nil}\advance\count@ by\nwix@counter}% + #1\global\nwix@counter\count@ }} +\def\nwix@id@uses#1#2{% {ident}{label} + \nwix@usecount{#2}\ifnum\nwix@counter>0 + {\advance\leftskip by \codemargin + \nwcodecomment{{\Tt #1}, \@nwlangdepusd\ \nwpageprep\ \@pagesl{\nwix@uses{#2}}.}}% + \else + \ifnw@hideunuseddefs\else + {\advance\leftskip by \codemargin \nwcodecomment{{\Tt #1}, \@nwlangdepnvu.}}% + \fi + \fi} +\def\nwidentdefs#1{% list of index pairs + \ifnw@hideunuseddefs\nwix@totaluses{#1}\else\nwix@listcount{#1}\fi + \ifnum\nwix@counter>0 + \nwcodecomment{\@nwlangdepdfs:}% + {\def\\##1{\nwix@id@uses ##1}#1}% + \fi} +\newif\ifnw@hideunuseddefs\nw@hideunuseddefsfalse +\def\nwopt@hideunuseddefs{\nw@hideunuseddefstrue} +\def\nwopt@noidentxref{% + \let\nwidentdefs\@gobble + \let\nwidentuses\@gobble} +\def\nw@underlinedefs{% {list with \nwixd, \nwixu} + \let\\=\relax\def\nw@comma{, } + \def\nwixd##1{\\\underline{\subpageref{##1}}\let\\\nw@comma}% + \def\nwixu##1{\\\subpageref{##1}\let\\\nw@comma}} + +\def\nw@indexline#1#2{% + {\indent {\Tt #1}: \nw@underlinedefs\@nameuse{nwixl@#2}\par}} + +\newenvironment{thenowebindex}{\parindent=-10pt \parskip=\z@ + \advance\leftskip by 10pt + \advance\rightskip by 0pt plus1in\par\@afterindenttrue + \def\\##1{\nw@indexline##1}}{} +\def\nowebindex{% + \@ifundefined{nwixs@i}% + {\@warning{The \string\nowebindex\space is empty}}% + {\begin{thenowebindex}\@nameuse{nwixs@i}\end{thenowebindex}}} +\def\nowebindex@external{% + {\let\nwixadds@c=\@gobble + \def\nwixadds@i##1{\nw@indexline##1}% + \def\nwixaddsx##1##2{\@nameuse{nwixadds@##1}{##2}}% + \begin{thenowebindex}\@input{\jobname.nwi}\end{thenowebindex}}} +\def\nwixlogsorted#1#2{% list data + \@bsphack\if@filesw + \toks0={#2}\immediate\write\@auxout{\string\nwixadds{#1}{\the\toks0}} + \if@nobreak \ifvmode\nobreak\fi\fi\fi\@esphack} +\def\nwixadds#1#2{% + \@ifundefined{nwixs@#1}% + {\global\@namedef{nwixs@#1}{\\{#2}}}% + {\expandafter\nwix@cons\csname nwixs@#1\endcsname{\\{#2}}}} +\let\nwixaddsx=\@gobbletwo +\def\nwopt@externalindex{% + \ifx\nwixadds\@gobbletwo % already called + \else + \let\nwixaddsx=\nwixadds \let\nwixadds=\@gobbletwo + \let\nowebindex=\nowebindex@external + \let\nowebchunks=\nowebchunks@external + \fi} +\def\nowebchunks{% + \@ifundefined{nwixs@c}% + {\@warning{The are no \string\nowebchunks}}% + {\begin{thenowebchunks}\@nameuse{nwixs@c}\end{thenowebchunks}}} +\def\nowebchunks@external{% + {\let\nwixadds@i=\@gobble + \def\nwixadds@c##1{\nw@onechunk##1}% + \def\nwixaddsx##1##2{\@nameuse{nwixadds@##1}{##2}}% + \begin{thenowebchunks}\@input{\jobname.nwi}\end{thenowebchunks}}} + \@namedef{r@nw@notdef}{{0}{(\@nwlangdepnvd)}} +\def\nw@chunkunderlinedefs{% {list of labels with \nwixd, \nwixu} + \let\\=\relax\def\nw@comma{, } + \def\nwixd##1{\\\underline{\subpageref{##1}}\let\\\nw@comma}% + \def\nwixu##1{\\\subpageref{##1}\let\\\nw@comma}} +\def\nw@onechunk#1#2#3{% {name}{label of first definition}{list with \nwixd, \nwixu} + \@ifundefined{r@#2}{}{% + \indent\LA #1~{\nwtagstyle\subpageref{#2}}\RA + \if@nwlongchunks{~\nw@chunkunderlinedefs#3}\fi\par}} +\newenvironment{thenowebchunks}{\vskip3pt + \parskip=\z@\parindent=-10pt \advance\leftskip by 10pt + \advance\rightskip by 0pt plus10pt \@afterindenttrue + \def\\##1{\nw@onechunk##1}}{} +\newif\if@nwlongchunks +\@nwlongchunksfalse +\let\nwopt@longchunks\@nwlongchunkstrue +\newcommand\@nw@hyper@ref{\hyperreference} % naras +\newcommand\@nw@hyper@anc{\blindhyperanchor} % naras +\newcommand\@nw@hyperref@ref[2]{\hyperlink{noweb.#1}{#2}} % nr +\newcommand\@nw@hyperref@anc[1]{\hypertarget{noweb.#1}{\relax}} % nr +%%\renewcommand\@nw@hyperref@ref[2]{{#2}} % nr +%%\renewcommand\@nw@hyperref@anc[1]{} % nr +\newcommand\nwhyperreference{% + \@ifundefined{hyperlink} + {\@ifundefined{hyperreference} + {\global\let\nwhyperreference\@gobble} + {\global\let\nwhyperreference\@nw@hyper@ref}} + {\global\let\nwhyperreference\@nw@hyperref@ref}% + \nwhyperreference +} + +\newcommand\nwblindhyperanchor{% + \@ifundefined{hyperlink} + {\@ifundefined{hyperreference} + {\global\let\nwblindhyperanchor\@gobble} + {\global\let\nwblindhyperanchor\@nw@hyper@anc}} + {\global\let\nwblindhyperanchor\@nw@hyperref@anc}% + \nwblindhyperanchor +} +\newcommand\nwanchorto{% + \begingroup\let\do\@makeother\dospecials + \catcode`\{=1 \catcode`\}=2 \nw@anchorto} +\newcommand\nw@anchorto[1]{\endgroup\def\nw@next{#1}\nw@anchortofin} +\newcommand\nw@anchortofin[1]{#1\footnote{See URL \texttt{\nw@next}.}} +\let\nwanchorname\@gobble +\newif\ifhtml +\htmlfalse +\let\nwixident=\relax +\def\nwbackslash{\char92} +\def\nwlbrace{\char123} +\def\nwrbrace{\char125} +\def\nwopt@english{% + \def\@nwlangdepdef{This definition is continued}% + \def\@nwlangdepcud{This code is used}% + \def\@nwlangdeprtc{Root chunk (not used in this document)}% + \def\@nwlangdepcwf{This code is written to file}% + \def\@nwlangdepchk{chunk}% + \def\@nwlangdepchks{chunks}% + \def\@nwlangdepin{in}% + \def\@nwlangdepand{and}% + \def\@nwlangdepuss{Uses}% + \def\@nwlangdepusd{used}% + \def\@nwlangdepnvu{never used}% + \def\@nwlangdepdfs{Defines}% + \def\@nwlangdepnvd{never defined}% +} +\let\nwopt@american\nwopt@english +\def\nwopt@portuges{% + \def\@nwlangdepdef{Defini\c{c}\~ao continuada em}% + % This definition is continued + \def\@nwlangdepcud{C\'odigo usado em}% + % This code is used + \def\@nwlangdeprtc{Fragmento de topo (sem uso no documento)}% + % Root chunk (not used in this document) + \def\@nwlangdepcwf{Este c\'odigo foi escrito no ficheiro}% + % This code is written to file + \def\@nwlangdepchk{fragmento}% + % chunk + \def\@nwlangdepchks{fragmentos}% + % chunks + \def\@nwlangdepin{no(s)}% + % in + \def\@nwlangdepand{e}% + % and + \def\@nwlangdepuss{Usa}% + % Uses + \def\@nwlangdepusd{usado}% + % used + \def\@nwlangdepnvu{nunca usado}% + % never used + \def\@nwlangdepdfs{Define}% + % Defines + \def\@nwlangdepnvd{nunca definido}% + % never defined +} +\def\nwopt@frenchb{% + \def\@nwlangdepdef{Suite de la d\'efinition}% + % This definition is continued + \def\@nwlangdepcud{Ce code est employ\'e}% + % This code is used + \def\@nwlangdeprtc{Morceau racine (pas employ\'e dans ce document)}% + % Root chunk (not used in this document) + \def\@nwlangdepcwf{Ce code est \'ecrit dans le fichier}% + % This code is written to file + \def\@nwlangdepchk{le morceau}% + % chunk + \def\@nwlangdepchks{les morceaux}% + % chunks + \def\@nwlangdepin{dans}% + % in + \def\@nwlangdepand{et}% + % and + \def\@nwlangdepuss{Utilise}% + % Uses + \def\@nwlangdepusd{utilis\'{e}}% + % used + \def\@nwlangdepnvu{jamais employ\'{e}}% + % never used + \def\@nwlangdepdfs{D\'{e}finit}% + % Defines + % Cannot use the accent here: \def\@nwlangdepnvd{jamais d\'{e}fini}% + \def\@nwlangdepnvd{jamais defini}% + % never defined +} +\let\nwopt@french\nwopt@frenchb +\def\nwopt@german{% + \def\@nwlangdepdef{Diese Definition wird fortgesetzt}% + % This definition is continued + \def\@nwlangdepcud{Dieser Code wird benutzt}% + % This code is used + \def\@nwlangdeprtc{Hauptteil (nicht in diesem Dokument benutzt)}% + % Root chunk (not used in this document) + %\def\@nwlangdepcwf{Dieser Code schreibt man zum File}% + \def\@nwlangdepcwf{Dieser Code geht in Datei}% + % This code is written to file + \def\@nwlangdepchk{dem Teil}% + % chunk + %\def\@nwlangdepchks{Teils}% + \def\@nwlangdepchks{den Teilen}% + % chunks + \def\@nwlangdepin{in}% + % in + \def\@nwlangdepand{und}% + % and + \def\@nwlangdepuss{Benutzt}% + % Uses + \def\@nwlangdepusd{benutzt}% + % used + \def\@nwlangdepnvu{nicht benutzt}% + % never used + \def\@nwlangdepdfs{Definiert}% + % Defines + \def\@nwlangdepnvd{nicht definiert}% + % never defined +} +\def\nwopt@german{% + \def\@nwlangdepdef{Diese Definition wird fortgesetzt}% + % This definition is continued + \def\@nwlangdepcud{Dieser Code wird benutzt}% + % This code is used + \def\@nwlangdeprtc{Hauptteil (nicht in diesem Dokument benutzt)}% + % Root chunk (not used in this document) + \def\@nwlangdepcwf{Dieser Code schreibt man zum File}% + % This code is written to file + \def\@nwlangdepchk{Teil}% + % chunk + \def\@nwlangdepchks{Teils}% + % chunks + \def\@nwlangdepin{im}% + % in + \def\@nwlangdepand{und}% + % and + \def\@nwlangdepuss{Benutzt}% + % Uses + \def\@nwlangdepusd{benutzt}% + % used + \def\@nwlangdepnvu{nicht benutzt}% + % never used + \def\@nwlangdepdfs{Definiert}% + % Defines + \def\@nwlangdepnvd{nicht definiert}% + % never defined +} +\let\nwopt@ngerman\nwopt@german +\ifx\languagename\undefined % default is English + \noweboptions{english} +\else + \@ifundefined{nwopt@\languagename} + {\noweboptions{english}} + {\expandafter\noweboptions\expandafter{\languagename}} +\fi diff --git a/license.txt b/license.txt new file mode 100644 --- /dev/null +++ b/license.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/scripts/common.bash b/scripts/common.bash new file mode 100644 --- /dev/null +++ b/scripts/common.bash @@ -0,0 +1,74 @@ +PATH="$PATH:$PWD/cabal-dev/bin/" + +VERSION=$(awk '/^version:/{print $2}' dbus-core.cabal) + +CABAL_DEV=$(which cabal-dev) +ANANSI=$(which anansi) +XELATEX=$(which xelatex) +INKSCAPE=$(which inkscape) +XZ=$(which xz) + +require_cabal_dev() +{ + if [ -z "$CABAL_DEV" ]; then + echo "Can't find 'cabal-dev' executable; make sure it exists on your "'$PATH' + echo "Cowardly refusing to fuck with the global package database" + exit 1 + fi +} + +require_anansi() +{ + if [ -z "$ANANSI" ]; then + echo "Can't find 'anansi' executable; running '$CABAL_DEV install anansi'" + require_cabal_dev + $CABAL_DEV install anansi &> /dev/null + if [ "$?" -ne "0" ]; then + echo "Installation failed; please install Anansi manually somehow" + exit 1 + fi + ANANSI=$(which anansi) + echo "Success; anansi = $ANANSI" + fi +} + +require_xelatex() +{ + if [ -z "$XELATEX" ]; then + echo "Can't find 'xelatex' executable; make sure it exists on your "'$PATH' + exit 1 + fi +} + +require_inkscape() +{ + if [ -z "$INKSCAPE" ]; then + echo "Can't find 'inkscape' executable; make sure it exists on your "'$PATH' + exit 1 + fi +} + +make_pdf() +{ + require_anansi + require_xelatex + require_inkscape + + rm -f *.{aux,tex,idx,log,out,toc,pdf} + $ANANSI -w -l latex-noweb -o dbus-core.tex src/dbus-core.anansi || exit 1 + $INKSCAPE --export-eps=latex/figure_1.eps latex/figure_1.svg + $XELATEX dbus-core.tex > /dev/null || exit 1 + $XELATEX dbus-core.tex > /dev/null || exit 1 + rm -f *.{aux,tex,idx,log,out,toc} + mv dbus-core.pdf "dbus-core_$VERSION.pdf" +} + +clean_dev_install() +{ + require_anansi + require_cabal_dev + + rm -rf hs dist + $ANANSI -o hs src/dbus-core.anansi || exit 1 + $CABAL_DEV install || exit 1 +} diff --git a/scripts/dist b/scripts/dist new file mode 100644 --- /dev/null +++ b/scripts/dist @@ -0,0 +1,42 @@ +#!/bin/bash +if [ ! -f 'dbus-core.cabal' ]; then + echo -n "Can't find dbus-core.cabal; please run this script as" + echo -n " ./scripts/dist from within the dbus-core source" + echo " directory" + exit 1 +fi + +. scripts/common.bash + +require_anansi +require_cabal_dev + +echo "Building dist for dbus-core_$VERSION using $CABAL_DEV" + +rm -rf hs dist +$ANANSI --noline -o hs src/dbus-core.anansi || exit 1 +$CABAL_DEV configure || exit 1 +$CABAL_DEV build || exit 1 +$CABAL_DEV sdist || exit 1 + +mv "dist/dbus-core-$VERSION.tar.gz" "./dbus-core_$VERSION.tar.gz" +ln -f "./dbus-core_$VERSION.tar.gz" "./dbus-core-$VERSION.tar.gz" +if [ -n "$XZ" ]; then + gzip -dfc "dbus-core_$VERSION.tar.gz" > "dbus-core_$VERSION.tar" + xz -f -C sha256 -9 "dbus-core_$VERSION.tar" +fi + +if [ -n "$XELATEX" ]; then + make_pdf +fi + +echo "" +echo "============================================================" +if [ -n "$XELATEX" ]; then + echo " woven source : dbus-core_$VERSION.pdf" +fi +echo " source tarball (gz) : dbus-core_$VERSION.tar.gz" +if [ -n "$XZ" ]; then + echo " source archive (xz) : dbus-core_$VERSION.tar.xz" +fi +echo "============================================================" diff --git a/scripts/haddock b/scripts/haddock new file mode 100644 --- /dev/null +++ b/scripts/haddock @@ -0,0 +1,17 @@ +#!/bin/bash +if [ ! -f 'dbus-core.cabal' ]; then + echo -n "Can't find dbus-core.cabal; please run this script as" + echo -n " ./scripts/haddock from within the dbus-core source" + echo " directory" + exit 1 +fi + +. scripts/common.bash + +require_anansi +require_cabal_dev + +rm -rf hs dist +$ANANSI --noline -o hs src/dbus-core.anansi || exit 1 +$CABAL_DEV configure || exit 1 +$CABAL_DEV haddock || exit 1 diff --git a/scripts/latex b/scripts/latex new file mode 100644 --- /dev/null +++ b/scripts/latex @@ -0,0 +1,11 @@ +#!/bin/bash +if [ ! -f 'dbus-core.cabal' ]; then + echo -n "Can't find dbus-core.cabal; please run this script as" + echo -n " ./scripts/latex from within the dbus-core source" + echo " directory" + exit 1 +fi + +. scripts/common.bash + +make_pdf diff --git a/scripts/run-benchmarks b/scripts/run-benchmarks new file mode 100644 --- /dev/null +++ b/scripts/run-benchmarks @@ -0,0 +1,23 @@ +#!/bin/bash +if [ ! -f 'dbus-core.cabal' ]; then + echo -n "Can't find dbus-core.cabal; please run this script as" + echo -n " ./scripts/run-benchmarks from within the dbus-core source" + echo " directory" + exit 1 +fi + +. scripts/common.bash + +require_anansi +require_cabal_dev + +rm -rf hs dist +$ANANSI -o hs src/dbus-core.anansi || exit 1 +$CABAL_DEV install || exit 1 + +pushd benchmarks +rm -rf dist +$CABAL_DEV -s ../cabal-dev install || exit 1 +popd + +cabal-dev/bin/dbus-core_benchmarks $@ diff --git a/scripts/run-coverage b/scripts/run-coverage new file mode 100644 --- /dev/null +++ b/scripts/run-coverage @@ -0,0 +1,26 @@ +#!/bin/bash +if [ ! -f 'dbus-core.cabal' ]; then + echo -n "Can't find dbus-core .cabal; please run this script as" + echo -n " ./scripts/run-coverage from within the dbus-core source" + echo " directory" + exit 1 +fi + +. scripts/common.bash + +require_anansi +require_cabal_dev + +rm -rf hs dist +$ANANSI --noline -o hs src/dbus-core.anansi || exit 1 + +pushd tests +rm -rf dist +$CABAL_DEV -s ../cabal-dev install --flags="coverage" || exit 1 +popd + +rm dbus-core_tests.tix +cabal-dev/bin/dbus-core_tests + +hpc markup --srcdir=hs --srcdir=tests/ dbus-core_tests.tix --destdir=hpc-markup --exclude=Main +hpc report --srcdir=hs --srcdir=tests/ dbus-core_tests.tix --exclude=Main diff --git a/scripts/run-tests b/scripts/run-tests new file mode 100644 --- /dev/null +++ b/scripts/run-tests @@ -0,0 +1,23 @@ +#!/bin/bash +if [ ! -f 'dbus-core.cabal' ]; then + echo -n "Can't find dbus-core .cabal; please run this script as" + echo -n " ./scripts/run-tests from within the dbus-core source" + echo " directory" + exit 1 +fi + +. scripts/common.bash + +require_anansi +require_cabal_dev + +rm -rf hs dist +$ANANSI -o hs src/dbus-core.anansi || exit 1 +cabal-dev install || exit 1 + +pushd tests +rm -rf dist +$CABAL_DEV -s ../cabal-dev install || exit 1 +popd + +cabal-dev/bin/dbus-core_tests diff --git a/src/addresses.anansi b/src/addresses.anansi deleted file mode 100644 --- a/src/addresses.anansi +++ /dev/null @@ -1,207 +0,0 @@ -:# Copyright (C) 2009-2010 John Millikin -:# -:# 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 -:# 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 . - -\section{Addresses} - -:f DBus/Address.hs -|copyright| -|text extensions| -module DBus.Address - ( Address - , addressMethod - , addressParameters - , mkAddresses - , strAddress - ) where -|text imports| - -import Data.Char (ord, chr) -import qualified Data.Map as M -import Text.Printf (printf) -import qualified Text.ParserCombinators.Parsec as P -import Text.ParserCombinators.Parsec ((<|>)) -import DBus.Util (hexToInt, eitherToMaybe, void) -: - -\subsection{Address syntax} - -A bus address is in the format {\tt $method$:$key$=$value$,$key$=$value$...} -where the method may be empty and parameters are optional. An address's -parameter list, if present, may end with a comma. Addresses in environment -variables are separated by semicolons, and the full address list may end -in a semicolon. Multiple parameters may have the same key; in this case, -only the first parameter for each key will be stored. - -The bytes allowed in each component of the address are given by the following -chart, where each character is understood to be its ASCII value: - -\begin{table}[h] -\begin{center} -\begin{tabular}{ll} -\toprule -Component & Allowed Characters \\ -\midrule -Method & Any except {\tt `;'} and {\tt `:'} \\ -Param key & Any except {\tt `;'}, {\tt `,'}, and {\tt `='} \\ -Param value & {\tt `0'} to {\tt `9'} \\ - & {\tt `a'} to {\tt `z'} \\ - & {\tt `A'} to {\tt `Z'} \\ - & Any of: {\tt - \textunderscore{} / \textbackslash{} * . \%} \\ -\bottomrule -\end{tabular} -\end{center} -\end{table} - -In parameter values, any byte may be encoded by prepending the \% character -to its value in hexadecimal. \% is not allowed to appear unless it is -followed by two hexadecimal digits. Every other allowed byte is termed -an ``optionally encoded'' byte, and may appear unescaped in parameter -values. - -:f DBus/Address.hs -optionallyEncoded :: [Char] -optionallyEncoded = ['0'..'9'] ++ ['a'..'z'] ++ ['A'..'Z'] ++ "-_/\\*." -: - -The address simply stores its method and parameter map, with a custom -{\tt Show} instance to provide easier debugging. - -:f DBus/Address.hs -data Address = Address - { addressMethod :: Text - , addressParameters :: M.Map Text Text - } deriving (Eq) - -instance Show Address where - showsPrec d x = showParen (d> 10) $ - showString "Address " . shows (strAddress x) -: - -Parsing is straightforward; the input string is divided into addresses by -semicolons, then further by colons and commas. Parsing will fail if any -of the addresses in the input failed to parse. - -:f DBus/Address.hs -mkAddresses :: Text -> Maybe [Address] -mkAddresses s = eitherToMaybe . P.parse parser "" . TL.unpack $ s where - address = do - method <- P.many (P.noneOf ":;") - void (P.char ':') - params <- P.sepEndBy param (P.char ',') - return $ Address (TL.pack method) (M.fromList params) - - param = do - key <- P.many1 (P.noneOf "=;,") - void (P.char '=') - value <- P.many1 (encodedValue <|> unencodedValue) - return (TL.pack key, TL.pack value) - - parser = do - as <- P.sepEndBy1 address (P.char ';') - P.eof - return as - - unencodedValue = P.oneOf optionallyEncoded - encodedValue = do - void (P.char '%') - hex <- P.count 2 P.hexDigit - return . chr . hexToInt $ hex -: - -Converting an {\tt Address} back to a {\tt String} is just the reverse -operation. Note that because the original parameter order is not preserved, -the string produced might differ from the original input. - -:f DBus/Address.hs -strAddress :: Address -> Text -strAddress (Address t ps) = TL.concat [t, ":", ps'] where - ps' = TL.intercalate "," $ do - (k, v) <- M.toList ps - return $ TL.concat [k, "=", TL.concatMap encode v] - encode c | elem c optionallyEncoded = TL.singleton c - | otherwise = TL.pack $ printf "%%%02X" (ord c) -: - -:f Tests.hs -instance Arbitrary Address where - arbitrary = genAddress where - optional = ['0'..'9'] ++ ['a'..'z'] ++ ['A'..'Z'] ++ "-_/\\*." - methodChars = filter (flip notElem ":;") ['!'..'~'] - keyChars = filter (flip notElem "=;,") ['!'..'~'] - - genMethod = atLeast 0 $ elements methodChars - genParam = do - key <- genKey - value <- genValue - return . concat $ [key, "=", value] - - genKey = atLeast 1 $ elements keyChars - genValue = oneof [encodedValue, plainValue] - genHex = elements $ ['0'..'9'] ++ ['a'..'f'] ++ ['A'..'F'] - encodedValue = do - x1 <- genHex - x2 <- genHex - return ['%', x1, x2] - plainValue = atLeast 1 $ elements optional - - genParams = do - params <- atLeast 0 genParam - let params' = intercalate "," params - extraComma <- if null params - then return "" - else elements ["", ","] - return $ concat [params', extraComma] - - genAddress = do - m <- genMethod - params <- genParams - extraSemicolon <- elements ["", ";"] - let addrStr = concat [m, ":", params, extraSemicolon] - let Just [addr] = mkAddresses $ TL.pack addrStr - return addr -: - -:d test cases -, F.testGroup "Addresses" - [ testProperty "Address identity" - $ \x -> mkAddresses (strAddress x) == Just [x] - , testProperty "Multiple addresses" - $ \x y -> let - joined = TL.concat [strAddress x, ";", strAddress y] - in mkAddresses joined == Just [x, y] - , testProperty "Ignore trailing semicolon" - $ \x -> mkAddresses (TL.append (strAddress x) ";") == Just [x] - , testProperty "Ignore trailing comma" - $ \x -> let - hasParams = not . Map.null . addressParameters $ x - parsed = mkAddresses (TL.append (strAddress x) ",") - in hasParams ==> parsed == Just [x] - , F.testGroup "Valid addresses" - [ test "colon" $ isJust . mkAddresses $ ":" - , test "just scheme" $ isJust . mkAddresses $ "a:" - , test "param" $ isJust . mkAddresses $ "a:b=c" - , test "trailing semicolon" $ isJust . mkAddresses $ "a:;" - , test "two schemes" $ isJust . mkAddresses $ "a:;b:" - , test "trailing comma" $ isJust . mkAddresses $ "a:b=c," - ] - , F.testGroup "Invalid addresses" - [ test "empty" $ isNothing . mkAddresses $ "" - , test "no colon" $ isNothing . mkAddresses $ "a" - , test "no equals" $ isNothing . mkAddresses $ "a:b" - , test "no param" $ isNothing . mkAddresses $ "a:b=" - , test "no param" $ isNothing . mkAddresses $ "a:," - ] - ] -: diff --git a/src/api-docs.anansi b/src/api-docs.anansi --- a/src/api-docs.anansi +++ b/src/api-docs.anansi @@ -23,70 +23,103 @@ There's no real order to this section; it exists only because Haddock can't merge documentation from external files. -:d apidoc isAtomicType --- | \"Atomic\" types are any which can't contain any other types. Only --- atomic types may be used as dictionary keys. +:d apidoc DBus.Client.disconnect +-- | Stop a 'Client'#8217;s callback thread and close its underlying socket. : -:d apidoc typeCode --- | Every type has an associated type code; a textual representation of --- the type, useful for debugging. +:d apidoc DBus.Client.throwError +-- | Normally, any exceptions raised while executing a method will be +-- given the generic @\"org.freedesktop.DBus.Error.Failed\"@ name. +-- 'throwError' allows the programmer to specify an error name, and provide +-- additional information to the remote application. You may use this instead +-- of 'Control.Exception.throwIO' to abort a method call. : -:d apidoc Variant --- | 'Variant's may contain any other built-in D-Bus value. Besides --- representing native @VARIANT@ values, they allow type-safe storage and --- deconstruction of heterogeneous collections. +:d apidoc DBus.Client.Simple.AutoSignature +-- | Used to automatically generate method signatures for introspection +-- documents. To support automatic signatures, a method#8217;s parameters and +-- return value must all be instances of 'IsValue'. +-- +-- This class maps Haskell idioms to D‐Bus; it is therefore unable to +-- generate some signatures. In particular, it does not support methods +-- which accept/return a single structure, or single‐element structures. +-- It also cannot generate signatures for methods with parameters or return +-- values which are only instances of 'IsVariant'. For these cases, please +-- use 'DBus.Client.method'. +-- +-- To match common Haskell use, if the return value is a tuple, it will be +-- converted to a list of return values. : -:d apidoc variantType --- | Every variant is strongly-typed; that is, the type of its contained --- value is known at all times. This function retrieves that type, so that --- the correct cast can be used to retrieve the value. +:d apidoc DBus.Client.Simple.AutoReply +-- | Used to automatically generate a 'Reply' from a return value. See +-- 'AutoSignature' for some caveats about supported signatures. +-- +-- To match common Haskell use, if the return value is a tuple, it will be +-- converted to a list of return values. : -:d apidoc arrayType --- | This is the type contained within the array, not the type of the array --- itself. +:d apidoc DBus.Client.Simple.connectSession +-- | Connect to the bus specified in the environment variable +-- @DBUS_SESSION_BUS_ADDRESS@, which must be set. : -:d apidoc Connection --- | A 'Connection' is an opaque handle to an open D-Bus channel, with an --- internal state for maintaining the current message serial. +:d apidoc DBus.Client.Simple.connectStarter +-- | Connect to the bus specified in the environment variable +-- @DBUS_STARTER_ADDRESS@, which must be set. : -:d apidoc Transport +:d apidoc DBus.Client.Simple.connectSystem +-- | Connect to the bus specified in the environment variable +-- @DBUS_SYSTEM_BUS_ADDRESS@, or to +-- @unix:path=\/var\/run\/dbus\/system_bus_socket@ if @DBUS_SYSTEM_BUS_ADDRESS@ +-- is not set. +: + +:d apidoc DBus.Client.Simple.export +-- | Export the given functions under the given 'ObjectPath' and +-- 'InterfaceName'. The functions may accept/return any types that are +-- instances of 'IsValue'; see 'AutoSignature'. +-- +-- @ +--sayHello :: Text -> IO Text +--sayHello name = return ('Data.Text.concat' [\"Hello \", name, \"!\"]) +-- +--export client \"/hello_world\" +-- [ 'method' \"com.example.HelloWorld\" \"Hello\" sayHello +-- ] +-- @ +: + +:d apidoc DBus.Client.Simple.method +-- | Prepare a Haskell function for export. This automatically detects the +-- function#8217;s type signature; see 'AutoSignature' and 'AutoReply'. +-- +-- To manage the type signature and marshaling yourself, use +-- 'DBus.Client.method' instead. +: + +:d apidoc DBus.Connection.Connection +-- | A 'Connection' is an opaque handle to an open D‐Bus channel, with +-- an internal state for maintaining the current message serial. +: + +:d apidoc DBus.Connection.Transport -- | A 'Transport' is anything which can send and receive bytestrings, -- typically via a socket. : -:d apidoc connect +:d apidoc DBus.Connection.connect -- | Open a connection to some address, using a given authentication -- mechanism. If the connection fails, a 'ConnectionError' will be thrown. : -:d apidoc connectFirst --- | Try to open a connection to various addresses, returning the first --- connection which could be successfully opened. -: - -:d apidoc connectionClose +:d apidoc DBus.Connection.disconnect -- | Close an open connection. Once closed, the 'Connection' is no longer -- valid and must not be used. : -:d apidoc send --- | Send a single message, with a generated 'M.Serial'. The second parameter --- exists to prevent race conditions when registering a reply handler; it --- receives the serial the message /will/ be sent with, before it's actually --- sent. --- --- Only one message may be sent at a time; if multiple threads attempt to --- send messages in parallel, one will block until after the other has --- finished. -: - -:d apidoc receive +:d apidoc DBus.Connection.receive -- | Receive the next message from the connection, blocking until one is -- available. -- @@ -95,76 +128,49 @@ -- finished. : -:d apidoc getBus --- | Similar to 'C.connect', but additionally sends @Hello@ messages to the --- central bus. -: - -:d apidoc getFirstBus --- | Similar to 'C.connectFirst', but additionally sends @Hello@ messages to --- the central bus. -: - -:d apidoc getSystemBus --- | Connect to the bus specified in the environment variable --- @DBUS_SYSTEM_BUS_ADDRESS@, or to --- @unix:path=\/var\/run\/dbus\/system_bus_socket@ if @DBUS_SYSTEM_BUS_ADDRESS@ --- is not set. -: - -:d apidoc getSessionBus --- | Connect to the bus specified in the environment variable --- @DBUS_SESSION_BUS_ADDRESS@, which must be set. -: - -:d apidoc getStarterBus --- | Connect to the bus specified in the environment variable --- @DBUS_STARTER_ADDRESS@, which must be set. -: - -:d apidoc formatRule --- | Format a 'MatchRule' as the bus expects to receive in a call to --- @AddMatch@. -: - -:d apidoc addMatch --- | Build a 'M.MethodCall' for adding a match rule to the bus. -: - -:d apidoc matchAll --- | An empty match rule, which matches everything. -: - -:d apidoc matches --- | Whether a 'M.ReceivedMessage' matches a given rule. This is useful --- for implementing signal handlers. +:d apidoc DBus.Connection.send +-- | Send a single message, with a generated 'Serial'. The second parameter +-- exists to prevent race conditions when registering a reply handler; it +-- receives the serial the message /will/ be sent with, before it’s +-- actually sent. +-- +-- Only one message may be sent at a time; if multiple threads attempt to +-- send messages in parallel, one will block until after the other has +-- finished. : -:d apidoc requestName --- | Build a 'M.MethodCall' for requesting a registered bus name. +:d apidoc DBus.Message.ReceivedMessage +-- | Not an actual message type, but a wrapper around messages received from +-- the bus. Each value contains the message’s 'Serial' and possibly the +-- origin’s 'BusName' : -:d apidoc releaseName --- | Build a 'M.MethodCall' for releasing a registered bus name. +:d apidoc DBus.Message.Serial +-- | A value used to uniquely identify a particular message within a session. +-- 'Serial's are 32‐bit unsigned integers, and eventually wrap. : -:d apidoc Serial --- | A value used to uniquely identify a particular message within a session. --- 'Serial's are 32-bit unsigned integers, and eventually wrap. +:d apidoc DBus.Types.Variant +-- | 'Variant's may contain any other built‐in D‐Bus value. Besides +-- representing native @VARIANT@ values, they allow type‐safe storage and +-- deconstruction of heterogeneous collections. : -:d apidoc ReceivedMessage --- | Not an actual message type, but a wrapper around messages received from --- the bus. Each value contains the message's 'Serial' and possibly the --- origin's 'T.BusName' +:d apidoc DBus.Types.variantType +-- | Every variant is strongly‐typed; that is, the type of its contained +-- value is known at all times. This function retrieves that type, so that +-- the correct cast can be used to retrieve the value. : -:d apidoc marshalMessage --- | Convert a 'M.Message' into a 'L.ByteString'. Although unusual, it is --- possible for marshaling to fail -- if this occurs, an appropriate error --- will be returned instead. +:d apidoc DBus.Wire.marshalMessage +-- | Convert a 'Message' into a 'ByteString'. Although unusual, it is +-- possible for marshaling to fail; if this occurs, an error will be +-- returned instead. : -:d apidoc unmarshalMessage --- | Read bytes from a monad until a complete message has been received. +:d apidoc DBus.Wire.unmarshalMessage +-- | Parse a 'ByteString' into a 'ReceivedMessage'. The result can be +-- inspected to see what type of message was parsed. Unknown message types +-- can still be parsed successfully, as long as they otherwise conform to +-- the D‐Bus standard. : diff --git a/src/authentication.anansi b/src/authentication.anansi deleted file mode 100644 --- a/src/authentication.anansi +++ /dev/null @@ -1,148 +0,0 @@ -:# Copyright (C) 2009-2010 John Millikin -:# -:# 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 -:# 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 . - -\subsection{Authentication} - -Authentication is a bit iffy; currently, there's a one specified -authentication mechanism ({\tt DBUS\_COOKIE\_SHA1}), which I've never seen -in the wild. Everybody seems to use {\tt EXTERNAL}, described below. - -To support multiple modes more easily in the future, and for user-defined -authentication handling (eg, in proxy servers), authentication is handled by -a separate module. - -:f DBus/Authentication.hs -|copyright| -|text extensions| -{-# LANGUAGE DeriveDataTypeable #-} -module DBus.Authentication - ( Command - , Mechanism (..) - , AuthenticationError (..) - , authenticate - , realUserID - ) where -|text imports| -|authentication imports| -: - -The authentication protocol is based on {\sc ascii} text, initiated by the -client. Commands and mechanisms are represented by a couple data types: - -:d authentication imports -import Data.ByteString.Lazy (ByteString) -import qualified Data.ByteString.Lazy as ByteString -import Data.ByteString.Lazy.Char8 () -import qualified DBus.UUID as UUID -: - -:f DBus/Authentication.hs -type Command = Text -newtype Mechanism = Mechanism - { mechanismRun :: (Command -> IO Command) -> IO UUID.UUID - } -: - -If authentication fails, an exception will be raised. - -:d authentication imports -import Data.Typeable (Typeable) -import qualified Control.Exception as E -: - -:f DBus/Authentication.hs -data AuthenticationError - = AuthenticationError Text - deriving (Show, Typeable) - -instance E.Exception AuthenticationError -: - -The process begins by the client sending a single {\sc nul} byte, followed -by exchanges of {\sc ascii} commands until authentication is complete. Which -commands are sent depends on the selected mechanism. - -:d authentication imports -import Data.Word (Word8) -: - -:f DBus/Authentication.hs -authenticate :: Mechanism -> (ByteString -> IO ()) -> IO Word8 - -> IO UUID.UUID -authenticate mech put getByte = do - put $ ByteString.singleton 0 - uuid <- mechanismRun mech (putCommand put getByte) - put "BEGIN\r\n" - return uuid -: - -TODO: describe {\tt putCommand} here - -:d authentication imports -import Control.Monad (liftM) -import Data.Char (chr) -import Data.Text.Lazy.Encoding (encodeUtf8) -import DBus.Util (readUntil, dropEnd) -: - -:f DBus/Authentication.hs -putCommand :: Monad m => (ByteString -> m ()) -> m Word8 -> Command -> m Command -putCommand put get cmd = do - let getC = liftM (chr . fromIntegral) get - put $ encodeUtf8 cmd - put "\r\n" - liftM (TL.pack . dropEnd 2) $ readUntil "\r\n" getC -: - -\subsubsection{Support authentication mechanisms} - -Currently, the only supported authentication mechanism is sending the local -user's ``real user ID''. - -:d authentication imports -import System.Posix.User (getRealUserID) -import Data.Char (ord) -import Text.Printf (printf) -: - -:f DBus/Authentication.hs -realUserID :: Mechanism -realUserID = Mechanism $ \sendCmd -> do - uid <- getRealUserID - let token = concatMap (printf "%02X" . ord) (show uid) - let cmd = "AUTH EXTERNAL " ++ token - eitherUUID <- checkOK `fmap` sendCmd (TL.pack cmd) - case eitherUUID of - Right uuid -> return uuid - Left err -> E.throwIO $ AuthenticationError err -: - -If authentication was successful, the server responds with {\tt OK -}. - -:d authentication imports -import Data.Maybe (isJust) -: - -:f DBus/Authentication.hs -checkOK :: Command -> Either Text UUID.UUID -checkOK cmd = if validUUID then Right uuid else Left errorMsg where - validUUID = TL.isPrefixOf "OK " cmd && isJust maybeUUID - maybeUUID = UUID.fromHex $ TL.drop 3 cmd - Just uuid = maybeUUID - errorMsg = if TL.isPrefixOf "ERROR " cmd - then TL.drop 6 cmd - else TL.pack $ "Unexpected response: " ++ show cmd -: diff --git a/src/bus.anansi b/src/bus.anansi deleted file mode 100644 --- a/src/bus.anansi +++ /dev/null @@ -1,140 +0,0 @@ -:# Copyright (C) 2009-2010 John Millikin -:# -:# 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 -:# 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 . - -\section{The central bus} - -:f DBus/Bus.hs -|copyright| -|text extensions| -module DBus.Bus - ( getBus - , getFirstBus - , getSystemBus - , getSessionBus - , getStarterBus - ) where -|text imports| - -import qualified Control.Exception as E -import Control.Monad (when) -import Data.Maybe (fromJust, isNothing) -import qualified Data.Set as Set -import System.Environment (getEnv) - -import qualified DBus.Address as A -import qualified DBus.Authentication as Auth -import qualified DBus.Connection as C -import DBus.Constants (dbusName, dbusPath, dbusInterface) -import qualified DBus.Message as M -import qualified DBus.Types as T -import DBus.Util (fromRight) -: - -Connecting to a message bus is a bit more involved than just connecting -over an app-to-app connection: the bus must be notified of the new client, -using a "hello message", before it will begin forwarding messages. - -:f DBus/Bus.hs -busForConnection :: C.Connection -> IO (C.Connection, T.BusName) -busForConnection c = fmap ((,) c) $ sendHello c - -|apidoc getBus| -getBus :: Auth.Mechanism -> A.Address -> IO (C.Connection, T.BusName) -getBus = ((busForConnection =<<) .) . C.connect -: - -Optionally, multiple addresses may be provided. The first successful -connection will be used. - -:f DBus/Bus.hs -|apidoc getFirstBus| -getFirstBus :: [(Auth.Mechanism, A.Address)] -> IO (C.Connection, T.BusName) -getFirstBus = (busForConnection =<<) . C.connectFirst -: - -\subsection{Default connections} - -Two default buses are defined, the ``system'' and ``session'' buses. The system -bus is global for the OS, while the session bus runs only for the duration -of the user's session. - -:f DBus/Bus.hs -|apidoc getSystemBus| -getSystemBus :: IO (C.Connection, T.BusName) -getSystemBus = getBus' $ fromEnv `E.catch` noEnv where - defaultAddr = "unix:path=/var/run/dbus/system_bus_socket" - fromEnv = getEnv "DBUS_SYSTEM_BUS_ADDRESS" - noEnv (E.SomeException _) = return defaultAddr - -|apidoc getSessionBus| -getSessionBus :: IO (C.Connection, T.BusName) -getSessionBus = getBus' $ getEnv "DBUS_SESSION_BUS_ADDRESS" - -|apidoc getStarterBus| -getStarterBus :: IO (C.Connection, T.BusName) -getStarterBus = getBus' $ getEnv "DBUS_STARTER_ADDRESS" -: - -:f DBus/Bus.hs -getBus' :: IO String -> IO (C.Connection, T.BusName) -getBus' io = do - addr <- fmap TL.pack io - case A.mkAddresses addr of - Just [x] -> getBus Auth.realUserID x - Just xs -> getFirstBus [(Auth.realUserID,x) | x <- xs] - _ -> E.throwIO $ C.InvalidAddress addr -: - -\subsection{Sending the ``hello'' message} - -:f DBus/Bus.hs -hello :: M.MethodCall -hello = M.MethodCall dbusPath - "Hello" - (Just dbusInterface) - (Just dbusName) - Set.empty - [] -: - -:f DBus/Bus.hs -sendHello :: C.Connection -> IO T.BusName -sendHello c = do - serial <- fromRight `fmap` C.send c return hello - reply <- waitForReply c serial - let name = case M.methodReturnBody reply of - (x:_) -> T.fromVariant x - _ -> Nothing - - when (isNothing name) $ - E.throwIO $ E.AssertionFailed "Invalid response to Hello()" - - return . fromJust $ name -: - -:f DBus/Bus.hs -waitForReply :: C.Connection -> M.Serial -> IO M.MethodReturn -waitForReply c serial = do - received <- C.receive c - msg <- case received of - Right x -> return x - Left _ -> E.throwIO $ E.AssertionFailed "Invalid response to Hello()" - case msg of - (M.ReceivedMethodReturn _ _ reply) -> - if M.methodReturnSerial reply == serial - then return reply - else waitForReply c serial - _ -> waitForReply c serial -: diff --git a/src/client.anansi b/src/client.anansi new file mode 100644 --- /dev/null +++ b/src/client.anansi @@ -0,0 +1,580 @@ +:# Copyright (C) 2009-2011 John Millikin +:# +:# 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 +:# 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 . + +\clearpage +\section{D-Bus clients} + +\subsection{Client types} + +:d DBus.Client +data Client = Client + { clientConnection :: Connection + , clientCallbacks :: MVar (Map Serial Callback) + , clientSignalHandlers :: MVar [Callback] + , clientObjects :: MVar (Map ObjectPath ObjectInfo) + , clientThreadID :: ThreadId + , clientMessageProcessor :: IORef (ReceivedMessage -> IO Bool) + } + +type Callback = (ReceivedMessage -> IO ()) + +data Reply + = ReplyReturn [Variant] + | ReplyError ErrorName [Variant] + +data Method = Method InterfaceName MemberName Signature Signature ([Variant] -> IO Reply) + +type ObjectInfo = Map InterfaceName InterfaceInfo +type InterfaceInfo = Map MemberName MemberInfo +data MemberInfo + = MemberMethod Signature Signature Callback + | MemberSignal Signature +: + +\clearpage +\subsection{Connecting and disconnecting clients} + +:d DBus.Client +attach :: Connection -> IO Client +attach connection = do + callbacks <- newMVar Data.Map.empty + signalHandlers <- newMVar [] + objects <- newMVar Data.Map.empty + processor <- newIORef (\_ -> return False) + + client <- mfix $ \client -> do + threadID <- forkIO (mainLoop client) + return (Client + { clientConnection = connection + , clientCallbacks = callbacks + , clientSignalHandlers = signalHandlers + , clientObjects = objects + , clientThreadID = threadID + , clientMessageProcessor = processor + }) + + export client "/" [introspectRoot client] + + void (call_ client (MethodCall + { methodCallDestination = Just "org.freedesktop.DBus" + , methodCallMember = "Hello" + , methodCallInterface = Just "org.freedesktop.DBus" + , methodCallPath = "/org/freedesktop/DBus" + , methodCallFlags = Data.Set.empty + , methodCallBody = [] + })) + + return client +: + +:d DBus.Client +connect :: Address -> IO Client +connect addr = do + connection <- DBus.Connection.connect [unix, tcp] [external] addr + attach connection + +|apidoc DBus.Client.disconnect| +disconnect :: Client -> IO () +disconnect client = do + let connection = clientConnection client + killThread (clientThreadID client) + modifyMVar_ (clientCallbacks client) (\_ -> return Data.Map.empty) + modifyMVar_ (clientSignalHandlers client) (\_ -> return []) + modifyMVar_ (clientObjects client) (\_ -> return Data.Map.empty) + DBus.Connection.disconnect connection +: + +\clearpage +\subsection{Main message dispatch loop} + +:d DBus.Client +setMessageProcessor :: Client -> (ReceivedMessage -> IO Bool) -> IO () +setMessageProcessor client io = atomicModifyIORef + (clientMessageProcessor client) + (\_ -> (io, ())) +: + +:d DBus.Client +mainLoop :: Client -> IO () +mainLoop client = forever $ do + let connection = clientConnection client + + received <- DBus.Connection.receive connection + msg <- case received of + Left err -> do + disconnect client + connectionError ("Received invalid message: " ++ show err) + Right msg -> return msg + + dispatch client msg + +dispatch :: Client -> ReceivedMessage -> IO () +dispatch client received = void . forkIO $ do + process <- readIORef (clientMessageProcessor client) + handled <- process received + + let onReply serial = do + let mvar = clientCallbacks client + maybeCB <- modifyMVar mvar $ \callbacks -> let + x = Data.Map.lookup serial callbacks + callbacks' = if isJust x + then Data.Map.delete serial callbacks + else callbacks + in return (callbacks', x) + case maybeCB of + Just cb -> void (cb received) + Nothing -> return () + + unless handled $ case received of + (ReceivedMethodReturn _ _ msg) -> onReply (methodReturnSerial msg) + (ReceivedError _ _ msg) -> onReply (errorSerial msg) + (ReceivedSignal _ _ _) -> do + handlers <- readMVar (clientSignalHandlers client) + mapM_ ($ received) handlers + (ReceivedMethodCall serial sender msg) -> do + objects <- readMVar (clientObjects client) + case findMethod objects msg of + Just io -> io received + Nothing -> send_ client + (Error errorUnknownMethod serial sender []) + (\_ -> return ()) + _ -> return () +: + +\clearpage +\subsection{Making method calls} + +:d DBus.Client +send_ :: Message msg => Client -> msg -> (Serial -> IO a) -> IO a +send_ client msg io = do + result <- DBus.Connection.send (clientConnection client) msg io + case result of + Right serial -> return serial + Left err -> connectionError ("Error sending message: " ++ show err) + +call :: Client -> MethodCall -> IO (Either Error MethodReturn) +call client msg = do + mvar <- newEmptyMVar + + let callback (ReceivedError _ _ err) = putMVar mvar (Left err) + callback (ReceivedMethodReturn _ _ reply) = putMVar mvar (Right reply) + callback _ = return () + + send_ client msg (\serial -> + modifyMVar_ (clientCallbacks client) (\callbacks -> + return (Data.Map.insert serial callback callbacks))) + + takeMVar mvar + +call_ :: Client -> MethodCall -> IO MethodReturn +call_ client msg = do + result <- call client msg + case result of + Left err -> connectionError ("Call failed: " ++ Data.Text.unpack (errorMessage err)) + Right ret -> return ret +: + +\clearpage +\subsection{Receiving signals} + +:d DBus.Client +data MatchRule = MatchRule + { matchSender :: Maybe BusName + , matchDestination :: Maybe BusName + , matchPath :: Maybe ObjectPath + , matchInterface :: Maybe InterfaceName + , matchMember :: Maybe MemberName + } + deriving (Show) + +listen :: Client -> MatchRule -> (BusName -> Signal -> IO ()) -> IO () +listen client rule io = do + let handler (ReceivedSignal _ (Just sender) msg) + | checkMatchRule rule sender msg = io sender msg + handler _ = return () + + modifyMVar_ (clientSignalHandlers client) (\hs -> return (handler : hs)) + void (call_ client (MethodCall + { methodCallPath = DBus.Constants.dbusPath + , methodCallMember = "AddMatch" + , methodCallInterface = Just DBus.Constants.dbusInterface + , methodCallDestination = Just DBus.Constants.dbusName + , methodCallFlags = Data.Set.empty + , methodCallBody = [toVariant (formatMatchRule rule)] + })) + +formatMatchRule :: MatchRule -> Text +formatMatchRule rule = Data.Text.intercalate "," predicates where + predicates = catMaybes + [ f "sender" matchSender busNameText + , f "destination" matchDestination busNameText + , f "path" matchPath objectPathText + , f "interface" matchInterface interfaceNameText + , f "member" matchMember memberNameText + ] + + f :: Text -> (MatchRule -> Maybe a) -> (a -> Text) -> Maybe Text + f key get text = do + val <- fmap text (get rule) + return (Data.Text.concat [key, "='", val, "'"]) + +checkMatchRule :: MatchRule -> BusName -> Signal -> Bool +checkMatchRule rule sender msg = and + [ maybe True (== sender) (matchSender rule) + , maybe True (\x -> signalDestination msg == Just x) (matchDestination rule) + , maybe True (== signalPath msg) (matchPath rule) + , maybe True (== signalInterface msg) (matchInterface rule) + , maybe True (== signalMember msg) (matchMember rule) + ] +: + +\clearpage +\subsection{Exporting objects and methods} + +:d DBus.Client +data MethodError = MethodError ErrorName [Variant] + deriving (Show, Eq, Typeable) + +instance Control.Exception.Exception MethodError + +|apidoc DBus.Client.throwError| +throwError :: ErrorName -> Text -> [Variant] -> IO a +throwError name message extra = Control.Exception.throwIO (MethodError name (toVariant message : extra)) +: + +:d DBus.Client +method :: InterfaceName -> MemberName -> Signature -> Signature -> ([Variant] -> IO Reply) -> Method +method iface name inSig outSig io = Method iface name inSig outSig + (\vs -> Control.Exception.catch + (Control.Exception.catch + (io vs) + (\(MethodError name' vs') -> return (ReplyError name' vs'))) + (\exc -> return (ReplyError errorFailed + [toVariant (Data.Text.pack (show (exc :: SomeException)))]))) + +export :: Client -> ObjectPath -> [Method] -> IO () +export client path methods = modifyMVar_ (clientObjects client) addObject where + addObject objs = return (Data.Map.insert path info objs) + + info = foldl' addMethod Data.Map.empty (defaultIntrospect : methods) + addMethod m (Method iface name inSig outSig cb) = Data.Map.insertWith' + Data.Map.union iface + (Data.Map.fromList [(name, MemberMethod inSig outSig (wrapCB cb))]) m + + wrapCB cb (ReceivedMethodCall serial sender msg) = do + reply <- cb (methodCallBody msg) + case reply of + ReplyReturn vs -> send_ client (MethodReturn serial sender vs) (\_ -> return ()) + ReplyError name vs -> send_ client (Error name serial sender vs) (\_ -> return ()) + wrapCB _ _ = return () + + defaultIntrospect = methodIntrospect $ do + objects <- readMVar (clientObjects client) + let Just obj = Data.Map.lookup path objects + return (introspect path obj) +: + +:d DBus.Client +findMethod :: Map ObjectPath ObjectInfo -> MethodCall -> Maybe Callback +findMethod objects msg = do + ifaceName <- methodCallInterface msg + obj <- Data.Map.lookup (methodCallPath msg) objects + iface <- Data.Map.lookup ifaceName obj + member <- Data.Map.lookup (methodCallMember msg) iface + case member of + MemberMethod _ _ io -> return io + _ -> Nothing +: + +\clearpage +\subsubsection{Automatic introspection} + +:d DBus.Client +introspectRoot :: Client -> Method +introspectRoot client = methodIntrospect $ do + objects <- readMVar (clientObjects client) + let paths = filter (/= "/") (Data.Map.keys objects) + let iface = "org.freedesktop.DBus.Introspectable" + let name = "Introspect" + return (DBus.Introspection.Object "/" + [DBus.Introspection.Interface iface + [DBus.Introspection.Method name + [] + [DBus.Introspection.Parameter "" "s"]] + [] []] + [DBus.Introspection.Object p [] [] | p <- paths]) +: + +:d DBus.Client +methodIntrospect :: IO DBus.Introspection.Object -> Method +methodIntrospect get = method iface name "" "s" impl where + iface = "org.freedesktop.DBus.Introspectable" + name = "Introspect" + impl [] = do + obj <- get + let Just xml = DBus.Introspection.toXML obj + return (ReplyReturn [toVariant xml]) + impl _ = return (ReplyError errorInvalidParameters []) + +introspect :: ObjectPath -> ObjectInfo -> DBus.Introspection.Object +introspect path obj = DBus.Introspection.Object path interfaces [] where + interfaces = map introspectIface (Data.Map.toList obj) + + introspectIface (name, iface) = let + members = Data.Map.toList iface + methods = concatMap introspectMethod members + signals = concatMap introspectSignal members + in DBus.Introspection.Interface name methods signals [] + + introspectMethod (name, (MemberMethod inSig outSig _)) = + [DBus.Introspection.Method name + (map introspectParam (signatureTypes inSig)) + (map introspectParam (signatureTypes outSig))] + introspectMethod _ = [] + + introspectSignal (name, (MemberSignal sig)) = + [DBus.Introspection.Signal name + (map introspectParam (signatureTypes sig))] + introspectSignal _ = [] + + introspectParam t = DBus.Introspection.Parameter "" (Signature [t]) +: + +\clearpage +\subsection{Simple clients} + +:d DBus.Client.Simple +connectFirst :: [Address] -> IO Client +connectFirst addrs = loop addrs where + loop [] = connectionError (concat + [ "connectFirst: no usable" + , " addresses in " + , show addrs]) + loop (a:as) = Control.Exception.catch + (DBus.Client.connect a) + (\(ConnectionError _) -> loop as) + +|apidoc DBus.Client.Simple.connectSession| +connectSession :: IO Client +connectSession = do + env <- DBus.Address.getSession + case env of + Nothing -> connectionError (concat + [ "connectSession: DBUS_SESSION_BUS_ADDRESS is" + , " missing or invalid." + ]) + Just addrs -> connectFirst addrs + +|apidoc DBus.Client.Simple.connectSystem| +connectSystem :: IO Client +connectSystem = do + env <- DBus.Address.getSystem + case env of + Nothing -> connectionError (concat + [ "connectSession: DBUS_SYSTEM_BUS_ADDRESS is" + , " invalid." + ]) + Just addrs -> connectFirst addrs + +|apidoc DBus.Client.Simple.connectStarter| +connectStarter :: IO Client +connectStarter = do + env <- DBus.Address.getStarter + case env of + Nothing -> connectionError (concat + [ "connectSession: DBUS_STARTER_BUS_ADDRESS is" + , " missing or invalid." + ]) + Just addrs -> connectFirst addrs +: + +\clearpage +\subsubsection{Remote object proxies} + +:d DBus.Client.Simple +data Proxy = Proxy Client BusName ObjectPath +: + +:d DBus.Client.Simple +proxy :: Client -> BusName -> ObjectPath -> IO Proxy +proxy client dest path = return (Proxy client dest path) +: + +:d DBus.Client.Simple +call :: Proxy -> InterfaceName -> MemberName -> [Variant] -> IO [Variant] +call (Proxy client dest path) iface member body = do + reply <- DBus.Client.call_ client $ MethodCall + { methodCallDestination = Just dest + , methodCallMember = member + , methodCallInterface = Just iface + , methodCallPath = path + , methodCallFlags = Data.Set.empty + , methodCallBody = body + } + return (methodReturnBody reply) +: + +:d DBus.Client.Simple +listen :: Proxy -> InterfaceName -> MemberName -> (BusName -> Signal -> IO ()) -> IO () +listen (Proxy client dest path) iface member = DBus.Client.listen client (MatchRule + { matchSender = Just dest + , matchInterface = Just iface + , matchMember = Just member + , matchPath = Just path + , matchDestination = Nothing + }) +: + +\clearpage +\subsubsection{Name reservation} + +:d DBus.Client.Simple +data RequestNameFlag + = AllowReplacement + | ReplaceExisting + | DoNotQueue + deriving (Show) + +data RequestNameReply + = PrimaryOwner + | InQueue + | Exists + | AlreadyOwner + deriving (Show) + +data ReleaseNameReply + = Released + | NonExistent + | NotOwner + deriving (Show) +: + +:d DBus.Client.Simple +encodeFlags :: [RequestNameFlag] -> Word32 +encodeFlags = foldr (.|.) 0 . map flagValue where + flagValue AllowReplacement = 0x1 + flagValue ReplaceExisting = 0x2 + flagValue DoNotQueue = 0x4 +: + +:d DBus.Client.Simple +requestName :: Client -> BusName -> [RequestNameFlag] -> IO RequestNameReply +requestName client name flags = do + bus <- proxy client "org.freedesktop.DBus" "/org/freedesktop/DBus" + reply <- call bus "org.freedesktop.DBus" "RequestName" + [ toVariant name + , toVariant (encodeFlags flags) + ] + case (maybeIndex reply 0 >>= fromVariant :: Maybe Word32) of + Just 1 -> return PrimaryOwner + Just 2 -> return InQueue + Just 3 -> return Exists + Just 4 -> return AlreadyOwner + _ -> connectionError "Call failed: received invalid reply" + +releaseName :: Client -> BusName -> IO ReleaseNameReply +releaseName client name = do + bus <- proxy client "org.freedesktop.DBus" "/org/freedesktop/DBus" + reply <- call bus "org.freedesktop.DBus" "ReleaseName" + [ toVariant name + ] + case (maybeIndex reply 0 >>= fromVariant :: Maybe Word32) of + Just 1 -> return Released + Just 2 -> return NonExistent + Just 3 -> return NotOwner + _ -> connectionError "Call failed: received invalid reply" +: + +\clearpage +\subsubsection{Simplified exports} + +:d DBus.Client.Simple +|apidoc DBus.Client.Simple.AutoSignature| +class AutoSignature a where + funTypes :: a -> ([Type], [Type]) + +instance AutoSignature (IO ()) where + funTypes _ = ([], []) + +instance IsValue a => AutoSignature (IO a) where + funTypes io = ([], case ioT io undefined of + (_, t) -> case t of + TypeStructure ts -> ts + _ -> [t]) + +ioT :: IsValue a => IO a -> a -> (a, Type) +ioT _ a = (a, typeOf a) + +instance (IsValue a, AutoSignature fun) => AutoSignature (a -> fun) where + funTypes fn = case valueT undefined of + (a, t) -> case funTypes (fn a) of + (ts, ts') -> (t : ts, ts') + +valueT :: IsValue a => a -> (a, Type) +valueT a = (a, typeOf a) +: + +:d DBus.Client.Simple +|apidoc DBus.Client.Simple.AutoReply| +class AutoReply fun where + apply :: fun -> [Variant] -> Maybe (IO [Variant]) + +instance AutoReply (IO ()) where + apply io [] = Just (io >> return []) + apply _ _ = Nothing + +instance IsVariant a => AutoReply (IO a) where + apply io [] = Just (do + var <- fmap toVariant io + case fromVariant var of + Just struct -> return (structureItems struct) + Nothing -> return [var]) + apply _ _ = Nothing + +instance (IsVariant a, AutoReply fun) => AutoReply (a -> fun) where + apply _ [] = Nothing + apply fn (v:vs) = case fromVariant v of + Just v' -> apply (fn v') vs + Nothing -> Nothing +: + +:d DBus.Client.Simple +|apidoc DBus.Client.Simple.method| +method :: (AutoSignature fun, AutoReply fun) => InterfaceName -> MemberName -> fun -> Method +method iface name fun = DBus.Client.method iface name inSig outSig io where + (typesIn, typesOut) = funTypes fun + inSig = case checkSignature typesIn of + Just sig -> sig + Nothing -> invalid "input" + outSig = case checkSignature typesOut of + Just sig -> sig + Nothing -> invalid "output" + io vs = case apply fun vs of + Nothing -> return (ReplyError errorInvalidParameters []) + Just io' -> fmap ReplyReturn io' + + invalid label = error (concat + [ "Method " + , Data.Text.unpack (interfaceNameText iface) + , "." + , Data.Text.unpack (memberNameText name) + , " has an invalid " + , label + , " signature."]) + +|apidoc DBus.Client.Simple.export| +export :: Client -> ObjectPath -> [Method] -> IO () +export = DBus.Client.export +: diff --git a/src/connections.anansi b/src/connections.anansi --- a/src/connections.anansi +++ b/src/connections.anansi @@ -1,4 +1,4 @@ -:# Copyright (C) 2009-2010 John Millikin +:# Copyright (C) 2009-2011 John Millikin :# :# 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 @@ -15,119 +15,378 @@ \section{Connections} -:f DBus/Connection.hs -|copyright| -|text extensions| -{-# LANGUAGE DeriveDataTypeable #-} -module DBus.Connection ( - |connection exports| - ) where -|text imports| -|connection imports| +\begin{multicols}{2} + +A {\tt Connection} is an opaque handle to an open \dbus{} socket, with +an internal state for maintaining the current message serial and enforcing +thread-safe access to the socket. Every connection has an \emph{address}, +which is where the remote server is listening, and a \emph{transport}, which +manages actually sending bytes between the two applications. + +\vfill +\columnbreak + +:d DBus.Connection +|apidoc DBus.Connection.Connection| +data Connection = Connection + { connectionAddress :: Address + , connectionSocket :: Socket + , connectionSerial :: IORef Serial + , connectionReadLock :: MVar () + , connectionWriteLock :: MVar () + } : -A {\tt Connection} is an opaque handle to an open D-Bus channel, with -an internal state for maintaining the current message serial. +\end{multicols} -The second {\tt MVar} doesn't really store a value, it's just used to -prevent two separate threads from reading from the transport at once. +\begin{multicols}{2} -:d connection imports -import qualified Control.Concurrent as C -import qualified DBus.Address as A -import qualified DBus.Message as M -import qualified DBus.UUID as UUID +TODO + +\vfill +\columnbreak + +:d DBus.Connection.Error +newtype ConnectionError = ConnectionError String + deriving (Show, Eq, Typeable) + +instance Exception ConnectionError + +connectionError :: String -> IO a +connectionError = throwIO . ConnectionError : -:f DBus/Connection.hs -data Connection = Connection - { connectionAddress :: A.Address - , connectionTransport :: Transport - , connectionSerialMVar :: C.MVar M.Serial - , connectionReadMVar :: C.MVar () - , connectionUUID :: UUID.UUID - } +\end{multicols} + +\begin{multicols}{2} + +TODO + +\vfill +\columnbreak + +:d DBus.Connection +|apidoc DBus.Connection.connect| +connect :: [Transport] -> [Mechanism] -> Address -> IO Connection +connect transports mechanisms addr = do + msock <- connectTransport transports addr + sock <- case msock of + Just s -> return s + Nothing -> connectionError (concat + [ "Unknown address method: " + , show (addressMethod addr) + ]) + authed <- authenticate sock mechanisms + when (not authed) + (connectionError "Authentication failed") + + serial <- newIORef (Serial 1) + readLock <- newMVar () + writeLock <- newMVar () + return (Connection addr sock serial + readLock writeLock) + +|apidoc DBus.Connection.disconnect| +disconnect :: Connection -> IO () +disconnect = socketClose . connectionSocket : -:d connection exports - Connection -, connectionAddress -, connectionUUID +\end{multicols} + +\clearpage +\subsection{Addresses} + +\begin{multicols}{2} + +An address has two components, the \emph{method} and the \emph{parameters}. +The method (such as {\tt "unix"} or {\tt "tcp"}) describes how the socket +should be opened. The parameters include additional information, such as +hostnames, required by the method. + +\vfill +\columnbreak + +:d DBus.Address +data Address = Address Text (Map Text Text) + deriving (Eq) + +addressMethod :: Address -> Text +addressMethod (Address x _ ) = x + +addressParameters :: Address -> Map Text Text +addressParameters (Address _ x) = x : -While not particularly useful for other functions, being able to -{\tt show} a {\tt Connection} is useful when debugging. +\end{multicols} -:f DBus/Connection.hs +\begin{multicols}{2} + +A bus address is in the format {\tt $method$:$key$=$value$,...} +where the method may be empty and parameters are optional. An address's +parameter list, if present, may end with a comma. Multiple parameters may +have the same key; in this case, only the first parameter for each key will +be stored. + +In parameter values, any byte may be encoded by prepending the \% character +to its value in hexadecimal. \% is not allowed to appear unless it is +followed by two hexadecimal digits. Every other allowed byte is termed +an ``optionally encoded'' byte, and may appear unescaped in parameter +values. + +\vfill +\columnbreak + +:d DBus.Address +address :: Text -> Maybe Address +address = runParser $ do + addr <- parseAddress + eof + return addr + +parseAddress :: Parser Address +parseAddress = parser where + parser = do + method <- many (noneOf ":;") + void (char ':') + params <- sepEndBy param (char ',') + return (Address + (Data.Text.pack method) + (Data.Map.fromList params)) + + param = do + key <- many1 (noneOf "=;,") + void (char '=') + value <- many1 valueChar + let pack = Data.Text.pack + return (pack key, pack value) + + valueChar = encoded <|> unencoded + encoded = do + void (char '%') + hex <- count 2 hexDigit + return (chr (hexToInt hex)) + unencoded = oneOf optionallyEncoded + +optionallyEncoded :: [Char] +optionallyEncoded = concat + [ ['0'..'9'] + , ['a'..'z'] + , ['A'..'Z'] + , "-_/\\*." + ] +: + +\end{multicols} + +\begin{multicols}{2} + +Addresses in environment variables are separated by semicolons, and the full +address list may end in a semicolon. + +\vfill +\columnbreak + +:d DBus.Address +addresses :: Text -> Maybe [Address] +addresses = runParser $ do + xs <- sepEndBy1 parseAddress (char ';') + eof + return xs +: + +\end{multicols} + +\clearpage +\subsubsection{Printing addresses} + +\begin{multicols}{2} + +Users might want to print addresses and open connections when working in a +{\sc repl}, so I'll define some simple {\tt Show} instances. {\tt Connection} +is given a special format to mark it as {\sc io}-ish, while {\tt address} is +formatted as if it's a string wrapper. + +\vfill +\columnbreak + +:d DBus.Address +instance Show Address where + showsPrec d x = showParen (d > 10) $ + showString "Address " . + shows (addressText x) +: + +:d DBus.Connection instance Show Connection where - showsPrec d con = showParen (d > 10) strCon where - addr = A.strAddress $ connectionAddress con - strCon = s "" - s = showString + showsPrec _ x = + showString "" : -\subsection{Transports} +\end{multicols} -A transport is anything which can send and receive bytestrings, typically -via a socket. +\begin{multicols}{2} -:d connection imports -import qualified Data.ByteString.Lazy as L -import Data.Word (Word32) +Formatting addresses is just the reverse of parsing them. + +\vfill +\columnbreak + +:d DBus.Address +addressText :: Address -> Text +addressText addr = Data.Text.concat chunks where + chunks = [ addressMethod addr, ":" + , paramsText] + + params = addressParameters addr + paramsText = Data.Text.intercalate "," $ do + (k, v) <- Data.Map.toList params + let k' = Data.Text.unpack k + let v' = Data.Text.unpack v + let encoded = concatMap encode v' + let str = concat [k', "=", encoded] + return (Data.Text.pack str) + + encode c = if elem c optionallyEncoded + then [c] + else printf "%%%02X" (ord c) : -:f DBus/Connection.hs -|apidoc Transport| -data Transport = Transport - { transportSend :: L.ByteString -> IO () - , transportRecv :: Word32 -> IO L.ByteString - , transportClose :: IO () - } +\end{multicols} + +\subsubsection{Environmental addresses} + +:d DBus.Address +getenv :: String -> IO (Maybe Text) +getenv name = Control.Exception.catch + (fmap (Just . Data.Text.pack) (System.Environment.getEnv name)) + (\(Control.Exception.SomeException _) -> return Nothing) + +getSystem :: IO (Maybe [Address]) +getSystem = do + let system = "unix:path=/var/run/dbus/system_bus_socket" + env <- getenv "DBUS_SYSTEM_BUS_ADDRESS" + return (addresses (maybe system id env)) + +getSession :: IO (Maybe [Address]) +getSession = do + env <- getenv "DBUS_SESSION_BUS_ADDRESS" + return (env >>= addresses) + +getStarter :: IO (Maybe [Address]) +getStarter = do + env <- getenv "DBUS_STARTER_BUS_ADDRESS" + return (env >>= addresses) : -If a method has no known transport, attempting to connect using it will -just result in an exception. +\clearpage +\subsection{Transports} -:f DBus/Connection.hs -connectTransport :: A.Address -> IO Transport -connectTransport a = transport' (A.addressMethod a) a where - transport' "unix" = unix - transport' "tcp" = tcp - transport' _ = E.throwIO . UnknownMethod +\begin{multicols}{2} + +The transport abstracts how the operating system connects to the server +process; typically, this is based on {\sc unix} or {\sc tcp} sockets, but +users might use alternative transports for special use cases. This library +only requires the ability to read from, write to, and close an open socket, +so those methods are bundled into {\tt Transport}. + +\vfill +\columnbreak + +:d DBus.Connection.Transport +|apidoc DBus.Connection.Transport| +data Transport = Transport Text (Address -> IO Socket) + +data Socket = Socket + (ByteString -> IO ()) + (Word32 -> IO ByteString) + (IO ()) + +transport :: Text -> (Address -> IO Socket) -> Transport +transport = Transport + +socket :: (ByteString -> IO ()) -> (Word32 -> IO ByteString) -> IO () -> Socket +socket = Socket + +socketPut :: Socket -> ByteString -> IO () +socketPut (Socket x _ _) = x + +socketGet :: Socket -> Word32 -> IO ByteString +socketGet (Socket _ x _) = x + +socketClose :: Socket -> IO () +socketClose (Socket _ _ x) = x + +connectTransport :: [Transport] -> Address -> IO (Maybe Socket) +connectTransport transports addr = loop transports where + m = addressMethod addr + loop [] = return Nothing + loop ((Transport n io):ts) = if n == m + then fmap Just (io addr) + else loop ts : -\subsubsection{UNIX} +\end{multicols} +\subsubsection{Generic handle-based transport} + +\begin{multicols}{2} + +Both UNIX and TCP are backed by standard handles, and can therefore use +a shared handle-based transport backend. This sets reasonable defaults +(no buffering, no newline mangling) for the handle parameters. + +\vfill +\columnbreak + +:d DBus.Connection.Transport +connectHandle :: System.IO.Handle -> IO Socket +connectHandle h = do + System.IO.hSetBuffering h System.IO.NoBuffering + System.IO.hSetBinaryMode h True + return (Socket + (Data.ByteString.hPut h) + (Data.ByteString.hGet h . fromIntegral) + (System.IO.hClose h)) +: + +\end{multicols} + +\clearpage +\subsubsection{UNIX Transport} + The {\sc unix} transport accepts two parameters: {\tt path}, which is a simple filesystem path, and {\tt abstract}, which is a path in the Linux-specific abstract domain. One, and only one, of these parameters must be specified. -:d connection imports -import qualified Network as N -import qualified Data.Map as Map -: +:d DBus.Connection.Transport +unix :: Transport +unix = transport "unix" connectUNIX -:f DBus/Connection.hs -unix :: A.Address -> IO Transport -unix a = port >>= N.connectTo "localhost" >>= handleTransport where - params = A.addressParameters a - path = Map.lookup "path" params - abstract = Map.lookup "abstract" params +connectUNIX :: Address -> IO Socket +connectUNIX a = getHandle >>= connectHandle where + params = addressParameters a + param key = Data.Map.lookup key params tooMany = "Only one of `path' or `abstract' may be specified for the\ \ `unix' transport." tooFew = "One of `path' or `abstract' must be specified for the\ \ `unix' transport." - port = fmap N.UnixSocket path' - path' = case (path, abstract) of - (Just _, Just _) -> E.throwIO $ BadParameters a tooMany - (Nothing, Nothing) -> E.throwIO $ BadParameters a tooFew - (Just x, Nothing) -> return $ TL.unpack x - (Nothing, Just x) -> return $ '\x00' : TL.unpack x + path = case (param "path", param "abstract") of + (Just _, Just _) -> connectionError tooMany + (Nothing, Nothing) -> connectionError tooFew + (Just x, Nothing) -> return (Data.Text.unpack x) + (Nothing, Just x) -> return ('\x00' : Data.Text.unpack x) + + getHandle = do + port <- fmap Network.UnixSocket path + Network.connectTo "localhost" port : +\clearpage \subsubsection{TCP} The {\sc tcp} transport has three parameters: @@ -139,49 +398,35 @@ {\tt "ipv4"} or {\tt "ipv6"} \end{itemize} -The high-level {\tt Network} module doesn't provide enough control over -socket construction for this transport, so {\tt Network.Socket} must be -imported. - -:d connection imports -import qualified Network.Socket as NS -: +:d DBus.Connection.Transport +tcp :: Transport +tcp = Transport "tcp" connectTCP -:f DBus/Connection.hs -tcp :: A.Address -> IO Transport -tcp a = openHandle >>= handleTransport where - params = A.addressParameters a - openHandle = do +connectTCP :: Address -> IO Socket +connectTCP a = getHandle >>= connectHandle where + params = addressParameters a + param key = Data.Map.lookup key params + + getHandle = do port <- getPort family <- getFamily - addresses <- getAddresses family - socket <- openSocket port addresses - NS.socketToHandle socket I.ReadWriteMode -: - -Parameter parsing... - -:f DBus/Connection.hs - hostname = maybe "localhost" TL.unpack $ Map.lookup "host" params -: - -:f DBus/Connection.hs - unknownFamily x = TL.concat ["Unknown socket family for TCP transport: ", x] - getFamily = case Map.lookup "family" params of - Just "ipv4" -> return NS.AF_INET - Just "ipv6" -> return NS.AF_INET6 - Nothing -> return NS.AF_UNSPEC - Just x -> E.throwIO $ BadParameters a $ unknownFamily x -: - -:f DBus/Connection.hs - missingPort = "TCP transport requires the ``port'' parameter." - badPort x = TL.concat ["Invalid socket port for TCP transport: ", x] - getPort = case Map.lookup "port" params of - Nothing -> E.throwIO $ BadParameters a missingPort - Just x -> case P.parse parseWord16 "" (TL.unpack x) of - Right x' -> return $ NS.PortNum x' - Left _ -> E.throwIO $ BadParameters a $ badPort x + addrs <- getAddresses family + sock<- openSocket port addrs + Network.Socket.socketToHandle sock System.IO.ReadWriteMode + hostname = maybe "localhost" Data.Text.unpack (param "host") + unknownFamily x = concat ["Unknown socket family for TCP transport: ", show x] + getFamily = case param "family" of + Just "ipv4" -> return Network.Socket.AF_INET + Just "ipv6" -> return Network.Socket.AF_INET6 + Nothing -> return Network.Socket.AF_UNSPEC + Just x -> connectionError (unknownFamily x) + missingPort = "TCP transport requires the `port' parameter." + badPort x = concat ["Invalid socket port for TCP transport: ", show x] + getPort = case param "port" of + Nothing -> connectionError missingPort + Just x -> case parse parseWord16 "" (Data.Text.unpack x) of + Right x' -> return (Network.Socket.PortNum x') + Left _ -> connectionError (badPort x) : Parsing the port is a bit complicated; assuming every character is an ASCII @@ -189,17 +434,10 @@ {\tt PortNumber} is expected to be in big-endian byte order, so the parsed value must be converted from host order using {\tt Data.Binary}. -:d connection imports -import qualified Text.ParserCombinators.Parsec as P -import Control.Monad (unless) -import Data.Binary.Get (runGet, getWord16host) -import Data.Binary.Put (runPut, putWord16be) -: - -:f DBus/Connection.hs +:d DBus.Connection.Transport parseWord16 = do - chars <- P.many1 P.digit - P.eof + chars <- many1 digit + eof let value = read chars :: Integer unless (value > 0 && value <= 65535) $ -- Calling 'fail' is acceptable here, because Parsec 2 @@ -207,26 +445,26 @@ -- implements 'fail'. fail "bad port" let word = fromIntegral value - return $ runGet getWord16host (runPut (putWord16be word)) + return (Data.Binary.Get.runGet Data.Binary.Get.getWord16host (Data.Binary.Put.runPut (Data.Binary.Put.putWord16be word))) : -:f DBus/Connection.hs +:d DBus.Connection.Transport getAddresses family = do - let hints = NS.defaultHints - { NS.addrFlags = [NS.AI_ADDRCONFIG] - , NS.addrFamily = family - , NS.addrSocketType = NS.Stream + let hints = Network.Socket.defaultHints + { Network.Socket.addrFlags = [Network.Socket.AI_ADDRCONFIG] + , Network.Socket.addrFamily = family + , Network.Socket.addrSocketType = Network.Socket.Stream } - NS.getAddrInfo (Just hints) (Just hostname) Nothing + Network.Socket.getAddrInfo (Just hints) (Just hostname) Nothing : The {\tt SockAddr} values returned from {\tt getAddrInfo} don't have any port set, so it must be manually changed to whatever was in the {\tt port} option. -:f DBus/Connection.hs - setPort port (NS.SockAddrInet _ x) = NS.SockAddrInet port x - setPort port (NS.SockAddrInet6 _ x y z) = NS.SockAddrInet6 port x y z +:d DBus.Connection.Transport + setPort port (Network.Socket.SockAddrInet _ x) = Network.Socket.SockAddrInet port x + setPort port (Network.Socket.SockAddrInet6 _ x y z) = Network.Socket.SockAddrInet6 port x y z setPort _ addr = addr : @@ -234,114 +472,110 @@ until a valid address is found. If none are found, or are usable, an exception will be thrown. -:f DBus/Connection.hs - openSocket _ [] = E.throwIO $ NoWorkingAddress [a] - openSocket port (addr:addrs) = E.catch (openSocket' port addr) $ - \(E.SomeException _) -> openSocket port addrs +:d DBus.Connection.Transport + openSocket _ [] = connectionError ("Failed to open socket to address " ++ show a) + openSocket port (addr:addrs) = Control.Exception.catch (openSocket' port addr) $ + \(Control.Exception.SomeException _) -> openSocket port addrs openSocket' port addr = do - sock <- NS.socket (NS.addrFamily addr) - (NS.addrSocketType addr) - (NS.addrProtocol addr) - NS.connect sock . setPort port . NS.addrAddress $ addr + sock <- Network.Socket.socket (Network.Socket.addrFamily addr) + (Network.Socket.addrSocketType addr) + (Network.Socket.addrProtocol addr) + Network.Socket.connect sock . setPort port . Network.Socket.addrAddress $ addr return sock : -\subsubsection{Generic handle-based transport} +\clearpage +\subsection{Authentication} -Both UNIX and TCP are backed by standard handles, and can therefore use -a shared handle-based transport backend. +\begin{multicols}{2} -:d connection imports -import qualified System.IO as I -: +TODO -:f DBus/Connection.hs -handleTransport :: I.Handle -> IO Transport -handleTransport h = do - I.hSetBuffering h I.NoBuffering - I.hSetBinaryMode h True - return $ Transport (L.hPut h) (L.hGet h . fromIntegral) (I.hClose h) -: +\vfill +\columnbreak -\subsection{Errors} +:d DBus.Connection.Authentication +authenticate :: Socket + -> [Mechanism] + -> IO Bool +authenticate s mechanisms = do + socketPut s (Data.ByteString.pack [0]) + let loop [] = return False + loop ((Mechanism m):next) = do + success <- m s + if success + then return True + else loop next + loop mechanisms +: -If connecting to D-Bus fails, a {\tt ConnectionError} will be thrown. -The constructor describes which exception occurred. +:d DBus.Connection.Authentication +newtype Mechanism = Mechanism (Socket -> IO Bool) -:d connection imports -import qualified Control.Exception as E -import Data.Typeable (Typeable) -: +mechanism :: (Socket -> IO Bool) -> Mechanism +mechanism = Mechanism -:f DBus/Connection.hs -data ConnectionError - = InvalidAddress Text - | BadParameters A.Address Text - | UnknownMethod A.Address - | NoWorkingAddress [A.Address] - deriving (Show, Typeable) +data Auth a = Auth + { unAuth :: Socket -> IO a + } -instance E.Exception ConnectionError -: +instance Monad Auth where + return a = Auth (\_ -> return a) + m >>= k = Auth $ \s -> do + x <- unAuth m s + unAuth (k x) s -:d connection exports -, ConnectionError (..) +liftIO :: IO a -> Auth a +liftIO io = Auth (\_ -> io) : -\subsection{Establishing a connection} +\end{multicols} -A connection can be opened to any valid address, though actually connecting -might fail due to external factors. +\begin{multicols}{2} -:d connection imports -import qualified DBus.Authentication as Auth -: +The authentication protocol is based on {\sc ascii} text. -:f DBus/Connection.hs -|apidoc connect| -connect :: Auth.Mechanism -> A.Address -> IO Connection -connect mechanism a = do - t <- connectTransport a - let getByte = L.head `fmap` transportRecv t 1 - uuid <- Auth.authenticate mechanism (transportSend t) getByte - readLock <- C.newMVar () - serialMVar <- C.newMVar M.firstSerial - return $ Connection a t serialMVar readLock uuid -: +\vfill +\columnbreak -Since addresses usually come in a list, it's sensible to have a variant -of {\tt connect} which tries multiple addresses. The first successfully -opened {\tt Connection} is returned. +:d DBus.Connection.Authentication +putLine :: String -> Auth () +putLine line = Auth $ \s -> do + let pack = Data.ByteString.Char8.pack + socketPut s (pack (line ++ "\r\n")) -:f DBus/Connection.hs -|apidoc connectFirst| -connectFirst :: [(Auth.Mechanism, A.Address)] -> IO Connection -connectFirst orig = connectFirst' orig where - allAddrs = [a | (_, a) <- orig] - connectFirst' [] = E.throwIO $ NoWorkingAddress allAddrs - connectFirst' ((mech, a):as) = E.catch (connect mech a) $ - \(E.SomeException _) -> connectFirst' as +getLine :: Auth String +getLine = Auth $ \s -> do + let head = Data.ByteString.Char8.head + let getchr = liftM head (socketGet s 1) + raw <- readUntil "\r\n" getchr + return (dropEnd 2 raw) : -:d connection exports -, connect -, connectFirst -: +\end{multicols} -\subsection{Closing connections} +\clearpage +\subsubsection{EXTERNAL} -:f DBus/Connection.hs -|apidoc connectionClose| -connectionClose :: Connection -> IO () -connectionClose = transportClose . connectionTransport -: +Although the official spec describes only the {\tt DBUS\_COOKIE\_SHA1} +mechanism, I have never seen it used in real life. Everything actually uses +{\tt EXTERNAL}, so that's what this library implements. -:d connection exports -, connectionClose +:d DBus.Connection.Authentication +external :: Mechanism +external = Mechanism $ unAuth $ do + uid <- liftIO System.Posix.User.getRealUserID + let token = concatMap (printf "%02X" . ord) (show uid) + putLine ("AUTH EXTERNAL " ++ token) + resp <- getLine + case takeWhile (/= ' ') resp of + "OK" -> do + putLine "BEGIN" + return True + _ -> return False : -:i authentication.anansi - +\clearpage \subsection{Sending and receiving messages} Sending a message will increment the connection's internal serial state. @@ -349,47 +583,34 @@ the message has actually been sent, which avoids race conditions in multi-threaded clients. -:d connection imports -import qualified DBus.Wire as W -: - -:f DBus/Connection.hs -|apidoc send| -send :: M.Message a => Connection -> (M.Serial -> IO b) -> a - -> IO (Either W.MarshalError b) -send (Connection _ t mvar _ _) io msg = withSerial mvar $ \serial -> - case W.marshalMessage W.LittleEndian serial msg of +:d DBus.Connection +|apidoc DBus.Connection.send| +send :: Message msg => Connection -> msg -> (Serial -> IO a) -> IO (Either MarshalError a) +send connection msg io = do + serial <- nextSerial connection + case marshalMessage LittleEndian serial msg of Right bytes -> do - x <- io serial - transportSend t bytes - return $ Right x - Left err -> return $ Left err -: - -:d connection exports -, send -: + let sock = connectionSocket connection + let lock = connectionWriteLock connection + result <- io serial + withMVar lock (\_ -> socketPut sock bytes) + return (Right result) + Left err -> return (Left err) -:f DBus/Connection.hs -withSerial :: C.MVar M.Serial -> (M.Serial -> IO a) -> IO a -withSerial m io = E.block $ do - s <- C.takeMVar m - let s' = M.nextSerial s - x <- E.unblock (io s) `E.onException` C.putMVar m s' - C.putMVar m s' - return x +nextSerial :: Connection -> IO Serial +nextSerial connection = atomicModifyIORef + (connectionSerial connection) + (\serial@(Serial x) -> (Serial (x + 1), serial)) : Messages are received wrapped in a {\tt ReceivedMessage} value. If an error is encountered while unmarshaling, an exception will be thrown. -:f DBus/Connection.hs -|apidoc receive| -receive :: Connection -> IO (Either W.UnmarshalError M.ReceivedMessage) -receive (Connection _ t _ lock _) = C.withMVar lock $ \_ -> - W.unmarshalMessage $ transportRecv t -: - -:d connection exports -, receive +:d DBus.Connection +|apidoc DBus.Connection.receive| +receive :: Connection -> IO (Either UnmarshalError ReceivedMessage) +receive connection = do + let sock = connectionSocket connection + let lock = connectionReadLock connection + withMVar lock (\_ -> unmarshalMessageM (socketGet sock)) : diff --git a/src/constants.anansi b/src/constants.anansi --- a/src/constants.anansi +++ b/src/constants.anansi @@ -13,174 +13,177 @@ :# You should have received a copy of the GNU General Public License :# along with this program. If not, see . -\section{Constants} - -:f DBus/Constants.hs -|copyright| -{-# LANGUAGE OverloadedStrings #-} -module DBus.Constants where -import qualified DBus.Types as T -import Data.Word (Word8, Word32) - -protocolVersion :: Word8 -protocolVersion = 1 - -messageMaximumLength :: Word32 -messageMaximumLength = 134217728 - -arrayMaximumLength :: Word32 -arrayMaximumLength = 67108864 -: +\clearpage +\subsection{Named constants} -\subsection{The message bus} +\subsubsection*{The central bus} -:f DBus/Constants.hs -dbusName :: T.BusName +:d DBus.Constants +dbusName :: BusName dbusName = "org.freedesktop.DBus" -dbusPath :: T.ObjectPath +dbusPath :: ObjectPath dbusPath = "/org/freedesktop/DBus" -dbusInterface :: T.InterfaceName +dbusInterface :: InterfaceName dbusInterface = "org.freedesktop.DBus" : -\subsection{Pre-defined interfaces} +\subsubsection*{Standard interfaces} -:f DBus/Constants.hs -interfaceIntrospectable :: T.InterfaceName +:d DBus.Constants +interfaceIntrospectable :: InterfaceName interfaceIntrospectable = "org.freedesktop.DBus.Introspectable" -interfaceProperties :: T.InterfaceName -interfaceProperties = "org.freedesktop.DBus.Properties" - -interfacePeer :: T.InterfaceName +interfacePeer :: InterfaceName interfacePeer = "org.freedesktop.DBus.Peer" + +interfaceProperties :: InterfaceName +interfaceProperties = "org.freedesktop.DBus.Properties" : -\subsection{Pre-defined error names} +\subsubsection*{Standard errors} +\label{sec:standard-error-names} -:f DBus/Constants.hs -errorFailed :: T.ErrorName -errorFailed = "org.freedesktop.DBus.Error.Failed" +:d DBus.Constants +errorAccessDenied :: ErrorName +errorAccessDenied = "org.freedesktop.DBus.Error.AccessDenied" -errorNoMemory :: T.ErrorName -errorNoMemory = "org.freedesktop.DBus.Error.NoMemory" +errorAuthFailed :: ErrorName +errorAuthFailed = "org.freedesktop.DBus.Error.AuthFailed" -errorServiceUnknown :: T.ErrorName -errorServiceUnknown = "org.freedesktop.DBus.Error.ServiceUnknown" +errorDisconnected :: ErrorName +errorDisconnected = "org.freedesktop.DBus.Error.Disconnected" -errorNameHasNoOwner :: T.ErrorName -errorNameHasNoOwner = "org.freedesktop.DBus.Error.NameHasNoOwner" +errorFailed :: ErrorName +errorFailed = "org.freedesktop.DBus.Error.Failed" -errorNoReply :: T.ErrorName +errorNoReply :: ErrorName errorNoReply = "org.freedesktop.DBus.Error.NoReply" -errorIOError :: T.ErrorName -errorIOError = "org.freedesktop.DBus.Error.IOError" - -errorBadAddress :: T.ErrorName -errorBadAddress = "org.freedesktop.DBus.Error.BadAddress" - -errorNotSupported :: T.ErrorName -errorNotSupported = "org.freedesktop.DBus.Error.NotSupported" - -errorLimitsExceeded :: T.ErrorName -errorLimitsExceeded = "org.freedesktop.DBus.Error.LimitsExceeded" - -errorAccessDenied :: T.ErrorName -errorAccessDenied = "org.freedesktop.DBus.Error.AccessDenied" - -errorAuthFailed :: T.ErrorName -errorAuthFailed = "org.freedesktop.DBus.Error.AuthFailed" - -errorNoServer :: T.ErrorName +errorNoServer :: ErrorName errorNoServer = "org.freedesktop.DBus.Error.NoServer" -errorTimeout :: T.ErrorName +errorTimedOut :: ErrorName +errorTimedOut = "org.freedesktop.DBus.Error.TimedOut" + +errorTimeout :: ErrorName errorTimeout = "org.freedesktop.DBus.Error.Timeout" +: -errorNoNetwork :: T.ErrorName -errorNoNetwork = "org.freedesktop.DBus.Error.NoNetwork" +\subsubsection*{Errors calling methods} -errorAddressInUse :: T.ErrorName -errorAddressInUse = "org.freedesktop.DBus.Error.AddressInUse" +:d DBus.Constants +errorServiceUnknown :: ErrorName +errorServiceUnknown = "org.freedesktop.DBus.Error.ServiceUnknown" -errorDisconnected :: T.ErrorName -errorDisconnected = "org.freedesktop.DBus.Error.Disconnected" +errorUnknownObject :: ErrorName +errorUnknownObject = "org.freedesktop.DBus.Error.UnknownObject" -errorInvalidArgs :: T.ErrorName -errorInvalidArgs = "org.freedesktop.DBus.Error.InvalidArgs" +errorUnknownInterface :: ErrorName +errorUnknownInterface = "org.freedesktop.DBus.Error.UnknownInterface" -errorFileNotFound :: T.ErrorName -errorFileNotFound = "org.freedesktop.DBus.Error.FileNotFound" +errorUnknownMethod :: ErrorName +errorUnknownMethod = "org.freedesktop.DBus.Error.UnknownMethod" -errorFileExists :: T.ErrorName -errorFileExists = "org.freedesktop.DBus.Error.FileExists" +errorInvalidParameters :: ErrorName +errorInvalidParameters = "org.freedesktop.DBus.Error.InvalidParameters" +: -errorUnknownMethod :: T.ErrorName -errorUnknownMethod = "org.freedesktop.DBus.Error.UnknownMethod" +\subsubsection*{Error starting services} -errorTimedOut :: T.ErrorName -errorTimedOut = "org.freedesktop.DBus.Error.TimedOut" +:d DBus.Constants +errorSpawnChildExited :: ErrorName +errorSpawnChildExited = "org.freedesktop.DBus.Error.Spawn.ChildExited" -errorMatchRuleNotFound :: T.ErrorName -errorMatchRuleNotFound = "org.freedesktop.DBus.Error.MatchRuleNotFound" +errorSpawnChildSignaled :: ErrorName +errorSpawnChildSignaled = "org.freedesktop.DBus.Error.Spawn.ChildSignaled" -errorMatchRuleInvalid :: T.ErrorName -errorMatchRuleInvalid = "org.freedesktop.DBus.Error.MatchRuleInvalid" +errorSpawnConfigInvalid :: ErrorName +errorSpawnConfigInvalid = "org.freedesktop.DBus.Error.Spawn.ConfigInvalid" -errorSpawnExecFailed :: T.ErrorName +errorSpawnExecFailed :: ErrorName errorSpawnExecFailed = "org.freedesktop.DBus.Error.Spawn.ExecFailed" -errorSpawnForkFailed :: T.ErrorName +errorSpawnForkFailed :: ErrorName errorSpawnForkFailed = "org.freedesktop.DBus.Error.Spawn.ForkFailed" -errorSpawnChildExited :: T.ErrorName -errorSpawnChildExited = "org.freedesktop.DBus.Error.Spawn.ChildExited" - -errorSpawnChildSignaled :: T.ErrorName -errorSpawnChildSignaled = "org.freedesktop.DBus.Error.Spawn.ChildSignaled" - -errorSpawnFailed :: T.ErrorName +errorSpawnFailed :: ErrorName errorSpawnFailed = "org.freedesktop.DBus.Error.Spawn.Failed" -errorSpawnFailedToSetup :: T.ErrorName +errorSpawnFailedToSetup :: ErrorName errorSpawnFailedToSetup = "org.freedesktop.DBus.Error.Spawn.FailedToSetup" -errorSpawnConfigInvalid :: T.ErrorName -errorSpawnConfigInvalid = "org.freedesktop.DBus.Error.Spawn.ConfigInvalid" +errorSpawnFileInvalid :: ErrorName +errorSpawnFileInvalid = "org.freedesktop.DBus.Error.Spawn.FileInvalid" -errorSpawnServiceNotValid :: T.ErrorName -errorSpawnServiceNotValid = "org.freedesktop.DBus.Error.Spawn.ServiceNotValid" +errorSpawnNoMemory :: ErrorName +errorSpawnNoMemory = "org.freedesktop.DBus.Error.Spawn.NoMemory" -errorSpawnServiceNotFound :: T.ErrorName +errorSpawnPermissionsInvalid :: ErrorName +errorSpawnPermissionsInvalid = "org.freedesktop.DBus.Error.Spawn.PermissionsInvalid" + +errorSpawnServiceNotFound :: ErrorName errorSpawnServiceNotFound = "org.freedesktop.DBus.Error.Spawn.ServiceNotFound" -errorSpawnPermissionsInvalid :: T.ErrorName -errorSpawnPermissionsInvalid = "org.freedesktop.DBus.Error.Spawn.PermissionsInvalid" +errorSpawnServiceNotValid :: ErrorName +errorSpawnServiceNotValid = "org.freedesktop.DBus.Error.Spawn.ServiceNotValid" +: -errorSpawnFileInvalid :: T.ErrorName -errorSpawnFileInvalid = "org.freedesktop.DBus.Error.Spawn.FileInvalid" +\subsubsection*{Other well-known error names} -errorSpawnNoMemory :: T.ErrorName -errorSpawnNoMemory = "org.freedesktop.DBus.Error.Spawn.NoMemory" +:d DBus.Constants +errorAddressInUse :: ErrorName +errorAddressInUse = "org.freedesktop.DBus.Error.AddressInUse" -errorUnixProcessIdUnknown :: T.ErrorName -errorUnixProcessIdUnknown = "org.freedesktop.DBus.Error.UnixProcessIdUnknown" +errorAdtAuditDataUnknown :: ErrorName +errorAdtAuditDataUnknown = "org.freedesktop.DBus.Error.AdtAuditDataUnknown" -errorInvalidFileContent :: T.ErrorName +errorBadAddress :: ErrorName +errorBadAddress = "org.freedesktop.DBus.Error.BadAddress" + +errorFileExists :: ErrorName +errorFileExists = "org.freedesktop.DBus.Error.FileExists" + +errorFileNotFound :: ErrorName +errorFileNotFound = "org.freedesktop.DBus.Error.FileNotFound" + +errorInconsistentMessage :: ErrorName +errorInconsistentMessage = "org.freedesktop.DBus.Error.InconsistentMessage" + +errorInvalidFileContent :: ErrorName errorInvalidFileContent = "org.freedesktop.DBus.Error.InvalidFileContent" -errorSELinuxSecurityContextUnknown :: T.ErrorName -errorSELinuxSecurityContextUnknown = "org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown" +errorIOError :: ErrorName +errorIOError = "org.freedesktop.DBus.Error.IOError" -errorAdtAuditDataUnknown :: T.ErrorName -errorAdtAuditDataUnknown = "org.freedesktop.DBus.Error.AdtAuditDataUnknown" +errorLimitsExceeded :: ErrorName +errorLimitsExceeded = "org.freedesktop.DBus.Error.LimitsExceeded" -errorObjectPathInUse :: T.ErrorName +errorMatchRuleInvalid :: ErrorName +errorMatchRuleInvalid = "org.freedesktop.DBus.Error.MatchRuleInvalid" + +errorMatchRuleNotFound :: ErrorName +errorMatchRuleNotFound = "org.freedesktop.DBus.Error.MatchRuleNotFound" + +errorNameHasNoOwner :: ErrorName +errorNameHasNoOwner = "org.freedesktop.DBus.Error.NameHasNoOwner" + +errorNoMemory :: ErrorName +errorNoMemory = "org.freedesktop.DBus.Error.NoMemory" + +errorNoNetwork :: ErrorName +errorNoNetwork = "org.freedesktop.DBus.Error.NoNetwork" + +errorNotSupported :: ErrorName +errorNotSupported = "org.freedesktop.DBus.Error.NotSupported" + +errorObjectPathInUse :: ErrorName errorObjectPathInUse = "org.freedesktop.DBus.Error.ObjectPathInUse" -errorInconsistentMessage :: T.ErrorName -errorInconsistentMessage = "org.freedesktop.DBus.Error.InconsistentMessage" +errorSELinuxSecurityContextUnknown :: ErrorName +errorSELinuxSecurityContextUnknown = "org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown" + +errorUnixProcessIdUnknown :: ErrorName +errorUnixProcessIdUnknown = "org.freedesktop.DBus.Error.UnixProcessIdUnknown" : diff --git a/src/dbus-core.anansi b/src/dbus-core.anansi --- a/src/dbus-core.anansi +++ b/src/dbus-core.anansi @@ -1,4 +1,4 @@ -:# Copyright (C) 2009-2010 John Millikin +:# Copyright (C) 2009-2011 John Millikin :# :# 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 @@ -13,43 +13,103 @@ :# You should have received a copy of the GNU General Public License :# along with this program. If not, see . -\documentclass[12pt]{article} +:option tab-size 4 +\documentclass{article} + \usepackage{color} \usepackage{hyperref} +\usepackage{indentfirst} +\usepackage{amsmath} +\usepackage{multicol} +\usepackage{comment} \usepackage{booktabs} \usepackage{multirow} -\usepackage{noweb} -\usepackage{url} +\usepackage[titles]{tocloft} +\usepackage{graphicx} -:# Smaller margins -\usepackage[left=1.5cm,top=2cm,right=1.5cm,nohead,nofoot]{geometry} +\usepackage{latex/noweb} +\usepackage[margin=2cm]{latex/geometry} -:# Remove boxes from hyperlinks +\usepackage{titlesec} + +\newcommand{\dbus}{\mbox{D-Bus}} + +% Remove boxes from hyperlinks \hypersetup{ colorlinks, linkcolor=blue, } +% Smaller spacing between ToC sections +\setlength{\cftbeforesecskip}{0.7em} + +% No extra margins in code blocks +\codemargin=0pt + +\title{dbus\_0.9} +\author{John Millikin\\ + \href{mailto:"John Millikin" }{\tt jmillikin@gmail.com}} +\date{July 14, 2011} + \makeindex +\setcounter{tocdepth}{2} + \begin{document} -\addcontentsline{toc}{section}{Contents} +\newgeometry{left=1.5cm,top=2cm,right=1.5cm} + +\maketitle + +\setlength{\parskip}{5pt plus 1pt} +\setlength{\columnsep}{0.8cm} + +\begin{multicols}{2} + +:include summary.anansi + +\columnbreak + +\setlength{\parskip}{0pt plus 1pt} \tableofcontents +\setlength{\parskip}{4pt plus 1pt} +\end{multicols} +\restoregeometry + +\newpage :i introduction.anansi + +\newpage :i types.anansi + +\newpage :i messages.anansi + +\newpage :i wire.anansi -:i addresses.anansi + +\newpage :i connections.anansi -:i bus.anansi + +\newpage +:i client.anansi + +\newpage :i introspection.anansi -:i match-rules.anansi -:i name-reservation.anansi + +\newpage +:i utilities.anansi :i constants.anansi -:i util.anansi + +\newpage +\appendix +:i module-headers.anansi + +% exclude API docs from LaTeX output, since they're generally uninteresting +\begin{comment} :i api-docs.anansi +\end{comment} \end{document} diff --git a/src/introduction.anansi b/src/introduction.anansi --- a/src/introduction.anansi +++ b/src/introduction.anansi @@ -1,33 +1,38 @@ -:# Copyright (C) 2009-2010 John Millikin -:# -:# 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 -:# 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 . - \section{Introduction} -D-Bus is a low-latency, asynchronous IPC protocol. It is primarily used on -Linux, BSD, and other free UNIX-like systems. More information is available -at \url{http://dbus.freedesktop.org/}. +On modern desktop systems, applications need to communicate with one another; +for example, a movie player can disable the screensaver, or a music player can +be notified when the user inserts a CD-ROM. In the early years of the Linux +desktop, this Inter-Process Communication (IPC) was performed through a +variety of ad hoc mechanisms. D-Bus is a simple, standardized IPC mechanism +intended to replace and obsolete all of these older technologies. -This package is an implementation of the D-Bus protocol. It is intended -for use in either a client or server, though currently only the client -portion of connection establishment is implemented. Additionally, it -implements the introspection file format. +In contrast to earlier IPC protocols, which are typically byte-based, D-Bus +allows applications to send strongly-typed data structures named +{\em messages}. Applications may expose an object-oriented API to the user's +session, the entire system, or even remote systems. This brings the full power +of object-oriented programming to IPC; for example, many applications can +implement a standardized {\em interface} to seamlessly interoperate with any +client written against that interface. -All source code is licensed under the terms of the GNU GPL v3 or later. +\begin{center} +\includegraphics{latex/figure_1.eps} +\end{center} +This library is an implementation of the D-Bus protocol in pure Haskell. It +can be used to add D-Bus support to Haskell applications, without the awkward +interfaces common to foreign bindings. The literate portions (the part you're +reading right now) are written for intermediate or advanced Haskell +programmers, who may not be familiar with D-Bus. It might also be of use to +programmers interested in implementing D-Bus in other functional languages, +such as ML. + +Documentation is licensed under CC-BY-SA 3.0. Source code is +licensed under the GNU GPL v3 or later: + +\begin{quote} :d copyright --- Copyright (C) 2009-2010 John Millikin +-- Copyright (C) 2009-2011 John Millikin -- -- 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 @@ -42,35 +47,4 @@ -- You should have received a copy of the GNU General Public License -- along with this program. If not, see . : - -\section{Text values} - -Most of the functions in this library use the types and functions defined -in {\tt Data.Text}, in preference to the {\tt String} type. - -:d text extensions -{-# LANGUAGE OverloadedStrings #-} -: - -:d text imports -import Data.Text.Lazy (Text) -import qualified Data.Text.Lazy as TL -: - -Tests are separated into a separate file, which is optionally compiled but -not included in the library. - -:f Tests.hs -|copyright| -|text extensions| -module Main (tests, main) where -|test imports| - -tests :: [F.Test] -tests = [ F.testGroup "dummy" [] - |test cases| - ] - -main :: IO () -main = F.defaultMain tests -: +\end{quote} diff --git a/src/introspection.anansi b/src/introspection.anansi --- a/src/introspection.anansi +++ b/src/introspection.anansi @@ -40,28 +40,9 @@ \end{verbatim} -:f DBus/Introspection.hs -|copyright| -|text extensions| -module DBus.Introspection - ( Object (..) - , Interface (..) - , Method (..) - , Signal (..) - , Parameter (..) - , Property (..) - , PropertyAccess (..) - , toXML - , fromXML - ) where -|text imports| -|introspection imports| -import qualified DBus.Types as T -: - -\subsection{Data types} +\subsection*{Data types} -:f DBus/Introspection.hs +:d DBus.Introspection data Object = Object T.ObjectPath [Interface] [Object] deriving (Show, Eq) @@ -84,13 +65,13 @@ deriving (Show, Eq) : -\subsection{Parsing XML} +\subsection*{Parsing XML} If parsing fails, {\tt fromXML} will return {\tt Nothing}. Aside from the elements directly accessed by the parser, no effort is made to check the document's validity because there is no DTD as of yet. -:f DBus/Introspection.hs +:d DBus.Introspection fromXML :: T.ObjectPath -> Text -> Maybe Object fromXML path text = do root <- parseElement text @@ -101,18 +82,13 @@ events. DBus's introspection format doesn't use any character data, so only the element attributes and nesting are preserved. -:d introspection imports -import qualified Data.XML.Types as X -import qualified Text.XML.LibXML.SAX as SAX -import Control.Monad.ST (runST) -import qualified Data.STRef as ST -: - -:f DBus/Introspection.hs +:d DBus.Introspection parseElement :: Text -> Maybe X.Element parseElement text = runST $ do stackRef <- ST.newSTRef [([], [])] - let onError _ = ST.writeSTRef stackRef [] + let onError _ = do + ST.writeSTRef stackRef [] + return False let onBegin _ attrs = do ST.modifySTRef stackRef ((attrs, []):) return True @@ -125,10 +101,11 @@ ST.writeSTRef stackRef (parent:stack'') return True - p <- SAX.newParserST onError Nothing + p <- SAX.newParserST Nothing SAX.setCallback p SAX.parsedBeginElement onBegin SAX.setCallback p SAX.parsedEndElement onEnd - SAX.parseLazyText p text + SAX.setCallback p SAX.reportError onError + SAX.parseBytes p (Data.Text.Encoding.encodeUtf8 text) SAX.parseComplete p stack <- ST.readSTRef stackRef return $ case stack of @@ -143,12 +120,12 @@ Even though the root object's {\tt name} is optional, if present, it must still be a valid object path. -:f DBus/Introspection.hs +:d DBus.Introspection parseRoot :: T.ObjectPath -> X.Element -> Maybe Object parseRoot defaultPath e = do - path <- case getattrM "name" e of + path <- case X.attributeText "name" e of Nothing -> Just defaultPath - Just x -> T.mkObjectPath x + Just x -> T.objectPath x parseObject path e : @@ -156,48 +133,48 @@ attribute is not a valid object path, but should be valid when appended to the root object's path. -:f DBus/Introspection.hs +:d DBus.Introspection parseChild :: T.ObjectPath -> X.Element -> Maybe Object parseChild parentPath e = do - let parentPath' = case T.strObjectPath parentPath of + let parentPath' = case T.objectPathText parentPath of "/" -> "/" - x -> TL.append x "/" - pathSegment <- getattrM "name" e - path <- T.mkObjectPath $ TL.append parentPath' pathSegment + x -> Data.Text.append x "/" + pathSegment <- X.attributeText "name" e + path <- T.objectPath $ Data.Text.append parentPath' pathSegment parseObject path e : Other than the name, both root and non-root {\tt nodes} have identical contents. They may contain interface definitions, and child {\tt node}s. -:f DBus/Introspection.hs +:d DBus.Introspection parseObject :: T.ObjectPath -> X.Element -> Maybe Object -parseObject path e | X.elementName e == toName "node" = do - interfaces <- children parseInterface (named "interface") e - children' <- children (parseChild path) (named "node") e +parseObject path e | X.elementName e == "node" = do + interfaces <- children parseInterface (X.isNamed "interface") e + children' <- children (parseChild path) (X.isNamed "node") e return $ Object path interfaces children' parseObject _ _ = Nothing : Interfaces may contain methods, signals, and properties. -:f DBus/Introspection.hs +:d DBus.Introspection parseInterface :: X.Element -> Maybe Interface parseInterface e = do - name <- T.mkInterfaceName =<< getattrM "name" e - methods <- children parseMethod (named "method") e - signals <- children parseSignal (named "signal") e - properties <- children parseProperty (named "property") e + name <- T.interfaceName =<< X.attributeText "name" e + methods <- children parseMethod (X.isNamed "method") e + signals <- children parseSignal (X.isNamed "signal") e + properties <- children parseProperty (X.isNamed "property") e return $ Interface name methods signals properties : Methods contain a list of parameters, which default to ``in'' parameters if no direction is specified. -:f DBus/Introspection.hs +:d DBus.Introspection parseMethod :: X.Element -> Maybe Method parseMethod e = do - name <- T.mkMemberName =<< getattrM "name" e + name <- T.memberName =<< X.attributeText "name" e paramsIn <- children parseParameter (isParam ["in", ""]) e paramsOut <- children parseParameter (isParam ["out"]) e return $ Method name paramsIn paramsOut @@ -205,37 +182,33 @@ Signals are similar to methods, except they have no ``in'' parameters. -:f DBus/Introspection.hs +:d DBus.Introspection parseSignal :: X.Element -> Maybe Signal parseSignal e = do - name <- T.mkMemberName =<< getattrM "name" e + name <- T.memberName =<< X.attributeText "name" e params <- children parseParameter (isParam ["out", ""]) e return $ Signal name params : A parameter has a free-form name, and a single valid type. -:f DBus/Introspection.hs +:d DBus.Introspection +parseType :: X.Element -> Maybe T.Signature +parseType e = X.attributeText "type" e >>= T.signature + parseParameter :: X.Element -> Maybe Parameter parseParameter e = do let name = getattr "name" e sig <- parseType e - return $ Parameter name sig -: - -:f DBus/Introspection.hs -parseType :: X.Element -> Maybe T.Signature -parseType e = do - sig <- T.mkSignature =<< getattrM "type" e case T.signatureTypes sig of - [_] -> Just sig - _ -> Nothing + [_] -> Just (Parameter name sig) + _ -> Nothing : Properties are used by the {\tt org.freedesktop.DBus.Properties} interface. Each property may be read, written, or both, and has an associated type. -:f DBus/Introspection.hs +:d DBus.Introspection parseProperty :: X.Element -> Maybe Property parseProperty e = do let name = getattr "name" e @@ -249,36 +222,19 @@ return $ Property name sig access : -:d introspection imports -import Control.Monad ((>=>)) -import Data.Maybe (fromMaybe, listToMaybe) -: - -:f DBus/Introspection.hs -getattrM :: Text -> X.Element -> Maybe Text -getattrM name = fmap attrText . listToMaybe . attrs where - attrText = textContent . X.attributeContent - attrs = X.elementAttributes >=> X.isNamed (toName name) - textContent cs = TL.concat [t | X.ContentText t <- cs] - -getattr :: Text -> X.Element -> Text -getattr = (fromMaybe "" .) . getattrM +:d DBus.Introspection +getattr :: X.Name -> X.Element -> Text +getattr = (fromMaybe "" .) . X.attributeText isParam :: [Text] -> X.Element -> [X.Element] -isParam dirs = named "arg" >=> checkDir where +isParam dirs = X.isNamed "arg" >=> checkDir where checkDir e = [e | getattr "direction" e `elem` dirs] children :: Monad m => (X.Element -> m b) -> (X.Element -> [X.Element]) -> X.Element -> m [b] children f p = mapM f . concatMap p . X.elementChildren - -named :: X.Named a => Text -> a -> [a] -named = X.isNamed . toName - -toName :: Text -> X.Name -toName t = X.Name t Nothing Nothing : -\subsection{Generating XML} +\subsection*{Generating XML} Generating XML can fail; if a child object's path is not a sub-path of the parent, {\tt toXML} will return {\tt Nothing}. @@ -288,46 +244,46 @@ except I didn't want to drag in a dependency on {\tt transformers} for such a little thing. -:f DBus/Introspection.hs +:d DBus.Introspection newtype XmlWriter a = XmlWriter { runXmlWriter :: Maybe (a, Text) } instance Monad XmlWriter where - return a = XmlWriter $ Just (a, TL.empty) + return a = XmlWriter $ Just (a, Data.Text.empty) m >>= f = XmlWriter $ do (a, w) <- runXmlWriter m (b, w') <- runXmlWriter (f a) - return (b, TL.append w w') + return (b, Data.Text.append w w') : -:f DBus/Introspection.hs +:d DBus.Introspection tell :: Text -> XmlWriter () tell t = XmlWriter $ Just ((), t) : -:f DBus/Introspection.hs +:d DBus.Introspection toXML :: Object -> Maybe Text toXML obj = do (_, text) <- runXmlWriter (writeRoot obj) return text : -:f DBus/Introspection.hs +:d DBus.Introspection writeRoot :: Object -> XmlWriter () writeRoot obj@(Object path _ _) = do tell "\n" - writeObject (T.strObjectPath path) obj + writeObject (T.objectPathText path) obj : -:f DBus/Introspection.hs +:d DBus.Introspection writeChild :: T.ObjectPath -> Object -> XmlWriter () writeChild parentPath obj@(Object path _ _) = write where - path' = T.strObjectPath path - parent' = T.strObjectPath parentPath - relpathM = if TL.isPrefixOf parent' path' + path' = T.objectPathText path + parent' = T.objectPathText parentPath + relpathM = if Data.Text.isPrefixOf parent' path' then Just $ if parent' == "/" - then TL.drop 1 path' - else TL.drop (TL.length parent' + 1) path' + then Data.Text.drop 1 path' + else Data.Text.drop (Data.Text.length parent' + 1) path' else Nothing write = case relpathM of @@ -335,7 +291,7 @@ Nothing -> XmlWriter Nothing : -:f DBus/Introspection.hs +:d DBus.Introspection writeObject :: Text -> Object -> XmlWriter () writeObject path (Object fullPath interfaces children') = writeElement "node" [("name", path)] $ do @@ -343,56 +299,56 @@ mapM_ (writeChild fullPath) children' : -:f DBus/Introspection.hs +:d DBus.Introspection writeInterface :: Interface -> XmlWriter () writeInterface (Interface name methods signals properties) = writeElement "interface" - [("name", T.strInterfaceName name)] $ do + [("name", T.interfaceNameText name)] $ do mapM_ writeMethod methods mapM_ writeSignal signals mapM_ writeProperty properties : -:f DBus/Introspection.hs +:d DBus.Introspection writeMethod :: Method -> XmlWriter () writeMethod (Method name inParams outParams) = writeElement "method" - [("name", T.strMemberName name)] $ do + [("name", T.memberNameText name)] $ do mapM_ (writeParameter "in") inParams mapM_ (writeParameter "out") outParams : -:f DBus/Introspection.hs +:d DBus.Introspection writeSignal :: Signal -> XmlWriter () writeSignal (Signal name params) = writeElement "signal" - [("name", T.strMemberName name)] $ do + [("name", T.memberNameText name)] $ do mapM_ (writeParameter "out") params : -:f DBus/Introspection.hs +:d DBus.Introspection writeParameter :: Text -> Parameter -> XmlWriter () writeParameter direction (Parameter name sig) = writeEmptyElement "arg" [ ("name", name) - , ("type", T.strSignature sig) + , ("type", T.signatureText sig) , ("direction", direction) ] : -:f DBus/Introspection.hs +:d DBus.Introspection writeProperty :: Property -> XmlWriter () writeProperty (Property name sig access) = writeEmptyElement "property" [ ("name", name) - , ("type", T.strSignature sig) + , ("type", T.signatureText sig) , ("access", strAccess access) ] : -:f DBus/Introspection.hs +:d DBus.Introspection strAccess :: [PropertyAccess] -> Text -strAccess access = TL.append readS writeS where +strAccess access = Data.Text.append readS writeS where readS = if elem Read access then "read" else "" writeS = if elem Write access then "write" else "" : -:f DBus/Introspection.hs +:d DBus.Introspection writeElement :: Text -> [(Text, Text)] -> XmlWriter () -> XmlWriter () writeElement name attrs content = do tell "<" @@ -405,7 +361,7 @@ tell ">" : -:f DBus/Introspection.hs +:d DBus.Introspection writeEmptyElement :: Text -> [(Text, Text)] -> XmlWriter () writeEmptyElement name attrs = do tell "<" @@ -414,7 +370,7 @@ tell "/>" : -:f DBus/Introspection.hs +:d DBus.Introspection writeAttribute :: (Text, Text) -> XmlWriter () writeAttribute (name, content) = do tell " " @@ -424,92 +380,14 @@ tell "'" : -:f DBus/Introspection.hs +:d DBus.Introspection escape :: Text -> Text -escape = TL.concatMap escapeChar where +escape = Data.Text.concatMap escapeChar where escapeChar c = case c of '&' -> "&" '<' -> "<" '>' -> ">" '"' -> """ '\'' -> "'" - _ -> TL.singleton c -: - -\subsection{Test support} - -:f Tests.hs -subObject :: ObjectPath -> Gen I.Object -subObject parentPath = sized $ \n -> resize (min n 4) $ do - let nonRoot = do - x <- arbitrary - case strObjectPath x of - "/" -> nonRoot - x' -> return x' - - thisPath <- nonRoot - let path' = case strObjectPath parentPath of - "/" -> thisPath - x -> TL.append x thisPath - let path = mkObjectPath_ path' - ifaces <- arbitrary - children <- halfSized . listOf . subObject $ path - return $ I.Object path ifaces children - -instance Arbitrary I.Object where - arbitrary = arbitrary >>= subObject - -instance Arbitrary I.Interface where - arbitrary = do - name <- arbitrary - methods <- arbitrary - signals <- arbitrary - properties <- arbitrary - return $ I.Interface name methods signals properties - -instance Arbitrary I.Method where - arbitrary = do - name <- arbitrary - inParams <- arbitrary - outParams <- arbitrary - return $ I.Method name inParams outParams - -instance Arbitrary I.Signal where - arbitrary = do - name <- arbitrary - params <- arbitrary - return $ I.Signal name params - -singleType :: Gen Signature -singleType = do - t <- arbitrary - case mkSignature $ typeCode t of - Just x -> return x - Nothing -> singleType - -instance Arbitrary I.Parameter where - arbitrary = do - name <- listOf $ arbitrary `suchThat` isPrint - sig <- singleType - return $ I.Parameter (TL.pack name) sig - -instance Arbitrary I.Property where - arbitrary = do - name <- listOf $ arbitrary `suchThat` isPrint - sig <- singleType - access <- elements - [[], [I.Read], [I.Write], - [I.Read, I.Write]] - return $ I.Property (TL.pack name) sig access -: - -:d test cases -, F.testGroup "Introspection" - [ testProperty "Generate -> Parse" - $ \x@(I.Object path _ _) -> let - xml = I.toXML x - Just xml' = xml - parsed = I.fromXML path xml' - in isJust xml ==> I.fromXML path xml' == Just x - ] + _ -> Data.Text.singleton c : diff --git a/src/match-rules.anansi b/src/match-rules.anansi deleted file mode 100644 --- a/src/match-rules.anansi +++ /dev/null @@ -1,244 +0,0 @@ -:# Copyright (C) 2009-2010 John Millikin -:# -:# 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 -:# 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 . - -\section{Match rules} - -Match rules are used to indicate that the client is interested in messages -matching a particular filter. This module provides an interface for building -match rule strings. Eventually, it will support parsing them also. - -:f DBus/MatchRule.hs -|copyright| -|text extensions| -module DBus.MatchRule ( - MatchRule (..) - , MessageType (..) - , ParameterValue (..) - , formatRule - , addMatch - , matchAll - , matches - ) where -|text imports| -import Data.Word (Word8) -import Data.Maybe (fromMaybe, mapMaybe) -import qualified Data.Set as Set -import qualified DBus.Types as T -import qualified DBus.Message as M -import qualified DBus.Constants as C -import DBus.Util (maybeIndex) -: - -:f DBus/MatchRule.hs --- | A match rule is a set of filters; most filters may have one possible --- value assigned, such as a single message type. The exception are parameter --- filters, which are limited in number only by the server implementation. --- -data MatchRule = MatchRule - { matchType :: Maybe MessageType - , matchSender :: Maybe T.BusName - , matchInterface :: Maybe T.InterfaceName - , matchMember :: Maybe T.MemberName - , matchPath :: Maybe T.ObjectPath - , matchDestination :: Maybe T.BusName - , matchParameters :: [ParameterValue] - } - deriving (Show) -: - -:f DBus/MatchRule.hs --- | Parameters may match against two types, strings and object paths. It's --- probably an error to have two values for the same parameter. --- --- The constructor @StringValue 3 \"hello\"@ means that the fourth parameter --- in the message body must be the string @\"hello\"@. @PathValue@ is the --- same, but its value must be an object path. --- -data ParameterValue - = StringValue Word8 Text - | PathValue Word8 T.ObjectPath - deriving (Show, Eq) -: - -:f DBus/MatchRule.hs --- | The set of allowed message types to filter on is separate from the set --- supported for sending over the wire. This allows the server to support --- additional types not yet implemented in the library, or vice-versa. --- -data MessageType - = MethodCall - | MethodReturn - | Signal - | Error - deriving (Show, Eq) -: - -There's currently only one operation to perform on match rules, and that's -to format them. - -:f DBus/MatchRule.hs -|apidoc formatRule| -formatRule :: MatchRule -> Text -formatRule rule = TL.intercalate "," filters where - filters = structureFilters ++ parameterFilters - parameterFilters = map formatParameter $ matchParameters rule - structureFilters = mapMaybe unpack - [ ("type", fmap formatType . matchType) - , ("sender", fmap T.strBusName . matchSender) - , ("interface", fmap T.strInterfaceName . matchInterface) - , ("member", fmap T.strMemberName . matchMember) - , ("path", fmap T.strObjectPath . matchPath) - , ("destination", fmap T.strBusName . matchDestination) - ] - unpack (key, mkValue) = formatFilter' key `fmap` mkValue rule -: - -:f DBus/MatchRule.hs -formatParameter :: ParameterValue -> Text -formatParameter (StringValue index x) = formatFilter' key x where - key = "arg" `TL.append` TL.pack (show index) -formatParameter (PathValue index x) = formatFilter' key value where - key = "arg" `TL.append` TL.pack (show index) `TL.append` "path" - value = T.strObjectPath x -: - -FIXME: what are the escaping rules for match rules? Other bindings don't -seem to perform any escaping at all. - -:f DBus/MatchRule.hs -formatFilter' :: Text -> Text -> Text -formatFilter' key value = TL.concat [key, "='", value, "'"] - -formatType :: MessageType -> Text -formatType MethodCall = "method_call" -formatType MethodReturn = "method_return" -formatType Signal = "signal" -formatType Error = "error" -: - -And since the only real reason for formatting a match rule is to send it, -it's useful to have a message-building function pre-defined. - -:f DBus/MatchRule.hs -|apidoc addMatch| -addMatch :: MatchRule -> M.MethodCall -addMatch rule = M.MethodCall - C.dbusPath - "AddMatch" - (Just C.dbusInterface) - (Just C.dbusName) - Set.empty - [T.toVariant $ formatRule rule] -: - -Most match rules will have only one or two fields filled in, so defining -an empty rule allows clients to set only the fields they care about. - -:f DBus/MatchRule.hs -|apidoc matchAll| -matchAll :: MatchRule -matchAll = MatchRule - { matchType = Nothing - , matchSender = Nothing - , matchInterface = Nothing - , matchMember = Nothing - , matchPath = Nothing - , matchDestination = Nothing - , matchParameters = [] - } -: - -It's useful to match against a rule client-side, eg when listening for -signals. - -:f DBus/MatchRule.hs -|apidoc matches| -matches :: MatchRule -> M.ReceivedMessage -> Bool -matches rule msg = and . mapMaybe ($ rule) $ - [ fmap (typeMatches msg) . matchType - , fmap (senderMatches msg) . matchSender - , fmap (ifaceMatches msg) . matchInterface - , fmap (memberMatches msg) . matchMember - , fmap (pathMatches msg) . matchPath - , fmap (destMatches msg) . matchDestination - , Just . parametersMatch msg . matchParameters - ] -: - -:f DBus/MatchRule.hs -typeMatches :: M.ReceivedMessage -> MessageType -> Bool -typeMatches (M.ReceivedMethodCall _ _ _) MethodCall = True -typeMatches (M.ReceivedMethodReturn _ _ _) MethodReturn = True -typeMatches (M.ReceivedSignal _ _ _) Signal = True -typeMatches (M.ReceivedError _ _ _) Error = True -typeMatches _ _ = False -: - -:f DBus/MatchRule.hs -senderMatches :: M.ReceivedMessage -> T.BusName -> Bool -senderMatches msg name = M.receivedSender msg == Just name -: - -:f DBus/MatchRule.hs -ifaceMatches :: M.ReceivedMessage -> T.InterfaceName -> Bool -ifaceMatches (M.ReceivedMethodCall _ _ msg) name = - Just name == M.methodCallInterface msg -ifaceMatches (M.ReceivedSignal _ _ msg) name = - name == M.signalInterface msg -ifaceMatches _ _ = False -: - -:f DBus/MatchRule.hs -memberMatches :: M.ReceivedMessage -> T.MemberName -> Bool -memberMatches (M.ReceivedMethodCall _ _ msg) name = - name == M.methodCallMember msg -memberMatches (M.ReceivedSignal _ _ msg) name = - name == M.signalMember msg -memberMatches _ _ = False -: - -:f DBus/MatchRule.hs -pathMatches :: M.ReceivedMessage -> T.ObjectPath -> Bool -pathMatches (M.ReceivedMethodCall _ _ msg) path = - path == M.methodCallPath msg -pathMatches (M.ReceivedSignal _ _ msg) path = - path == M.signalPath msg -pathMatches _ _ = False -: - -:f DBus/MatchRule.hs -destMatches :: M.ReceivedMessage -> T.BusName -> Bool -destMatches (M.ReceivedMethodCall _ _ msg) name = - Just name == M.methodCallDestination msg -destMatches (M.ReceivedMethodReturn _ _ msg) name = - Just name == M.methodReturnDestination msg -destMatches (M.ReceivedError _ _ msg) name = - Just name == M.errorDestination msg -destMatches (M.ReceivedSignal _ _ msg) name = - Just name == M.signalDestination msg -destMatches _ _ = False -: - -:f DBus/MatchRule.hs -parametersMatch :: M.ReceivedMessage -> [ParameterValue] -> Bool -parametersMatch _ [] = True -parametersMatch msg values = all validParam values where - body = M.receivedBody msg - validParam (StringValue idx x) = validParam' idx x - validParam (PathValue idx x) = validParam' idx x - validParam' idx x = fromMaybe False $ do - var <- maybeIndex body $ fromIntegral idx - fmap (== x) $ T.fromVariant var -: diff --git a/src/messages.anansi b/src/messages.anansi --- a/src/messages.anansi +++ b/src/messages.anansi @@ -15,140 +15,143 @@ \section{Messages} -To prevent internal details of messages from leaking out to clients, -declarations are contained in an internal module and then re-exported -in the public module. - -:f DBus/Message.hs -|copyright| -module DBus.Message ( - |message exports| - ) where -import DBus.Message.Internal +:d DBus.Message +class Message a where + messageTypeCode :: a -> Word8 + messageHeaderFields :: a -> [HeaderField] + messageFlags :: a -> Set Flag + messageBody :: a -> [Variant] : -:f DBus/Message/Internal.hs -|copyright| -|text extensions| -module DBus.Message.Internal where -|text imports| -import qualified Data.Set as S -import Data.Word (Word8, Word32) -import Data.Maybe (fromMaybe) -import qualified DBus.Types as T -import DBus.Util (maybeIndex) +:d DBus.Message +maybe' :: (a -> b) -> Maybe a -> [b] +maybe' f = maybe [] (\x' -> [f x']) : -:f DBus/Message/Internal.hs -class Message a where - messageTypeCode :: a -> Word8 - messageHeaderFields :: a -> [HeaderField] - messageFlags :: a -> S.Set Flag - messageBody :: a -> [T.Variant] +\subsection{Unknown messages} + +Unknown messages are used for storing information about messages without +a recognised type code. They are not instances of {\tt Message}, because +if they were, then clients could accidentally send invalid messages over +the bus. + +:d DBus.Message +data Unknown = Unknown + { unknownType :: Word8 + , unknownFlags :: Set Flag + , unknownBody :: [Variant] + } + deriving (Show, Eq) : -:d message exports -Message ( messageFlags - , messageBody - ) +\clearpage +\subsection{Header fields} + +\begin{multicols}{2} + +TODO + +\vfill + +\columnbreak + +:d DBus.Message +data HeaderField + = HeaderPath ObjectPath + | HeaderInterface InterfaceName + | HeaderMember MemberName + | HeaderErrorName ErrorName + | HeaderReplySerial Serial + | HeaderDestination BusName + | HeaderSender BusName + | HeaderSignature Signature + deriving (Show, Eq) : -\subsection{Flags} +\end{multicols} +\subsubsection{Flags} + +\begin{multicols}{2} + The instance of {\tt Ord} only exists for storing flags in a set. Flags have no inherent ordering. -:f DBus/Message/Internal.hs +\vfill + +\columnbreak + +:d DBus.Message data Flag = NoReplyExpected | NoAutoStart deriving (Show, Eq, Ord) : -:d message exports -, Flag (..) -: - -:f Tests.hs -instance Arbitrary Flag where - arbitrary = elements [NoReplyExpected, NoAutoStart] -: - -\subsection{Header fields} +\end{multicols} -:f DBus/Message/Internal.hs -data HeaderField - = Path T.ObjectPath - | Interface T.InterfaceName - | Member T.MemberName - | ErrorName T.ErrorName - | ReplySerial Serial - | Destination T.BusName - | Sender T.BusName - | Signature T.Signature - deriving (Show, Eq) -: +\subsubsection{Serials} -\subsection{Serials} +\begin{multicols}{2} {\tt Serial} is just a wrapper around {\tt Word32}, to provide a bit of added type-safety. -:f DBus/Message/Internal.hs -|apidoc Serial| -newtype Serial = Serial { serialValue :: Word32 } - deriving (Eq, Ord) +\vfill -instance Show Serial where - show (Serial x) = show x +\columnbreak -instance T.Variable Serial where - toVariant (Serial x) = T.toVariant x - fromVariant = fmap Serial . T.fromVariant +:d DBus.Message +|apidoc DBus.Message.Serial| +newtype Serial = Serial Word32 + deriving (Eq, Ord, Show) + +instance IsVariant Serial where + toVariant (Serial x) = toVariant x + fromVariant = fmap Serial . fromVariant : +\end{multicols} + +\begin{multicols}{2} + Additionally, some useful functions exist for incrementing serials. -:f DBus/Message/Internal.hs -firstSerial :: Serial -firstSerial = Serial 1 +\vfill -nextSerial :: Serial -> Serial -nextSerial (Serial x) = Serial (x + 1) +\columnbreak + +:d DBus.Message +serialValue :: Serial -> Word32 +serialValue (Serial x) = x : +\end{multicols} + +\begin{multicols}{2} + The {\tt Serial} constructor isn't useful to clients, because building arbitrary serials doesn't make any sense. -:d message exports -, Serial -, serialValue -, firstSerial -, nextSerial -: +\vfill -:f Tests.hs -instance Arbitrary Serial where - arbitrary = fmap Serial arbitrary -: +\columnbreak -\subsection{Message types} +\end{multicols} -:f DBus/Message/Internal.hs -maybe' :: (a -> b) -> Maybe a -> [b] -maybe' f = maybe [] (\x' -> [f x']) -: +\clearpage +\subsection{Message types} \subsubsection{Method calls} -:f DBus/Message/Internal.hs +:d DBus.Message data MethodCall = MethodCall - { methodCallPath :: T.ObjectPath - , methodCallMember :: T.MemberName - , methodCallInterface :: Maybe T.InterfaceName - , methodCallDestination :: Maybe T.BusName - , methodCallFlags :: S.Set Flag - , methodCallBody :: [T.Variant] + { methodCallPath :: ObjectPath + , methodCallMember :: MemberName + , methodCallInterface :: Maybe InterfaceName + , methodCallDestination :: Maybe BusName + , methodCallFlags :: Set Flag + , methodCallBody :: [Variant] } deriving (Show, Eq) @@ -157,84 +160,57 @@ messageFlags = methodCallFlags messageBody = methodCallBody messageHeaderFields m = concat - [ [ Path $ methodCallPath m - , Member $ methodCallMember m + [ [ HeaderPath (methodCallPath m) + , HeaderMember (methodCallMember m) ] - , maybe' Interface . methodCallInterface $ m - , maybe' Destination . methodCallDestination $ m + , maybe' HeaderInterface (methodCallInterface m) + , maybe' HeaderDestination (methodCallDestination m) ] : -:d message exports -, MethodCall (..) -: - -:f Tests.hs -instance Arbitrary MethodCall where - arbitrary = do - path <- arbitrary - member <- arbitrary - iface <- arbitrary - dest <- arbitrary - flags <- fmap Set.fromList arbitrary - Structure body <- arbitrary - return $ MethodCall path member iface dest flags body -: - +\clearpage \subsubsection{Method returns} -:f DBus/Message/Internal.hs +:d DBus.Message data MethodReturn = MethodReturn { methodReturnSerial :: Serial - , methodReturnDestination :: Maybe T.BusName - , methodReturnBody :: [T.Variant] + , methodReturnDestination :: Maybe BusName + , methodReturnBody :: [Variant] } deriving (Show, Eq) instance Message MethodReturn where messageTypeCode _ = 2 - messageFlags _ = S.fromList [NoReplyExpected, NoAutoStart] + messageFlags _ = Data.Set.fromList [NoReplyExpected, NoAutoStart] messageBody = methodReturnBody messageHeaderFields m = concat - [ [ ReplySerial $ methodReturnSerial m + [ [ HeaderReplySerial (methodReturnSerial m) ] - , maybe' Destination . methodReturnDestination $ m + , maybe' HeaderDestination (methodReturnDestination m) ] : -:d message exports -, MethodReturn (..) -: - -:f Tests.hs -instance Arbitrary MethodReturn where - arbitrary = do - serial <- arbitrary - dest <- arbitrary - Structure body <- arbitrary - return $ MethodReturn serial dest body -: - +\clearpage \subsubsection{Errors} -:f DBus/Message/Internal.hs +:d DBus.Message data Error = Error - { errorName :: T.ErrorName + { errorName :: ErrorName , errorSerial :: Serial - , errorDestination :: Maybe T.BusName - , errorBody :: [T.Variant] + , errorDestination :: Maybe BusName + , errorBody :: [Variant] } deriving (Show, Eq) instance Message Error where messageTypeCode _ = 3 - messageFlags _ = S.fromList [NoReplyExpected, NoAutoStart] + messageFlags _ = Data.Set.fromList [NoReplyExpected, NoAutoStart] messageBody = errorBody messageHeaderFields m = concat - [ [ ErrorName $ errorName m - , ReplySerial $ errorSerial m + [ [ HeaderErrorName (errorName m) + , HeaderReplySerial (errorSerial m) ] - , maybe' Destination . errorDestination $ m + , maybe' HeaderDestination (errorDestination m) ] : @@ -242,91 +218,43 @@ This function lets it be retrieved easily, with a fallback if no valid message was found. -:f DBus/Message/Internal.hs +:d DBus.Message errorMessage :: Error -> Text errorMessage msg = fromMaybe "(no error message)" $ do field <- maybeIndex (errorBody msg) 0 - text <- T.fromVariant field - if TL.null text + text <- fromVariant field + if Data.Text.null text then Nothing else return text : -:d message exports -, Error (..) -, errorMessage -: - -:f Tests.hs -instance Arbitrary Error where - arbitrary = do - name <- arbitrary - serial <- arbitrary - dest <- arbitrary - Structure body <- arbitrary - return $ Error name serial dest body -: - +\clearpage \subsubsection{Signals} -:f DBus/Message/Internal.hs +:d DBus.Message data Signal = Signal - { signalPath :: T.ObjectPath - , signalMember :: T.MemberName - , signalInterface :: T.InterfaceName - , signalDestination :: Maybe T.BusName - , signalBody :: [T.Variant] + { signalDestination :: Maybe BusName + , signalPath :: ObjectPath + , signalInterface :: InterfaceName + , signalMember :: MemberName + , signalBody :: [Variant] } deriving (Show, Eq) instance Message Signal where messageTypeCode _ = 4 - messageFlags _ = S.fromList [NoReplyExpected, NoAutoStart] + messageFlags _ = Data.Set.fromList [NoReplyExpected, NoAutoStart] messageBody = signalBody messageHeaderFields m = concat - [ [ Path $ signalPath m - , Member $ signalMember m - , Interface $ signalInterface m + [ [ HeaderPath (signalPath m) + , HeaderMember (signalMember m) + , HeaderInterface (signalInterface m) ] - , maybe' Destination . signalDestination $ m + , maybe' HeaderDestination (signalDestination m) ] : -:d message exports -, Signal (..) -: - -:f Tests.hs -instance Arbitrary Signal where - arbitrary = do - path <- arbitrary - member <- arbitrary - iface <- arbitrary - dest <- arbitrary - Structure body <- arbitrary - return $ Signal path member iface dest body -: - -\subsubsection{Unknown messages} - -Unknown messages are used for storing information about messages without -a recognised type code. They are not instances of {\tt Message}, because -if they were, then clients could accidentally send invalid messages over -the bus. - -:f DBus/Message/Internal.hs -data Unknown = Unknown - { unknownType :: Word8 - , unknownFlags :: S.Set Flag - , unknownBody :: [T.Variant] - } - deriving (Show, Eq) -: - -:d message exports -, Unknown (..) -: - +\clearpage \subsection{Received messages} Messages received from a bus have additional fields which do not make sense @@ -335,18 +263,18 @@ If a message has an unknown type, its serial and origin are still useful for sending an error reply. -:f DBus/Message/Internal.hs -|apidoc ReceivedMessage| +:d DBus.Message +|apidoc DBus.Message.ReceivedMessage| data ReceivedMessage - = ReceivedMethodCall Serial (Maybe T.BusName) MethodCall - | ReceivedMethodReturn Serial (Maybe T.BusName) MethodReturn - | ReceivedError Serial (Maybe T.BusName) Error - | ReceivedSignal Serial (Maybe T.BusName) Signal - | ReceivedUnknown Serial (Maybe T.BusName) Unknown + = ReceivedMethodCall Serial (Maybe BusName) MethodCall + | ReceivedMethodReturn Serial (Maybe BusName) MethodReturn + | ReceivedError Serial (Maybe BusName) Error + | ReceivedSignal Serial (Maybe BusName) Signal + | ReceivedUnknown Serial (Maybe BusName) Unknown deriving (Show, Eq) : -:f DBus/Message/Internal.hs +:d DBus.Message receivedSerial :: ReceivedMessage -> Serial receivedSerial (ReceivedMethodCall s _ _) = s receivedSerial (ReceivedMethodReturn s _ _) = s @@ -355,8 +283,8 @@ receivedSerial (ReceivedUnknown s _ _) = s : -:f DBus/Message/Internal.hs -receivedSender :: ReceivedMessage -> Maybe T.BusName +:d DBus.Message +receivedSender :: ReceivedMessage -> Maybe BusName receivedSender (ReceivedMethodCall _ s _) = s receivedSender (ReceivedMethodReturn _ s _) = s receivedSender (ReceivedError _ s _) = s @@ -364,18 +292,11 @@ receivedSender (ReceivedUnknown _ s _) = s : -:f DBus/Message/Internal.hs -receivedBody :: ReceivedMessage -> [T.Variant] +:d DBus.Message +receivedBody :: ReceivedMessage -> [Variant] receivedBody (ReceivedMethodCall _ _ x) = messageBody x receivedBody (ReceivedMethodReturn _ _ x) = messageBody x receivedBody (ReceivedError _ _ x) = messageBody x receivedBody (ReceivedSignal _ _ x) = messageBody x receivedBody (ReceivedUnknown _ _ x) = unknownBody x -: - -:d message exports -, ReceivedMessage (..) -, receivedSerial -, receivedSender -, receivedBody : diff --git a/src/module-headers.anansi b/src/module-headers.anansi new file mode 100644 --- /dev/null +++ b/src/module-headers.anansi @@ -0,0 +1,504 @@ +:# Copyright (C) 2009-2011 John Millikin +:# +:# 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 +:# 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 . + +\section{Module headers} + +:f DBus/Types.hs +|copyright| +module DBus.Types + ( Type(..) + + , Signature + , signature + , signature_ + , signatureText + , signatureTypes + + , IsValue + , IsAtom + , typeOf + + , Variant + , IsVariant(..) + , variantType + + , ObjectPath + , objectPath + , objectPath_ + , objectPathText + + , InterfaceName + , interfaceName + , interfaceName_ + , interfaceNameText + + , MemberName + , memberName + , memberName_ + , memberNameText + + , ErrorName + , errorName + , errorName_ + , errorNameText + + , BusName + , busName + , busName_ + , busNameText + + , Structure + , Array + , Dictionary + , structureItems + , arrayItems + , dictionaryItems + ) where +import DBus.Types.Internal hiding (typeOf) +import qualified DBus.Types.Internal + +typeOf :: IsValue a => a -> Type +typeOf = DBus.Types.Internal.typeOf +: + +:f DBus/Types/Internal.hs +{-# LANGUAGE CPP #-} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE IncoherentInstances #-} +|copyright| +module DBus.Types.Internal where +import Control.Monad (liftM, when, (>=>)) +import Data.ByteString (ByteString) +import qualified Data.ByteString +import qualified Data.ByteString.Char8 +import qualified Data.ByteString.Lazy +import qualified Data.ByteString.Unsafe +import Data.Int +import Data.List (intercalate) +import qualified Data.Map +import Data.Map (Map) +import qualified Data.String +import qualified Data.Text +import Data.Text (Text) +import qualified Data.Text.Encoding +import qualified Data.Text.Lazy +import qualified Data.Vector +import Data.Vector (Vector) +import Data.Word +import qualified Foreign +import System.IO.Unsafe (unsafePerformIO) + +|text validation imports| + +import DBus.Util (void) + +|DBus.Types| +|text validation| +: + +:f DBus/Message.hs +|copyright| +module DBus.Message + ( Message ( messageFlags + , messageBody + ) + , Flag (..) + , Serial + , serialValue + , Unknown (..) + , MethodCall (..) + , MethodReturn (..) + , Error (..) + , errorMessage + , Signal (..) + , ReceivedMessage (..) + , receivedSerial + , receivedSender + , receivedBody + ) where +import DBus.Message.Internal +: + +:f DBus/Message/Internal.hs +{-# LANGUAGE OverloadedStrings #-} +|copyright| +module DBus.Message.Internal where +import Data.Maybe (fromMaybe) +import qualified Data.Set +import Data.Set (Set) +import qualified Data.Text +import Data.Text (Text) +import Data.Word (Word8, Word32) + +import DBus.Types hiding (errorName) +import DBus.Util (maybeIndex) + +|DBus.Message| +: + +:f DBus/Wire.hs +|copyright| +module DBus.Wire + ( Endianness (..) + , MarshalError + , UnmarshalError + , marshalMessage + , unmarshalMessage + ) where +import DBus.Wire.Internal +: + +:f DBus/Wire/Internal.hs +{-# LANGUAGE OverloadedStrings #-} +|copyright| +module DBus.Wire.Internal where +import Control.Monad (liftM, when, unless) + +import qualified Data.Binary.Builder +import qualified Data.Binary.Get +import Data.Binary.Put (runPut) +import Data.Bits ((.&.), (.|.)) +import qualified Data.ByteString +import Data.ByteString (ByteString) +import qualified Data.ByteString.Char8 +import qualified Data.ByteString.Lazy +import Data.Int (Int16, Int32, Int64) +import qualified Data.Map +import Data.Map (Map) +import Data.Maybe (fromJust, listToMaybe, fromMaybe) +import qualified Data.Set +import Data.Set (Set) +import qualified Data.Text +import Data.Text (Text) +import qualified Data.Text.Encoding +import qualified Data.Vector +import Data.Vector (Vector) +import Data.Word (Word8, Word16, Word32, Word64) + +import qualified Data.Binary.IEEE754 + +import DBus.Message.Internal +import DBus.Types.Internal +import DBus.Util (void, untilM) +import qualified DBus.Util.MonadError as E + +|DBus.Wire| +: + +:f DBus/Address.hs +{-# LANGUAGE OverloadedStrings #-} +|copyright| +module DBus.Address + ( Address + , addressMethod + , addressParameters + , address + , addresses + , addressText + + -- * Environmental addresses + , getSystem + , getSession + , getStarter + ) where +import qualified Control.Exception +import Data.Char (ord, chr) +import qualified Data.Map +import Data.Map (Map) +import qualified Data.Text +import Data.Text (Text) +import qualified System.Environment +import Text.Printf (printf) +import Text.ParserCombinators.Parsec hiding (runParser) + +import DBus.Util (hexToInt, void) +import DBus.Types.Internal (runParser) +|DBus.Address| +: + +:f DBus/Connection.hs +{-# LANGUAGE OverloadedStrings #-} +|copyright| +module DBus.Connection + ( Connection + , ConnectionError + , connect + , disconnect + , send + , receive + + -- * Authentication + , Mechanism + , mechanism + , external + + -- * Transports + , Transport + , Socket + , transport + , socket + , socketPut + , socketGet + + , unix + , tcp + ) where +import Control.Concurrent +import Control.Monad (when) +import Data.IORef + +import DBus.Address +import DBus.Connection.Authentication +import DBus.Connection.Error +import DBus.Connection.Transport +import DBus.Message.Internal +import DBus.Wire +import DBus.Wire.Internal (unmarshalMessageM) + +|DBus.Connection| +: + +:f DBus/Connection/Authentication.hs +|copyright| +module DBus.Connection.Authentication + ( Mechanism + , mechanism + , authenticate + , external + ) where + +import Prelude hiding (getLine, head) +import Control.Monad (liftM) +import qualified Data.ByteString +import qualified Data.ByteString.Char8 +import Data.Char (ord) +import qualified System.Posix.User +import Text.Printf (printf) + +import DBus.Connection.Transport +import DBus.Util (readUntil, dropEnd) + +|DBus.Connection.Authentication| +: + +:f DBus/Connection/Error.hs +{-# LANGUAGE DeriveDataTypeable #-} +|copyright| +module DBus.Connection.Error where +import Control.Exception (Exception, throwIO) +import Data.Typeable (Typeable) +|DBus.Connection.Error| +: + +:f DBus/Connection/Transport.hs +{-# LANGUAGE OverloadedStrings #-} +|copyright| +module DBus.Connection.Transport + ( Transport + , transport + , Socket + , socket + , socketPut + , socketGet + , socketClose + , tcp + , unix + , connectTransport + ) where + +import qualified Control.Exception +import Control.Monad (unless) +import qualified Data.Binary.Get +import qualified Data.Binary.Put +import qualified Data.ByteString +import Data.ByteString (ByteString) +import qualified Data.Map +import qualified Data.Text +import Data.Text (Text) +import Data.Word (Word32) +import qualified Network +import qualified Network.Socket +import qualified System.IO +import Text.ParserCombinators.Parsec + +import DBus.Address +import DBus.Connection.Error + +|DBus.Connection.Transport| +: + +:f DBus/Client.hs +|copyright| +module DBus.Client + ( + -- * Clients + Client + , connect + , attach + , disconnect + , call + , call_ + + -- * Listening for signals + , MatchRule(..) + , listen + + -- * Exporting objects + , Method + , Reply(..) + , throwError + , method + , export + + -- * Other + , setMessageProcessor + ) where +import DBus.Client.Internal +: + +:f DBus/Client/Internal.hs +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE DeriveDataTypeable #-} +|copyright| +module DBus.Client.Internal where +import Control.Concurrent +import Control.Exception (SomeException) +import qualified Control.Exception +import Control.Monad (forever, unless) +import Control.Monad.Fix (mfix) +import Data.IORef +import Data.List (foldl') +import qualified Data.Map +import Data.Map (Map) +import Data.Maybe (isJust, catMaybes) +import Data.Text (Text) +import qualified Data.Text +import Data.Typeable (Typeable) +import qualified Data.Set + +import DBus.Address +import qualified DBus.Connection +import DBus.Connection (Connection) +import DBus.Connection.Authentication (external) +import DBus.Connection.Transport (unix, tcp) +import DBus.Connection.Error +import qualified DBus.Constants +import DBus.Constants ( errorFailed, errorUnknownMethod + , errorInvalidParameters) +import DBus.Message +import qualified DBus.Introspection +import DBus.Types +import DBus.Types.Internal (Signature(..)) +import DBus.Util (void) + +|DBus.Client| +: + +:f DBus/Client/Simple.hs +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE OverlappingInstances #-} +|copyright| +module DBus.Client.Simple + ( + -- * Clients + Client + , connectSystem + , connectSession + , connectStarter + , disconnect + + -- * Proxies + , Proxy + , proxy + , call + , DBus.Client.Simple.listen + + -- * Name reservation + , RequestNameFlag(..) + , RequestNameReply(..) + , ReleaseNameReply(..) + , requestName + , releaseName + + -- * Exporting objects + , Method + , AutoSignature + , AutoReply + , method + , export + , throwError + + -- * Re-exported modules + , module DBus.Types + ) where + +import qualified Control.Exception +import Data.Bits ((.|.)) +import qualified Data.Text -- for haddock +import qualified Data.Set +import Data.Word (Word32) + +import DBus.Address +import DBus.Client hiding (call, method, export) +import qualified DBus.Client +import DBus.Connection.Error +import DBus.Constants (errorInvalidParameters) +import DBus.Message hiding (errorName) +import DBus.Types +import DBus.Types.Internal (checkSignature) +import DBus.Util (maybeIndex) + +|DBus.Client.Simple| +: + +:f DBus/Introspection.hs +{-# LANGUAGE OverloadedStrings #-} +|copyright| +module DBus.Introspection + ( Object (..) + , Interface (..) + , Method (..) + , Signal (..) + , Parameter (..) + , Property (..) + , PropertyAccess (..) + , toXML + , fromXML + ) where +import Control.Monad ((>=>)) +import Control.Monad.ST (runST) +import Data.Maybe (fromMaybe) +import qualified Data.STRef as ST +import qualified Data.Text +import Data.Text (Text) +import qualified Data.Text.Encoding +import qualified Data.XML.Types as X +import qualified Text.XML.LibXML.SAX as SAX + +import qualified DBus.Types as T + +|DBus.Introspection| +: + +:f DBus/Constants.hs +{-# LANGUAGE OverloadedStrings #-} +|copyright| +module DBus.Constants where +import DBus.Types + +|DBus.Constants| +: + diff --git a/src/name-reservation.anansi b/src/name-reservation.anansi deleted file mode 100644 --- a/src/name-reservation.anansi +++ /dev/null @@ -1,137 +0,0 @@ -:# Copyright (C) 2009-2010 John Millikin -:# -:# 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 -:# 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 . - -\section{Name reservation} - -The central bus allows clients to register a well-known bus name, which -enables other clients to connect with or start a particular application. - -:f DBus/NameReservation.hs -|copyright| -{-# LANGUAGE OverloadedStrings #-} -module DBus.NameReservation - ( RequestNameFlag (..) - , RequestNameReply (..) - , ReleaseNameReply (..) - , requestName - , releaseName - , mkRequestNameReply - , mkReleaseNameReply - ) where -import Data.Word (Word32) -import Data.Bits ((.|.)) -import qualified Data.Set as Set -import qualified DBus.Types as T -import qualified DBus.Message as M -import qualified DBus.Constants as C -import DBus.Util (maybeIndex) -: - -:f DBus/NameReservation.hs -data RequestNameFlag - = AllowReplacement - | ReplaceExisting - | DoNotQueue - deriving (Show) -: - -:f DBus/NameReservation.hs -encodeFlags :: [RequestNameFlag] -> Word32 -encodeFlags = foldr (.|.) 0 . map flagValue where - flagValue AllowReplacement = 0x1 - flagValue ReplaceExisting = 0x2 - flagValue DoNotQueue = 0x4 -: - -There are only two methods of interest here, {\tt RequestName} and -{\tt ReleaseName}. - -:f DBus/NameReservation.hs -|apidoc requestName| -requestName :: T.BusName -> [RequestNameFlag] -> M.MethodCall -requestName name flags = M.MethodCall - { M.methodCallPath = C.dbusPath - , M.methodCallInterface = Just C.dbusInterface - , M.methodCallDestination = Just C.dbusName - , M.methodCallFlags = Set.empty - , M.methodCallMember = "RequestName" - , M.methodCallBody = - [ T.toVariant name - , T.toVariant . encodeFlags $ flags] - } -: - -:f DBus/NameReservation.hs -data RequestNameReply - = PrimaryOwner - | InQueue - | Exists - | AlreadyOwner - deriving (Show) -: - -:f DBus/NameReservation.hs -mkRequestNameReply :: M.MethodReturn -> Maybe RequestNameReply -mkRequestNameReply msg = - maybeIndex (M.messageBody msg) 0 >>= - T.fromVariant >>= - decodeRequestReply -: - -:f DBus/NameReservation.hs -decodeRequestReply :: Word32 -> Maybe RequestNameReply -decodeRequestReply 1 = Just PrimaryOwner -decodeRequestReply 2 = Just InQueue -decodeRequestReply 3 = Just Exists -decodeRequestReply 4 = Just AlreadyOwner -decodeRequestReply _ = Nothing -: - -:f DBus/NameReservation.hs -|apidoc releaseName| -releaseName :: T.BusName -> M.MethodCall -releaseName name = M.MethodCall - { M.methodCallPath = C.dbusPath - , M.methodCallInterface = Just C.dbusInterface - , M.methodCallDestination = Just C.dbusName - , M.methodCallFlags = Set.empty - , M.methodCallMember = "ReleaseName" - , M.methodCallBody = [T.toVariant name] - } -: - -:f DBus/NameReservation.hs -data ReleaseNameReply - = Released - | NonExistent - | NotOwner - deriving (Show) -: - -:f DBus/NameReservation.hs -mkReleaseNameReply :: M.MethodReturn -> Maybe ReleaseNameReply -mkReleaseNameReply msg = - maybeIndex (M.messageBody msg) 0 >>= - T.fromVariant >>= - decodeReleaseReply -: - -:f DBus/NameReservation.hs -decodeReleaseReply :: Word32 -> Maybe ReleaseNameReply -decodeReleaseReply 1 = Just Released -decodeReleaseReply 2 = Just NonExistent -decodeReleaseReply 3 = Just NotOwner -decodeReleaseReply _ = Nothing -: diff --git a/src/summary.anansi b/src/summary.anansi new file mode 100644 --- /dev/null +++ b/src/summary.anansi @@ -0,0 +1,30 @@ +:# Copyright (C) 2009-2010 John Millikin +:# +:# 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 +:# 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 . + +\section*{Summary} + +D-Bus is a low-latency, asynchronous IPC protocol. It is primarily used on +Linux, BSD, and other free UNIX-like systems. More information is available +at \url{http://dbus.freedesktop.org/}. + +This package is an implementation of the D-Bus protocol. It is intended +for use in either a client or server, though currently only the client +portion of connection establishment is implemented. Additionally, it +implements the introspection file format. + +\vfill + +\noindent Homepage: \href{https://john-millikin.com/software/dbus-core/} + {\small \tt https://john-millikin.com/software/dbus-core/} diff --git a/src/types.anansi b/src/types.anansi --- a/src/types.anansi +++ b/src/types.anansi @@ -1,1358 +1,1731 @@ -:# Copyright (C) 2009-2010 John Millikin -:# -:# 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 -:# 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 . - -\section{Types} - -The {\tt DBus.Types module} defines interfaces for storing, building, and -deconstructing D-Bus values. Everything is defined in an internal module, and -then exported via the public interface. - -:f DBus/Types.hs -|copyright| -module DBus.Types ( - |type exports| - ) where -import DBus.Types.Internal -: - -:f DBus/Types/Internal.cpphs -|copyright| -|text extensions| -|type extensions| -module DBus.Types.Internal where -|text imports| -|type imports| -import qualified Data.ByteString as B -import qualified Data.ByteString.Char8 as B8 -import qualified Data.ByteString.Lazy as BL -import qualified Data.ByteString.Char8 as BL8 -: - -D-Bus types are divided into two categories, ``atomic'' and ``container'' -types. Atoms are actual values -- strings, numbers, etc. Containers store -atoms and other containers. The most interesting difference between the two -is that atoms may be used as the keys in associative mappings -(``dictionaries''). - -Internally, types are represented using an enumeration. - -:f DBus/Types/Internal.cpphs -data Type - = DBusBoolean - | DBusByte - | DBusInt16 - | DBusInt32 - | DBusInt64 - | DBusWord16 - | DBusWord32 - | DBusWord64 - | DBusDouble - | DBusString - | DBusSignature - | DBusObjectPath - | DBusVariant - | DBusArray Type - | DBusDictionary Type Type - | DBusStructure [Type] - deriving (Show, Eq) -: - -:f DBus/Types/Internal.cpphs -|apidoc isAtomicType| -isAtomicType :: Type -> Bool -isAtomicType DBusBoolean = True -isAtomicType DBusByte = True -isAtomicType DBusInt16 = True -isAtomicType DBusInt32 = True -isAtomicType DBusInt64 = True -isAtomicType DBusWord16 = True -isAtomicType DBusWord32 = True -isAtomicType DBusWord64 = True -isAtomicType DBusDouble = True -isAtomicType DBusString = True -isAtomicType DBusSignature = True -isAtomicType DBusObjectPath = True -isAtomicType _ = False -: - -Each type can be converted to a textual representation, used in ``type -signatures'' or for debugging. - -:f DBus/Types/Internal.cpphs -|apidoc typeCode| -typeCode :: Type -> Text -|type codes| -: - -:d type exports - -- * Available types - Type (..) -, typeCode -: - -:f Tests.hs -instance Arbitrary Type where - arbitrary = oneof [atomicType, containerType] - -atomicType :: Gen Type -atomicType = elements - [ DBusBoolean - , DBusByte - , DBusWord16 - , DBusWord32 - , DBusWord64 - , DBusInt16 - , DBusInt32 - , DBusInt64 - , DBusDouble - , DBusString - , DBusObjectPath - , DBusSignature - ] - -containerType :: Gen Type -containerType = do - c <- choose (0,3) :: Gen Int - case c of - 0 -> fmap DBusArray arbitrary - 1 -> do - kt <- atomicType - vt <- arbitrary - return $ DBusDictionary kt vt - 2 -> fmap DBusStructure $ halfSized arbitrary - 3 -> return DBusVariant -: - -\subsection{Variants} - -A wrapper type is needed for safely storing generic D-Bus values in Haskell. -The D-Bus ``variant'' type is perfect for this, because variants may store -any D-Bus value. - -Any type which is an instance of {\tt Variable} is considered a valid -D-Bus value, because it can be used to construct {\tt Variant}s. However, -outside of this module, {\tt Variant}s can only be constructed from -pre-defined types. - -:f DBus/Types/Internal.cpphs -|apidoc Variant| -data Variant - = VarBoxBool Bool - | VarBoxWord8 Word8 - | VarBoxInt16 Int16 - | VarBoxInt32 Int32 - | VarBoxInt64 Int64 - | VarBoxWord16 Word16 - | VarBoxWord32 Word32 - | VarBoxWord64 Word64 - | VarBoxDouble Double - | VarBoxString Text - | VarBoxSignature Signature - | VarBoxObjectPath ObjectPath - | VarBoxVariant Variant - | VarBoxArray Array - | VarBoxDictionary Dictionary - | VarBoxStructure Structure - deriving (Eq) - -class Variable a where - toVariant :: a -> Variant - fromVariant :: Variant -> Maybe a -: - -:d type exports - -- * Variants -, Variant -, Variable (..) -: - -Variants can be printed, for debugging purposes -- this instance shouldn't -be parsed or inspected or anything like that, since the output format might -change drastically. - -:f DBus/Types/Internal.cpphs -instance Show Variant where - showsPrec d var = showParen (d > 10) full where - full = s "Variant " . shows code . s " " . valueStr - code = typeCode $ variantType var - s = showString - valueStr = showsPrecVar 11 var - -showsPrecVar :: Int -> Variant -> ShowS -showsPrecVar d var = case var of - (VarBoxBool x) -> showsPrec d x - (VarBoxWord8 x) -> showsPrec d x - (VarBoxInt16 x) -> showsPrec d x - (VarBoxInt32 x) -> showsPrec d x - (VarBoxInt64 x) -> showsPrec d x - (VarBoxWord16 x) -> showsPrec d x - (VarBoxWord32 x) -> showsPrec d x - (VarBoxWord64 x) -> showsPrec d x - (VarBoxDouble x) -> showsPrec d x - (VarBoxString x) -> showsPrec d x - (VarBoxSignature x) -> showsPrec d x - (VarBoxObjectPath x) -> showsPrec d x - (VarBoxVariant x) -> showsPrec d x - (VarBoxArray x) -> showsPrec d x - (VarBoxDictionary x) -> showsPrec d x - (VarBoxStructure x) -> showsPrec d x -: - -Since many operations on D-Bus values depend on having the correct type, -{\tt variantType} is used to retrieve which type is actually stored within -a {\tt Variant}. - -:f DBus/Types/Internal.cpphs -|apidoc variantType| -variantType :: Variant -> Type -variantType var = case var of - (VarBoxBool _) -> DBusBoolean - (VarBoxWord8 _) -> DBusByte - (VarBoxInt16 _) -> DBusInt16 - (VarBoxInt32 _) -> DBusInt32 - (VarBoxInt64 _) -> DBusInt64 - (VarBoxWord16 _) -> DBusWord16 - (VarBoxWord32 _) -> DBusWord32 - (VarBoxWord64 _) -> DBusWord64 - (VarBoxDouble _) -> DBusDouble - (VarBoxString _) -> DBusString - (VarBoxSignature _) -> DBusSignature - (VarBoxObjectPath _) -> DBusObjectPath - (VarBoxVariant _) -> DBusVariant - (VarBoxArray x) -> DBusArray (arrayType x) - (VarBoxDictionary x) -> let - keyT = dictionaryKeyType x - valueT = dictionaryValueType x - in DBusDictionary keyT valueT - (VarBoxStructure x) -> let - Structure items = x - in DBusStructure (map variantType items) - -variantSignature :: Variant -> Maybe Signature -variantSignature = mkBytesSignature . typeCodeB . variantType -: - -:d type exports -, variantType -: - -A macro is useful for reducing verbosity in simple {\tt Variable} -instances. - -:f DBus/Types/Internal.cpphs -#define INSTANCE_VARIABLE(TYPE) \ - instance Variable TYPE where \ - { toVariant = VarBox/**/TYPE \ - ; fromVariant (VarBox/**/TYPE x) = Just x \ - ; fromVariant _ = Nothing \ - } -: - -Since {\tt Variant}s are D-Bus values themselves, they can be stored in variants. - -:f DBus/Types/Internal.cpphs -INSTANCE_VARIABLE(Variant) -: - -For testing, {\tt Variant}s are usually generated by type. - -:f Tests.hs -instance Arbitrary Variant where - arbitrary = arbitrary >>= genVariant - -genVariant :: Type -> Gen Variant -genVariant t = case t of - DBusBoolean -> fmap toVariant (arbitrary :: Gen Bool) - DBusByte -> fmap toVariant (arbitrary :: Gen Word8) - DBusWord16 -> fmap toVariant (arbitrary :: Gen Word16) - DBusWord32 -> fmap toVariant (arbitrary :: Gen Word32) - DBusWord64 -> fmap toVariant (arbitrary :: Gen Word64) - DBusInt16 -> fmap toVariant (arbitrary :: Gen Int16) - DBusInt32 -> fmap toVariant (arbitrary :: Gen Int32) - DBusInt64 -> fmap toVariant (arbitrary :: Gen Int64) - DBusDouble -> fmap toVariant (arbitrary :: Gen Double) - DBusString -> fmap toVariant (arbitrary :: Gen String) - DBusObjectPath -> fmap toVariant (arbitrary :: Gen ObjectPath) - DBusSignature -> fmap toVariant (arbitrary :: Gen Signature) - (DBusArray _) -> fmap toVariant (arbitrary :: Gen Array) - (DBusDictionary _ _) -> fmap toVariant (arbitrary :: Gen Dictionary) - (DBusStructure _) -> fmap toVariant (arbitrary :: Gen Structure) - DBusVariant -> fmap toVariant (arbitrary :: Gen Variant) -: - -\subsection{Numerics} - -D-Bus supports most common numeric types: - -\begin{table}[h] -\caption{D-Bus Numeric types} -\begin{center} -\begin{tabular}{ll} -\toprule -Type & Description \\ -\midrule -Boolean & Either {\tt True} or {\tt False} \\ -Byte & 8-bit unsigned integer \\ -Int16 & 16-bit signed integer \\ -Int32 & 32-bit signed integer \\ -Int64 & 64-bit signed integer \\ -Word16 & 16-bit unsigned integer \\ -Word32 & 32-bit unsigned integer \\ -Word64 & 64-bit unsigned integer \\ -Double & 64-bit IEEE754 floating-point \\ -\bottomrule -\end{tabular} -\end{center} -\end{table} - -All D-Bus numeric types are fixed-length, so the {\tt Int} and {\tt Integer} -types can't be used. Instead, instances for the fixed-length integer types -are defined and any others will have to be converted. - -:d type imports -import Data.Word (Word8, Word16, Word32, Word64) -import Data.Int (Int16, Int32, Int64) -: - -:f DBus/Types/Internal.cpphs -INSTANCE_VARIABLE(Bool) -INSTANCE_VARIABLE(Word8) -INSTANCE_VARIABLE(Int16) -INSTANCE_VARIABLE(Int32) -INSTANCE_VARIABLE(Int64) -INSTANCE_VARIABLE(Word16) -INSTANCE_VARIABLE(Word32) -INSTANCE_VARIABLE(Word64) -INSTANCE_VARIABLE(Double) -: - -\subsection{Strings} - -Strings are a weird case; the built-in type, {\tt String}, is horribly -inefficent. To provide better performance for large strings, packed Unicode -strings defined in {\tt Data.Text} are used internally. - -:f DBus/Types/Internal.cpphs -instance Variable TL.Text where - toVariant = VarBoxString - fromVariant (VarBoxString x) = Just x - fromVariant _ = Nothing -: - -There's two different {\tt Text} types, strict and lazy. It'd be a pain -to store both and have to convert later, so instead, all strict {\tt Text} -values are converted to lazy values. - -:d type imports -import qualified Data.Text as T -: - -:f DBus/Types/Internal.cpphs -instance Variable T.Text where - toVariant = toVariant . TL.fromChunks . (:[]) - fromVariant = fmap (T.concat . TL.toChunks) . fromVariant -: - -Built-in {\tt String}s can still be stored, of course, but it requires -a language extension. - -:d type extensions -{-# LANGUAGE TypeSynonymInstances #-} -: - -:f DBus/Types/Internal.cpphs -instance Variable String where - toVariant = toVariant . TL.pack - fromVariant = fmap TL.unpack . fromVariant -: - -All this is verified using some QuickCheck properties - -:d test cases -, F.testGroup "String" - [ testProperty "String -> strict Text" - $ funEq (fromVariant . toVariant) (Just . T.pack) - , testProperty "String <- strict Text" - $ funEq (fromVariant . toVariant) (Just . T.unpack) - , testProperty "String -> lazy Text" - $ funEq (fromVariant . toVariant) (Just . TL.pack) - , testProperty "String <- lazy Text" - $ funEq (fromVariant . toVariant) (Just . TL.unpack) - , testProperty "Strict Text -> lazy Text" - $ funEq (fromVariant . toVariant) (Just . TL.pack . T.unpack) - , testProperty "Strict Text <- lazy Text" - $ funEq (fromVariant . toVariant) (Just . T.pack . TL.unpack) - ] -: - -\subsection{Signatures} - -Valid D-Bus types must obey certain rules, such as ``dict keys must be -atomic'', which are difficult to express in the Haskell type system. A -{\tt Signature} is guaranteed to be valid according to these rules. Creating -one requires using the {\tt mkSignature} function, which will convert a valid -D-Bus signature string into a {\tt Signature}. - -:f DBus/Types/Internal.cpphs -INSTANCE_VARIABLE(Signature) -data Signature = Signature { signatureTypes :: [Type] } - deriving (Eq) - -instance Show Signature where - showsPrec d x = showParen (d > 10) $ - showString "Signature " . shows (strSignature x) -: - -Signatures can also be converted back into text, by concatenating the -type codes of their contained types. - -:f DBus/Types/Internal.cpphs -bytesSignature :: Signature -> B.ByteString -bytesSignature (Signature ts) = B.concat $ map typeCodeB ts - -strSignature :: Signature -> Text -strSignature (Signature ts) = TL.concat $ map typeCode ts -: - -It doesn't make much sense to sort signatures, but since they can be used -as dictionary keys, it's useful to have them as an instance of {\tt Ord}. - -:d type imports -import Data.Ord (comparing) -: - -:f DBus/Types/Internal.cpphs -instance Ord Signature where - compare = comparing strSignature -: - -:d type exports - -- * Signatures -, Signature -, signatureTypes -, strSignature -: - -\subsubsection{Type codes} - -For atomic types, the type code is a single letter. Arrays, structures, -and dictionary types are multiple characters. - -:d type imports -import Data.Text.Encoding (decodeUtf8) -: - -:d type codes -typeCode t = TL.fromChunks [decodeUtf8 $ typeCodeB t] - -typeCodeB :: Type -> B.ByteString -typeCodeB DBusBoolean = "b" -typeCodeB DBusByte = "y" -typeCodeB DBusInt16 = "n" -typeCodeB DBusInt32 = "i" -typeCodeB DBusInt64 = "x" -typeCodeB DBusWord16 = "q" -typeCodeB DBusWord32 = "u" -typeCodeB DBusWord64 = "t" -typeCodeB DBusDouble = "d" -typeCodeB DBusString = "s" -typeCodeB DBusSignature = "g" -typeCodeB DBusObjectPath = "o" -typeCodeB DBusVariant = "v" -: - -An array's type code is ``a'' followed by the type it contains. For example, -an array of booleans would have the type string ``ab''. - -:d type codes -typeCodeB (DBusArray t) = B8.cons 'a' $ typeCodeB t -: - -A dictionary's type code is ``a\{$key\_type$ $value\_type$\}''. For example, -a dictionary of bytes to booleans would have the type string ``a\{yb\}''. - -:d type codes -typeCodeB (DBusDictionary k v) = B.concat ["a{", typeCodeB k, typeCodeB v, "}"] -: - -A structure's type code is the concatenation of its contained types, -wrapped by ``('' and ``)''. Structures may be empty, in which case their -type code is simply ``()''. - -:d type codes -typeCodeB (DBusStructure ts) = B.concat $ - ["("] ++ map typeCodeB ts ++ [")"] -: - -\subsubsection{Parsing} - -When parsing, additional restrictions apply which are not inherent to the -D-Bus type system. The signature parsing functions guarantee that any -{\tt Signature} is valid according to D-Bus rules. - -Signature parsing is the most common operation when unmarshaling messages; -therefore, an efficient parsing implementation is essential. - -Since all valid signatures as entirely ASCII, it's possible to parse them -using byte-based parsers for better performance. These aren't exported from -the public interface, but are still used within {\tt DBus.Wire} modules. - -:d type imports -import qualified Data.ByteString.Unsafe as B -import qualified Foreign as F -import System.IO.Unsafe (unsafePerformIO) -: - -There are three special cases which can be optimized: - -\begin{enumerate} -\item Empty signatures occur when messages have no body, and can use a constant - result. -\item Single-character signatures occur when parsing variants, and can use a - faster atom-only parser. -\item Signatures larger than 255 characters are invalid. -\end{enumerate} - -:f DBus/Types/Internal.cpphs -mkBytesSignature :: B.ByteString -> Maybe Signature -mkBytesSignature = unsafePerformIO . flip B.unsafeUseAsCStringLen io where - |fast signature parser| - |slow signature parser| - - io (cstr, len) = case len of - 0 -> return $ Just $ Signature [] - 1 -> fmap fast $ F.peek cstr - _ | len <= 255 -> slow (F.castPtr cstr) len - _ -> return Nothing -: - -:d fast signature parser -parseAtom c yes no = case c of - 0x62 -> yes DBusBoolean - 0x79 -> yes DBusByte - 0x6E -> yes DBusInt16 - 0x69 -> yes DBusInt32 - 0x78 -> yes DBusInt64 - 0x71 -> yes DBusWord16 - 0x75 -> yes DBusWord32 - 0x74 -> yes DBusWord64 - 0x64 -> yes DBusDouble - 0x73 -> yes DBusString - 0x67 -> yes DBusSignature - 0x6F -> yes DBusObjectPath - _ -> no - -fast c = parseAtom c (\t -> Just (Signature [t])) $ case c of - 0x76 -> Just (Signature [DBusVariant]) - _ -> Nothing -: - -:d slow signature parser -slow :: F.Ptr Word8 -> Int -> IO (Maybe Signature) -slow buf len = loop [] 0 where - loop acc ii | ii >= len = return . Just . Signature $ reverse acc - loop acc ii = do - c <- F.peekElemOff buf ii - let next t = loop (t : acc) (ii + 1) - parseAtom c next $ case c of - 0x76 -> next DBusVariant - - -- '(' - 0x28 -> do - mt <- structure buf len (ii + 1) - case mt of - Just (ii', t) -> loop (t : acc) ii' - Nothing -> return Nothing - - -- 'a' - 0x61 -> do - mt <- array buf len (ii + 1) - case mt of - Just (ii', t) -> loop (t : acc) ii' - Nothing -> return Nothing - - _ -> return Nothing -: - -:d slow signature parser -structure :: F.Ptr Word8 -> Int -> Int -> IO (Maybe (Int, Type)) -structure buf len = loop [] where - loop _ ii | ii >= len = return Nothing - loop acc ii = do - c <- F.peekElemOff buf ii - let next t = loop (t : acc) (ii + 1) - parseAtom c next $ case c of - 0x76 -> next DBusVariant - - -- '(' - 0x28 -> do - mt <- structure buf len (ii + 1) - case mt of - Just (ii', t) -> loop (t : acc) ii' - Nothing -> return Nothing - - -- ')' - 0x29 -> return $ Just $ (ii + 1, DBusStructure (reverse acc)) - - -- 'a' - 0x61 -> do - mt <- array buf len (ii + 1) - case mt of - Just (ii', t) -> loop (t : acc) ii' - Nothing -> return Nothing - - _ -> return Nothing -: - -:d slow signature parser -array :: F.Ptr Word8 -> Int -> Int -> IO (Maybe (Int, Type)) -array _ len ii | ii >= len = return Nothing -array buf len ii = do - c <- F.peekElemOff buf ii - let next t = return $ Just (ii + 1, DBusArray t) - parseAtom c next $ case c of - 0x76 -> next DBusVariant - - -- '(' - 0x28 -> do - mt <- structure buf len (ii + 1) - case mt of - Just (ii', t) -> return $ Just (ii', DBusArray t) - Nothing -> return Nothing - - -- '{' - 0x7B -> dict buf len (ii + 1) - - -- 'a' - 0x61 -> do - mt <- array buf len (ii + 1) - case mt of - Just (ii', t) -> return $ Just (ii', DBusArray t) - Nothing -> return Nothing - - _ -> return Nothing -: - -:d slow signature parser -dict :: F.Ptr Word8 -> Int -> Int -> IO (Maybe (Int, Type)) -dict _ len ii | ii + 1 >= len = return Nothing -dict buf len ii = do - c1 <- F.peekElemOff buf ii - c2 <- F.peekElemOff buf (ii + 1) - - let mt1 = parseAtom c1 Just Nothing - - let next t = return $ Just (ii + 2, t) - mt2 <- parseAtom c2 next $ case c2 of - 0x76 -> next DBusVariant - - -- '(' - 0x28 -> structure buf len (ii + 2) - - -- 'a' - 0x61 -> array buf len (ii + 2) - - _ -> return Nothing - - case mt2 of - Nothing -> return Nothing - Just (ii', t2) -> if ii' >= len - then return Nothing - else do - c3 <- F.peekElemOff buf ii' - return $ do - if c3 == 0x7D then Just () else Nothing - t1 <- mt1 - Just (ii' + 1, DBusDictionary t1 t2) -: - -The public interface for building signatures is {\tt Text}-based. - -:d type imports -import Data.Text.Lazy.Encoding (encodeUtf8) -: - -:f DBus/Types/Internal.cpphs -mkSignature :: Text -> Maybe Signature -mkSignature = mkBytesSignature . B.concat . BL.toChunks . encodeUtf8 -: - -Since many signatures are defined as string literals, it's useful to -have a helper function to construct a signature directly from a string. -If the input string is invalid, {\tt error} will be called. - -:d type imports -import DBus.Util (mkUnsafe) -import qualified Data.String as String -: - -:f DBus/Types/Internal.cpphs -mkSignature_ :: Text -> Signature -mkSignature_ = mkUnsafe "signature" mkSignature - -instance String.IsString Signature where - fromString = mkUnsafe "signature" mkBytesSignature . BL8.pack -: - -Most signature-related functions are exposed to clients, except the -{\tt Signature} value constructor. If that were exposed, clients could -construct invalid signatures. - -:d type exports -, mkSignature -, mkSignature_ -: - -Checking if a type is valid according to signature rules is common, and if -performed through the signature parser, slow. Since such types are already -guaranteed to be structurally valid, the only test needed is whether their -size is within bounds. - -:f DBus/Types/Internal.cpphs -maybeValidType :: Type -> Maybe () -maybeValidType t = if B.length (typeCodeB t) > 255 - then Nothing - else Just () -: - -:f Tests.hs -instance Arbitrary Signature where - arbitrary = sizedText 255 $ fmap (TL.concat . map typeCode) arbitrary -: - -:d test cases -, F.testGroup "Signature" - [ testProperty "Signature identity" - $ funEq (mkSignature . strSignature) Just - ] -: - -\subsection{Object paths} - -:f DBus/Types/Internal.cpphs -INSTANCE_VARIABLE(ObjectPath) -newtype ObjectPath = ObjectPath - { strObjectPath :: Text - } - deriving (Eq, Ord) - -instance Show ObjectPath where - showsPrec d (ObjectPath x) = showParen (d > 10) $ - showString "ObjectPath " . shows x - -instance String.IsString ObjectPath where - fromString = mkObjectPath_ . TL.pack -: - -An object path may be one of - -\begin{itemize} -\item The root path, {\tt "/"}. -\item {\tt '/'}, followed by one or more element names. Each element name - contains characters in the set {\tt [a-zA-Z0-9\_]}, and must have at - least one character. -\end{itemize} - -Element names are separated by {\tt '/'}, and the path may not end in -{\tt '/'} unless it is the root path. - -:d type imports -import Text.ParserCombinators.Parsec ((<|>)) -import qualified Text.ParserCombinators.Parsec as P -import DBus.Util (checkLength, parseMaybe) -: - -:f DBus/Types/Internal.cpphs -mkObjectPath :: Text -> Maybe ObjectPath -mkObjectPath s = parseMaybe path' (TL.unpack s) where - c = P.oneOf $ ['a'..'z'] ++ ['A'..'Z'] ++ ['0'..'9'] ++ "_" - path = P.char '/' >>= P.optional . P.sepBy (P.many1 c) . P.char - path' = path >> P.eof >> return (ObjectPath s) - -mkObjectPath_ :: Text -> ObjectPath -mkObjectPath_ = mkUnsafe "object path" mkObjectPath -: - -:d type exports - -- * Object paths -, ObjectPath -, strObjectPath -, mkObjectPath -, mkObjectPath_ -: - -:f Tests.hs -instance Arbitrary ObjectPath where - arbitrary = fmap (mkObjectPath_ . TL.pack) path' where - c = ['a'..'z'] ++ ['A'..'Z'] ++ ['0'..'9'] ++ "_" - path = fmap (intercalate "/" . ([] :)) genElements - path' = frequency [(1, return "/"), (9, path)] - genElements = atLeast 1 (atLeast 1 (elements c)) -: - -:d test cases -, F.testGroup "ObjectPath" - [ testProperty "ObjectPath identity" - $ funEq (mkObjectPath . strObjectPath) Just - ] -: - -\subsection{Arrays} - -Arrays are homogenous sequences of any valid D-Bus type. Arrays might be -empty, so the type they contain is stored instead of being calculated from -their contents (as in {\tt variantType}). - -Many D-Bus APIs represent binary data using an array of bytes; therefore, -there is a special constructor for {\tt ByteString}-based arrays. - -:f DBus/Types/Internal.cpphs -INSTANCE_VARIABLE(Array) -data Array - = VariantArray Type [Variant] - | ByteArray BL.ByteString - deriving (Eq) - -|apidoc arrayType| -arrayType :: Array -> Type -arrayType (VariantArray t _) = t -arrayType (ByteArray _) = DBusByte - -arrayItems :: Array -> [Variant] -arrayItems (VariantArray _ xs) = xs -arrayItems (ByteArray xs) = map toVariant $ BL.unpack xs -: - -:d type exports - -- * Arrays -, Array -, arrayType -, arrayItems -: - -Like {\tt Variant}, deriving {\tt Show} for {\tt Array} is mostly -just useful for debugging. - -:f DBus/Types/Internal.cpphs -instance Show Array where - showsPrec d array = showParen (d > 10) $ - s "Array " . showSig . s " [" . s valueString . s "]" where - s = showString - showSig = shows . typeCode . arrayType $ array - showVar var = showsPrecVar 0 var "" - valueString = intercalate ", " $ map showVar $ arrayItems array -: - -Clients constructing an array must provide the expected item type, which -will be checked for validity. Every item in the array will be checked against -the item type, to ensure the array is homogenous. - -:f DBus/Types/Internal.cpphs -arrayFromItems :: Type -> [Variant] -> Maybe Array -arrayFromItems DBusByte vs = fmap (ByteArray . BL.pack) (mapM fromVariant vs) - -arrayFromItems t vs = do - maybeValidType t - if all (\x -> variantType x == t) vs - then Just $ VariantArray t vs - else Nothing -: - -Additionally, for ease of use, an {\tt Array} can be converted directly -to/from lists of {\tt Variable} values. - -:f DBus/Types/Internal.cpphs -toArray :: Variable a => Type -> [a] -> Maybe Array -toArray t = arrayFromItems t . map toVariant - -fromArray :: Variable a => Array -> Maybe [a] -fromArray = mapM fromVariant . arrayItems -: - -:d type exports -, toArray -, fromArray -, arrayFromItems -: - -To provide a more efficient interface for byte array literals, these -functions bypass the conversions in {\tt toArray} and {\tt fromArray} - -:f DBus/Types/Internal.cpphs -arrayToBytes :: Array -> Maybe BL.ByteString -arrayToBytes (ByteArray x) = Just x -arrayToBytes _ = Nothing - -arrayFromBytes :: BL.ByteString -> Array -arrayFromBytes = ByteArray -: - -:d type exports -, arrayToBytes -, arrayFromBytes -: - -And to simplify inclusion of {\tt ByteString}s in message, instances of -{\tt Variable} exist for both strict and lazy {\tt ByteString}. - -:f DBus/Types/Internal.cpphs -instance Variable BL.ByteString where - toVariant = toVariant . arrayFromBytes - fromVariant x = fromVariant x >>= arrayToBytes -: - -:f DBus/Types/Internal.cpphs -instance Variable B.ByteString where - toVariant x = toVariant . arrayFromBytes $ BL.fromChunks [x] - fromVariant = fmap (B.concat . BL.toChunks) . fromVariant -: - -When generating random arrays for testing, only atomic values are used. -Random containers are almost never homogenous. - -:f Tests.hs -instance Arbitrary Array where - arbitrary = do - t <- atomicType - xs <- listOf $ genVariant t - return . fromJust $ arrayFromItems t xs - -prop_ArrayHomogeneous vs = isJust array == homogeneousTypes where - array = arrayFromItems firstType vs - homogeneousTypes = all (== firstType) types - types = map variantType vs - firstType = if null types - then DBusByte - else head types -: - -:d test cases -, F.testGroup "Array" - [ testProperty "Array identity" - $ \x -> Just x == arrayFromItems (arrayType x) (arrayItems x) - , testProperty "Array homogeneity" prop_ArrayHomogeneous - ] -: - -\subsection{Dictionaries} - -Dictionaries are a homogenous (key $\rightarrow$ value) mapping, where the -key type must be atomic. Values may be of any valid D-Bus type. Like -{\tt Array}, {\tt Dictionary} stores its contained types. - -:f DBus/Types/Internal.cpphs -INSTANCE_VARIABLE(Dictionary) - -data Dictionary = Dictionary - { dictionaryKeyType :: Type - , dictionaryValueType :: Type - , dictionaryItems :: [(Variant, Variant)] - } - deriving (Eq) -: - -:d type exports - -- * Dictionaries -, Dictionary -, dictionaryItems -, dictionaryKeyType -, dictionaryValueType -: - -{\tt show}ing a {\tt Dictionary} displays the mapping in a more readable -format than a list of pairs. - -:d type imports -import Data.List (intercalate) -: - -:f DBus/Types/Internal.cpphs -instance Show Dictionary where - showsPrec d (Dictionary kt vt pairs) = showParen (d > 10) $ - s "Dictionary " . showSig . s " {" . s valueString . s "}" where - s = showString - showSig = shows $ TL.append (typeCode kt) (typeCode vt) - valueString = intercalate ", " $ map showPair pairs - showPair (k, v) = (showsPrecVar 0 k . showString " -> " . showsPrecVar 0 v) "" -: - -Constructing a {\tt Dictionary} works like constructing an {\tt Array}, -except that there are two types to check, and the key type must be atomic. - -:d type imports -import Control.Monad (unless) -: - -:f DBus/Types/Internal.cpphs -dictionaryFromItems :: Type -> Type -> [(Variant, Variant)] -> Maybe Dictionary -dictionaryFromItems kt vt pairs = do - unless (isAtomicType kt) Nothing - maybeValidType kt - maybeValidType vt - - let sameType (k, v) = variantType k == kt && - variantType v == vt - if all sameType pairs - then Just $ Dictionary kt vt pairs - else Nothing -: - -The closest match for dictionary semantics in Haskell is the -{\tt Data.Map.Map} type. Therefore, the utility conversion functions work -with {\tt Map}s instead of pair lists. - -:d type imports -import Control.Arrow ((***)) -import qualified Data.Map as Map -: - -:f DBus/Types/Internal.cpphs -toDictionary :: (Variable a, Variable b) => Type -> Type -> Map.Map a b - -> Maybe Dictionary -toDictionary kt vt = dictionaryFromItems kt vt . pairs where - pairs = map (toVariant *** toVariant) . Map.toList -: - -:d type imports -import Control.Monad (forM) -: - -:f DBus/Types/Internal.cpphs -fromDictionary :: (Variable a, Ord a, Variable b) => Dictionary - -> Maybe (Map.Map a b) -fromDictionary (Dictionary _ _ vs) = do - pairs <- forM vs $ \(k, v) -> do - k' <- fromVariant k - v' <- fromVariant v - return (k', v') - return $ Map.fromList pairs -: - -:d type exports -, toDictionary -, fromDictionary -, dictionaryFromItems -: - -When generating random dictionaries for testing, only atomic values are used. -Random containers are almost never homogenous. - -:f Tests.hs -instance Arbitrary Dictionary where - arbitrary = do - kt <- atomicType - vt <- atomicType - ks <- listOf $ genVariant kt - vs <- vectorOf (length ks) $ genVariant vt - - return . fromJust $ dictionaryFromItems kt vt $ zip ks vs - -prop_DictionaryHomogeneous x = all correctType pairs where - pairs = dictionaryItems x - kType = dictionaryKeyType x - vType = dictionaryValueType x - correctType (k, v) = variantType k == kType && - variantType v == vType -: - -:d test cases -, F.testGroup "Dictionary" - [ testProperty "Dictionary identity" - $ \x -> Just x == dictionaryFromItems - (dictionaryKeyType x) - (dictionaryValueType x) - (dictionaryItems x) - , testProperty "Dictionary homogeneity" prop_DictionaryHomogeneous - , testProperty "Dictionary must have atomic keys" - $ \vt -> forAll containerType $ \kt -> - isNothing (dictionaryFromItems kt vt []) - , testProperty "Dictionary <-> Array conversion" - $ funEq (arrayToDictionary . dictionaryToArray) Just - ] -: - -\subsubsection{Converting between {\tt Array} and {\tt Dictionary}} - -Converting between {\tt Array} and {\tt Dictionary} is useful when -(un)marshaling -- dictionaries can be thought of as arrays of two-element -structures, much as a {\tt Map} is a list of pairs. - -:f DBus/Types/Internal.cpphs -dictionaryToArray :: Dictionary -> Array -dictionaryToArray (Dictionary kt vt items) = array where - Just array = toArray itemType structs - itemType = DBusStructure [kt, vt] - structs = [Structure [k, v] | (k, v) <- items] -: - -:f DBus/Types/Internal.cpphs -arrayToDictionary :: Array -> Maybe Dictionary -arrayToDictionary array = do - let toPair x = do - struct <- fromVariant x - case struct of - Structure [k, v] -> Just (k, v) - _ -> Nothing - (kt, vt) <- case arrayType array of - DBusStructure [kt, vt] -> Just (kt, vt) - _ -> Nothing - pairs <- mapM toPair $ arrayItems array - dictionaryFromItems kt vt pairs -: - -:d type exports -, dictionaryToArray -, arrayToDictionary -: - -\subsection{Structures} - -A heterogeneous, fixed-length container; equivalent in purpose to a Haskell -tuple. - -:f DBus/Types/Internal.cpphs -INSTANCE_VARIABLE(Structure) - -data Structure = Structure [Variant] - deriving (Show, Eq) -: - -:d type exports - -- * Structures -, Structure (..) -: - -:f Tests.hs -instance Arbitrary Structure where - arbitrary = fmap Structure $ halfSized arbitrary -: - -\subsection{Names} - -Various aspects of D-Bus require the use of specially-formatted strings, -called ``names''. All names are limited to 255 characters, and use subsets -of ASCII. - -Since all names have basically the same structure (a {\tt newtype} -declaration and some helper functions), I define a macro to automate -the definitions. - -:f DBus/Types/Internal.cpphs -#define NAME_TYPE(TYPE, NAME) \ - newtype TYPE = TYPE {str/**/TYPE :: Text} \ - deriving (Eq, Ord); \ - \ - instance Show TYPE where \ - { showsPrec d (TYPE x) = showParen (d > 10) $ \ - showString "TYPE " . shows x \ - }; \ - \ - instance String.IsString TYPE where \ - { fromString = mk/**/TYPE/**/_ . TL.pack }; \ - \ - instance Variable TYPE where \ - { toVariant = toVariant . str/**/TYPE \ - ; fromVariant = (mk/**/TYPE =<<) . fromVariant }; \ - \ - mk/**/TYPE/**/_ :: Text -> TYPE; \ - mk/**/TYPE/**/_ = mkUnsafe NAME mk/**/TYPE -: - -:d type exports --- * Names -: - -\subsubsection{Bus names} - -There are two forms of bus names, ``unique'' and ``well-known''. - -Unique names begin with {\tt `:'} and contain two or more elements, separated -by {\tt `.'}. Each element consists of characters from the set -{\tt [a-zA-Z0-9\_-]}. - -Well-known names contain two or more elements, separated by {\tt `.'}. Each -element consists of characters from the set {\tt [a-zA-Z0-9\_-]}, and must -not start with a digit. - -:f DBus/Types/Internal.cpphs -NAME_TYPE(BusName, "bus name") - -mkBusName :: Text -> Maybe BusName -mkBusName s = checkLength 255 (TL.unpack s) >>= parseMaybe parser where - c = ['a'..'z'] ++ ['A'..'Z'] ++ "_-" - c' = c ++ ['0'..'9'] - parser = (unique <|> wellKnown) >> P.eof >> return (BusName s) - unique = P.char ':' >> elems c' - wellKnown = elems c - elems start = elem' start >> P.many1 (P.char '.' >> elem' start) - elem' start = P.oneOf start >> P.many (P.oneOf c') -: - -:d type exports - -- ** Bus names -, BusName -, strBusName -, mkBusName -, mkBusName_ -: - -:f Tests.hs -instance Arbitrary BusName where - arbitrary = sizedText 255 (oneof [unique, wellKnown]) where - c = ['a'..'z'] ++ ['A'..'Z'] ++ "_-" - c' = c ++ ['0'..'9'] - - unique = do - elems' <- atLeast 2 $ elems c' - return . TL.pack $ ':' : intercalate "." elems' - - wellKnown = do - elems' <- atLeast 2 $ elems c - return . TL.pack $ intercalate "." elems' - - elems start = do - x <- elements start - xs <- atLeast 0 (elements c') - return (x:xs) -: - -:d test cases -, F.testGroup "BusName" - [ testProperty "BusName identity" - $ funEq (mkBusName . strBusName) Just - ] -: - -\subsubsection{Interface names} - -An interface name consists of two or more {\tt '.'}-separated elements. Each -element constists of characters from the set {\tt [a-zA-Z0-9\_]}, may not -start with a digit, and must have at least one character. - -:f DBus/Types/Internal.cpphs -NAME_TYPE(InterfaceName, "interface name") - -mkInterfaceName :: Text -> Maybe InterfaceName -mkInterfaceName s = checkLength 255 (TL.unpack s) >>= parseMaybe parser where - c = ['a'..'z'] ++ ['A'..'Z'] ++ "_" - c' = c ++ ['0'..'9'] - element = P.oneOf c >> P.many (P.oneOf c') - name = element >> P.many1 (P.char '.' >> element) - parser = name >> P.eof >> return (InterfaceName s) -: - -:d type exports - -- ** Interface names -, InterfaceName -, strInterfaceName -, mkInterfaceName -, mkInterfaceName_ -: - -:f Tests.hs -instance Arbitrary InterfaceName where - arbitrary = sizedText 255 genName where - c = ['a'..'z'] ++ ['A'..'Z'] ++ "_" - c' = c ++ ['0'..'9'] - - genName = fmap (TL.pack . intercalate ".") genElements - genElements = atLeast 2 genElement - genElement = do - x <- elements c - xs <- atLeast 0 (elements c') - return (x:xs) -: - -:d test cases -, F.testGroup "InterfaceName" - [ testProperty "InterfaceName identity" - $ funEq (mkInterfaceName . strInterfaceName) Just - ] -: - -\subsubsection{Error names} - -Error names have the same format as interface names, so the parser logic -can just be re-purposed. - -:f DBus/Types/Internal.cpphs -NAME_TYPE(ErrorName, "error name") - -mkErrorName :: Text -> Maybe ErrorName -mkErrorName = fmap (ErrorName . strInterfaceName) . mkInterfaceName -: - -:d type exports - -- ** Error names -, ErrorName -, strErrorName -, mkErrorName -, mkErrorName_ -: - -:f Tests.hs -instance Arbitrary ErrorName where - arbitrary = fmap (mkErrorName_ . strInterfaceName) arbitrary -: - -:d test cases -, F.testGroup "ErrorName" - [ testProperty "ErrorName identity" - $ funEq (mkErrorName . strErrorName) Just - ] -: - -\subsubsection{Member names} - -Member names must contain only characters from the set {\tt [a-zA-Z0-9\_]}, -may not begin with a digit, and must be at least one character long. - -:f DBus/Types/Internal.cpphs -NAME_TYPE(MemberName, "member name") - -mkMemberName :: Text -> Maybe MemberName -mkMemberName s = checkLength 255 (TL.unpack s) >>= parseMaybe parser where - c = ['a'..'z'] ++ ['A'..'Z'] ++ "_" - c' = c ++ ['0'..'9'] - name = P.oneOf c >> P.many (P.oneOf c') - parser = name >> P.eof >> return (MemberName s) -: - -:d type exports - -- ** Member names -, MemberName -, strMemberName -, mkMemberName -, mkMemberName_ -: - -:f Tests.hs -instance Arbitrary MemberName where - arbitrary = sizedText 255 genName where - c = ['a'..'z'] ++ ['A'..'Z'] ++ "_" - c' = c ++ ['0'..'9'] - - genName = do - x <- elements c - xs <- atLeast 0 (elements c') - return . TL.pack $ (x:xs) -: - -:d test cases -, F.testGroup "MemberName" - [ testProperty "MemberName identity" - $ funEq (mkMemberName . strMemberName) Just - ] -: +:# Copyright (C) 2009-2011 John Millikin +:# +:# 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 +:# 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 . + +\section{Values and types} + +\dbus{} values are divided into two categories, \emph{atoms} and +\emph{containers}. Atoms are strings, numbers, and so on. Containers can +store other values, including other containers. Generally, values act like +their Haskell equivalents, with one important exception: \dbus{} dictionaries +only support atomic keys. Every \dbus{} type has a \emph{type code}, a short +string describing what sort of data the value stores. + +\begin{table}[h] +\label{tab:dbus-types} +\caption{\dbus{} Types} +\begin{center} +\begin{tabular}{llll} +\toprule +\dbus{} Type & Code & Description & Haskell Type \\ +\midrule +Boolean & {\tt b} & {\tt True} or {\tt False} & {\tt Bool} \\ +Byte & {\tt y} & 8-bit unsigned integer & {\tt Word8} \\ +Int16 & {\tt n} & 16-bit signed integer & {\tt Int16} \\ +UInt16 & {\tt q} & 16-bit unsigned integer & {\tt Word16} \\ +Int32 & {\tt i} & 32-bit signed integer & {\tt Int32} \\ +UInt32 & {\tt u} & 32-bit unsigned integer & {\tt Word32} \\ +Int64 & {\tt x} & 64-bit signed integer & {\tt Int64} \\ +UInt64 & {\tt t} & 64-bit unsigned integer & {\tt Word64} \\ +Double & {\tt d} & 64-bit IEEE754 floating-point & {\tt Double} \\ +String & {\tt s} & Unicode text & {\tt Text} \\ +Object Path & {\tt o} & \dbus{} remote object path & {\tt DBus.Types.ObjectPath} \\ +Signature & {\tt g} & List of \dbus{} types & {\tt DBus.Types.Signature} \\ +Variant & {\tt v} & Can contain any \dbus{} value & {\tt DBus.Types.Variant} \\ +Array & {\tt a}\emph{t} & Homogenous list of \emph{t} & {\tt Vector} \\ +Dictionary & {\tt a\{}\emph{k}\emph{t}{\tt \}} & Associative map of \emph{k} to \emph{t} & {\tt Map} \\ +Structure & {\tt (}\emph{codes}{\tt )} & Heterogeneous list of \dbus{} values & Tuples \\ +\bottomrule +\end{tabular} +\end{center} +\end{table} + +\clearpage +\subsubsection*{Values and types (continued)} + +\begin{multicols}{2} + +Since the set of types is fixed, they are internally stored as an enumeration, +named {\tt Type}. The names mostly match the \dbus{} names, but a few have +been slightly changed to conform with Haskell naming conventions. + +\vfill + +\columnbreak + +:d DBus.Types +data Type + = TypeBoolean + | TypeWord8 + | TypeWord16 + | TypeWord32 + | TypeWord64 + | TypeInt16 + | TypeInt32 + | TypeInt64 + | TypeDouble + | TypeString + | TypeSignature + | TypeObjectPath + | TypeVariant + | TypeArray Type + | TypeDictionary Type Type + | TypeStructure [Type] + deriving (Eq, Ord) +: + +\end{multicols} + +\begin{multicols}{2} + +I have two choices when deciding how to show {\tt Type}s; either use type +codes, as in signatures, or try to generate a more Haskell-ish format. I +chose the second option because it's easier to read; for example, compare +{\tt "a\{sas\}"} and {\tt Map String [String]}. This is particularly +important when working with complex or deeply-nested structures, which are +common in some APIs. + +\vfill +\columnbreak + +:d DBus.Types +instance Show Type where + showsPrec d = showString . showType (d > 10) + +showType :: Bool -> Type -> String +showType paren t = case t of + TypeBoolean -> "Bool" + TypeWord8 -> "Word8" + TypeWord16 -> "Word16" + TypeWord32 -> "Word32" + TypeWord64 -> "Word64" + TypeInt16 -> "Int16" + TypeInt32 -> "Int32" + TypeInt64 -> "Int64" + TypeDouble -> "Double" + TypeString -> "String" + TypeSignature -> "Signature" + TypeObjectPath -> "ObjectPath" + TypeVariant -> "Variant" + TypeArray t' -> concat ["[", show t', "]"] + TypeDictionary kt vt -> showParen paren ( + showString "Map " . + shows kt . + showString " " . + showsPrec 11 vt) "" + TypeStructure ts -> concat + ["(", intercalate ", " (map show ts), ")"] +: + +\end{multicols} + +\clearpage +\subsection{Type signatures} + +\begin{multicols}{2} + +A list of types is called a \emph{signature}. Signatures are traditionally +represented as a string of type codes, such as {\tt "a\{sas\}"} for +{\tt Map String [String]}. However, this library stores signatures as +{\tt [Type]} to take advantage of Haskell's strong typing. + +\vfill + +\columnbreak + +:d DBus.Types +newtype Signature = Signature [Type] + deriving (Eq, Ord) + +signatureTypes :: Signature -> [Type] +signatureTypes (Signature types) = types + +instance Show Signature where + showsPrec d sig = showParen (d > 10) $ + showString "Signature " . + shows (signatureText sig) +: + +\end{multicols} + +\begin{multicols}{2} + +Although signatures are strongly-typed internally, they are exposed to the +user as if they're special strings matching the \dbus{} signature format. + +\vfill + +\columnbreak + +:d DBus.Types +signatureText :: Signature -> Text +signatureText = Data.Text.Encoding.decodeUtf8 + . Data.ByteString.Char8.pack + . concatMap typeCode + . signatureTypes + +typeCode :: Type -> String +typeCode TypeBoolean = "b" +typeCode TypeWord8 = "y" +typeCode TypeWord16 = "q" +typeCode TypeWord32 = "u" +typeCode TypeWord64 = "t" +typeCode TypeInt16 = "n" +typeCode TypeInt32 = "i" +typeCode TypeInt64 = "x" +typeCode TypeDouble = "d" +typeCode TypeString = "s" +typeCode TypeSignature = "g" +typeCode TypeObjectPath = "o" +typeCode TypeVariant = "v" +typeCode (TypeArray t) = 'a' : typeCode t +typeCode (TypeDictionary kt vt) = concat + [ "a{", typeCode kt , typeCode vt, "}"] + +typeCode (TypeStructure ts) = concat + ["(", concatMap typeCode ts, ")"] +: + +\end{multicols} + +\clearpage +\subsubsection*{Parsing signatures} + +\begin{multicols}{2} + +Signature parsing is the most common operation when unmarshaling messages; +therefore, an efficient parsing implementation is essential. However, I still +want the library's users to see a text-based interface to signatures. + +Therefore, there are actually two signature parsing APIs -- one for other +modules in this library (especially {\tt DBus.Wire}, and a small wrapper for +users. The wrapper follows the pattern for other special strings, so users +can use string literals and so on. + +\vfill + +\columnbreak + +:d DBus.Types +instance Data.String.IsString Signature where + fromString = signature_ . Data.Text.pack + +signature :: Text -> Maybe Signature +signature text = parseSignature bytes where + bytes = Data.Text.Encoding.encodeUtf8 text + +signature_ :: Text -> Signature +signature_ = tryParse "signature" signature +: + +\end{multicols} + +\begin{multicols}{2} + +\noindent There are three special cases which can be optimized: + +\begin{enumerate} +\item Empty signatures occur when messages have no body, and can use a constant + result. +\item Single-character signatures occur when parsing variants, and can use a + faster non-recursive parser. +\item All signatures larger than 255 characters are invalid, so they can be + failed immediately. +\end{enumerate} + +\vfill +\columnbreak + +:d DBus.Types +parseSignature :: ByteString -> Maybe Signature +parseSignature bytes = + case Data.ByteString.length bytes of + 0 -> Just (Signature []) + 1 -> parseSigFast bytes + len | len <= 255 -> parseSigFull bytes + _ -> Nothing +: + +\end{multicols} + +\begin{multicols}{2} + +Additionally, the library might already has a list of {\tt Type}s available, +and just wants to see if they're a valid signature. Rather than re-parsing +them, we can assume the types are already nested correctly, and just check +their string length. + +\vfill +\columnbreak + +:d DBus.Types +checkSignature :: [Type] -> Maybe Signature +checkSignature = check where + check ts = if sumLen ts > 255 + then Nothing + else Just (Signature ts) + sumLen :: [Type] -> Int + sumLen = sum . map len + + len (TypeArray t) = 1 + len t + len (TypeDictionary kt vt) = 3 + len kt + len vt + len (TypeStructure ts) = 2 + sumLen ts + len _ = 1 +: + +\end{multicols} + +\clearpage +\subsubsection*{Fast signature parser} + +\begin{multicols}{2} + +The fast parser relies on all atoms having single-character codes; if the +input string has only one character, it must be either an atomic type or +{\tt TypeVariant}. + +This optimization is important when parsing variants, as they very often +contain signatures with only a single atomic type. + +\vfill +\columnbreak + +:d DBus.Types +parseSigFast :: ByteString -> Maybe Signature +parseSigFast bytes = + let byte = Data.ByteString.head bytes in + parseAtom byte + (\t -> Just (Signature [t])) + (case byte of + 0x76 -> Just (Signature [TypeVariant]) + _ -> Nothing) + +parseAtom :: Word8 -> (Type -> a) -> a -> a +parseAtom byte yes no = case byte of + 0x62 -> yes TypeBoolean + 0x6E -> yes TypeInt16 + 0x69 -> yes TypeInt32 + 0x78 -> yes TypeInt64 + 0x79 -> yes TypeWord8 + 0x71 -> yes TypeWord16 + 0x75 -> yes TypeWord32 + 0x74 -> yes TypeWord64 + 0x64 -> yes TypeDouble + 0x73 -> yes TypeString + 0x67 -> yes TypeSignature + 0x6F -> yes TypeObjectPath + _ -> no +: + +\end{multicols} + +\clearpage +\subsubsection*{Full signature parser} + +This is horrible, gnarly, and almost completely undocumented. Someday I'll get +around to cleaning it up, or at least hanging some curtains on it. + +:d DBus.Types +parseSigFull :: ByteString -> Maybe Signature +parseSigFull bytes = unsafePerformIO io where + io = Data.ByteString.Unsafe.unsafeUseAsCStringLen bytes castBuf + castBuf (ptr, len) = parseSigBuf (Foreign.castPtr ptr, len) + parseSigBuf (buf, len) = mainLoop [] 0 where + |full signature parser| +: + +:d full signature parser +mainLoop acc ii | ii >= len = return (Just (Signature (reverse acc))) +mainLoop acc ii = do + c <- Foreign.peekElemOff buf ii + let next t = mainLoop (t : acc) (ii + 1) + parseAtom c next $ case c of + 0x76 -> next TypeVariant + 0x28 -> do -- '(' + mt <- structure (ii + 1) + case mt of + Just (ii', t) -> mainLoop (t : acc) ii' + Nothing -> return Nothing + 0x61 -> do -- 'a' + mt <- array (ii + 1) + case mt of + Just (ii', t) -> mainLoop (t : acc) ii' + Nothing -> return Nothing + _ -> return Nothing +: + +:d full signature parser +structure :: Int -> IO (Maybe (Int, Type)) +structure = loop [] where + loop _ ii | ii >= len = return Nothing + loop acc ii = do + c <- Foreign.peekElemOff buf ii + let next t = loop (t : acc) (ii + 1) + parseAtom c next $ case c of + 0x76 -> next TypeVariant + 0x28 -> do -- '(' + mt <- structure (ii + 1) + case mt of + Just (ii', t) -> loop (t : acc) ii' + Nothing -> return Nothing + 0x61 -> do -- 'a' + mt <- array (ii + 1) + case mt of + Just (ii', t) -> loop (t : acc) ii' + Nothing -> return Nothing + -- ')' + 0x29 -> return $ case acc of + [] -> Nothing + _ -> Just $ (ii + 1, TypeStructure (reverse acc)) + _ -> return Nothing +: + +\clearpage +\subsubsection*{Full signature parser (continued)} + +:d full signature parser +array :: Int -> IO (Maybe (Int, Type)) +array ii | ii >= len = return Nothing +array ii = do + c <- Foreign.peekElemOff buf ii + let next t = return $ Just (ii + 1, TypeArray t) + parseAtom c next $ case c of + 0x76 -> next TypeVariant + 0x7B -> dict (ii + 1) -- '{' + 0x28 -> do -- '(' + mt <- structure (ii + 1) + case mt of + Just (ii', t) -> return $ Just (ii', TypeArray t) + Nothing -> return Nothing + 0x61 -> do -- 'a' + mt <- array (ii + 1) + case mt of + Just (ii', t) -> return $ Just (ii', TypeArray t) + Nothing -> return Nothing + _ -> return Nothing +: + +:d full signature parser +dict :: Int -> IO (Maybe (Int, Type)) +dict ii | ii + 1 >= len = return Nothing +dict ii = do + c1 <- Foreign.peekElemOff buf ii + c2 <- Foreign.peekElemOff buf (ii + 1) + + let next t = return (Just (ii + 2, t)) + mt2 <- parseAtom c2 next $ case c2 of + 0x76 -> next TypeVariant + 0x28 -> structure (ii + 2) -- '(' + 0x61 -> array (ii + 2) -- 'a' + _ -> return Nothing + + case mt2 of + Nothing -> return Nothing + Just (ii', t2) -> if ii' >= len + then return Nothing + else do + c3 <- Foreign.peekElemOff buf ii' + return $ do + if c3 == 0x7D then Just () else Nothing + t1 <- parseAtom c1 Just Nothing + Just (ii' + 1, TypeDictionary t1 t2) +: + +\clearpage +\subsection{Generic value boxing} + +\begin{multicols}{2} + +The \dbus{} type system is similar to Haskell's, but has some minor +differences. Most notably, {\em variants} can store any \dbus{} type, and +dictionaries must have atomic keys. To provide a clean interface for +converting between \dbus{} and Haskell types, the interface is encoded with +three classes: + +\begin{enumerate} +\item {\tt IsVariant} is the most general, and the only class that users may + add instances for. Any type that can be converted to primitive \dbus{} + values can be stored in a {\tt Variant}, and converted safely back to + its original form. +\item {\tt IsValue} is slightly stricter, and is used for constraining + container values. If containers were constrained to {\tt IsVariant}, + users could define an instance for {\tt Either} and create heterogenous + containers. +\item {\tt IsAtom} is the strictest, and is used for constraining dictionary + key types. Only atomic values can be converted with this class, and + users cannot define their own instances. +\end{enumerate} + +It is possible to make this slightly less verbose by using existential +types, but the additional indirection causes slower message parsing. + +As a special optimization, arrays of bytes can be stored directly in a +{\tt Value} in three common formats. This allows the marshaling system to +avoid copying data unless needed. + +{\tt ValueVector} and {\tt ValueMap} require special handling. \dbus{} needs +to know their full type even if they're empty, but {\tt ([] :: [Value])} +contains no information about its contents. As a workaround, the full type +of the container is stored in the box itself at construction. + +\vfill + +\columnbreak + +:d DBus.Types +class IsVariant a where + toVariant :: a -> Variant + fromVariant :: Variant -> Maybe a + +class IsVariant a => IsValue a where + typeOf :: a -> Type + toValue :: a -> Value + fromValue :: Value -> Maybe a + +class IsValue a => IsAtom a where + toAtom :: a -> Atom + fromAtom :: Atom -> Maybe a + +|apidoc DBus.Types.Variant| +newtype Variant = Variant Value + deriving (Eq) + +data Value + = ValueAtom Atom + | ValueVariant Variant + | ValueBytes ByteString + | ValueVector Type (Vector Value) + | ValueMap Type Type (Map Atom Value) + | ValueStructure [Value] + deriving (Show) + +data Atom + = AtomBool Bool + | AtomWord8 Word8 + | AtomWord16 Word16 + | AtomWord32 Word32 + | AtomWord64 Word64 + | AtomInt16 Int16 + | AtomInt32 Int32 + | AtomInt64 Int64 + | AtomDouble Double + | AtomText Text + | AtomSignature Signature + | AtomObjectPath ObjectPath + deriving (Show, Eq, Ord) +: + +\end{multicols} + +\clearpage +\subsubsection*{Generic value boxing (continued)} + +The byte-handling optimization comes at a cost, however; it's no longer +possible to derive {\tt Eq}, and the instance is quite ugly. + +:d DBus.Types +instance Eq Value where + (==) (ValueBytes x) y = case y of + ValueBytes y' -> x == y' + ValueVector TypeWord8 y' -> x == vectorToBytes y' + _ -> False + + (==) (ValueVector TypeWord8 x) y = case y of + ValueBytes y' -> vectorToBytes x == y' + ValueVector TypeWord8 y' -> x == y' + _ -> False + + (==) (ValueAtom x) (ValueAtom y) = x == y + (==) (ValueVariant x) (ValueVariant y) = x == y + (==) (ValueVector tx x) (ValueVector ty y) = tx == ty && x == y + (==) (ValueMap ktx vtx x) (ValueMap kty vty y) = ktx == kty && vtx == vty && x == y + (==) (ValueStructure x) (ValueStructure y) = x == y + (==) _ _ = False +: + +\clearpage +\subsubsection*{Generic value boxing (continued)} + +If a user is interacting with the library through an REPL (e.g. GHCI), they +might want to print the content of a variant -- for example, to print messages +received from the bus. Due to the various wrappers between {\tt Variant} and +the actual data, this is somewhat complex. + +:d DBus.Types +showAtom :: Bool -> Atom -> String +showAtom _ (AtomBool x) = show x +showAtom _ (AtomWord8 x) = show x +showAtom _ (AtomWord16 x) = show x +showAtom _ (AtomWord32 x) = show x +showAtom _ (AtomWord64 x) = show x +showAtom _ (AtomInt16 x) = show x +showAtom _ (AtomInt32 x) = show x +showAtom _ (AtomInt64 x) = show x +showAtom _ (AtomDouble x) = show x +showAtom _ (AtomText x) = show x +showAtom p (AtomSignature x) = showsPrec (if p then 11 else 0) x "" +showAtom p (AtomObjectPath x) = showsPrec (if p then 11 else 0) x "" + +showValue :: Bool -> Value -> String +showValue p (ValueAtom x) = showAtom p x +showValue p (ValueVariant x) = showsPrec (if p then 11 else 0) x "" +showValue _ (ValueBytes xs) = 'b' : show xs +showValue _ (ValueVector TypeWord8 xs) = 'b' : show (vectorToBytes xs) +showValue _ (ValueVector _ xs) = showThings "[" (showValue False) "]" (Data.Vector.toList xs) +showValue _ (ValueMap _ _ xs) = showThings "{" showPair "}" (Data.Map.toList xs) where + showPair (k, v) = showAtom False k ++ ": " ++ showValue False v +showValue _ (ValueStructure xs) = showThings "(" (showValue False) ")" xs + +showThings :: String -> (a -> String) -> String -> [a] -> String +showThings a s z xs = a ++ intercalate ", " (map s xs) ++ z + +vectorToBytes :: Vector Value -> ByteString +vectorToBytes = Data.ByteString.pack + . Data.Vector.toList + . Data.Vector.map (\(ValueAtom (AtomWord8 x)) -> x) +: + +To preserve the variant-based public interface, {\tt showAtom} and +{\tt showValue} are not exported to the user. This preserves the +appearance that {\tt Variant} is a simple wrapping box. + +\begin{quote} +:d DBus.Types +instance Show Variant where + showsPrec d (Variant x) = showParen (d > 10) $ + showString "Variant " . showString (showValue True x) +: +\end{quote} + +\clearpage +\subsubsection*{Generic value boxing (continued)} + +Printing a {\tt Variant} lets the user see what value it contains, but +sometimes they need to know exactly what type \dbus{} thinks it is. This +is particularly important when working with integers, as some APIs will +only accept integers of a particular size. + +:d DBus.Types +|apidoc DBus.Types.variantType| +variantType :: Variant -> Type +variantType (Variant val) = valueType val + +valueType :: Value -> Type +valueType (ValueAtom x) = atomType x +valueType (ValueVariant _) = TypeVariant +valueType (ValueVector t _) = TypeArray t +valueType (ValueBytes _) = TypeArray TypeWord8 +valueType (ValueMap kt vt _) = TypeDictionary kt vt +valueType (ValueStructure vs) = TypeStructure (map valueType vs) + +atomType :: Atom -> Type +atomType (AtomBool _) = TypeBoolean +atomType (AtomWord8 _) = TypeWord8 +atomType (AtomWord16 _) = TypeWord16 +atomType (AtomWord32 _) = TypeWord32 +atomType (AtomWord64 _) = TypeWord64 +atomType (AtomInt16 _) = TypeInt16 +atomType (AtomInt32 _) = TypeInt32 +atomType (AtomInt64 _) = TypeInt64 +atomType (AtomDouble _) = TypeDouble +atomType (AtomText _) = TypeString +atomType (AtomSignature _) = TypeSignature +atomType (AtomObjectPath _) = TypeObjectPath +: + +\clearpage +\subsubsection*{Generic value boxing (continued)} + +\begin{multicols}{2} + +Since atoms are stored directly in the {\tt Atom} box, there is no fancy +logic required in their class instances. They're still pretty verbose, so +I used a small macro to keep things reasonable. + +\vfill +\columnbreak + +:d DBus.Types +#define IS_ATOM(HsType, AtomCons, TypeCons) \ + instance IsAtom HsType where \ + { toAtom = AtomCons \ + ; fromAtom (AtomCons x) = Just x \ + ; fromAtom _ = Nothing \ + }; \ + instance IsValue HsType where \ + { typeOf _ = TypeCons \ + ; toValue = ValueAtom . toAtom \ + ; fromValue (ValueAtom x) = fromAtom x \ + ; fromValue _ = Nothing \ + }; \ + instance IsVariant HsType where \ + { toVariant = Variant . toValue \ + ; fromVariant (Variant val) = fromValue val \ + } + +IS_ATOM(Bool, AtomBool, TypeBoolean) +IS_ATOM(Word8, AtomWord8, TypeWord8) +IS_ATOM(Word16, AtomWord16, TypeWord16) +IS_ATOM(Word32, AtomWord32, TypeWord32) +IS_ATOM(Word64, AtomWord64, TypeWord64) +IS_ATOM(Int16, AtomInt16, TypeInt16) +IS_ATOM(Int32, AtomInt32, TypeInt32) +IS_ATOM(Int64, AtomInt64, TypeInt64) +IS_ATOM(Double, AtomDouble, TypeDouble) +IS_ATOM(Text, AtomText, TypeString) +IS_ATOM(Signature, AtomSignature, TypeSignature) +IS_ATOM(ObjectPath, AtomObjectPath, TypeObjectPath) +: + +\end{multicols} + +\begin{multicols}{2} + +~ + +\vfill +\columnbreak + +:d DBus.Types +instance IsValue Variant where + typeOf _ = TypeVariant + toValue = ValueVariant + fromValue (ValueVariant x) = Just x + fromValue _ = Nothing + +instance IsVariant Variant where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val +: + +\end{multicols} + +\clearpage +\subsubsection*{Generic value boxing (continued)} + +:d DBus.Types +instance IsAtom Data.Text.Lazy.Text where + toAtom = toAtom . Data.Text.Lazy.toStrict + fromAtom = fmap Data.Text.Lazy.fromStrict . fromAtom + +instance IsValue Data.Text.Lazy.Text where + typeOf _ = TypeString + toValue = ValueAtom . toAtom + fromValue (ValueAtom x) = fromAtom x + fromValue _ = Nothing + +instance IsVariant Data.Text.Lazy.Text where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val +: + +:d DBus.Types +instance IsAtom String where + toAtom = toAtom . Data.Text.pack + fromAtom = fmap Data.Text.unpack . fromAtom + +instance IsValue String where + typeOf _ = TypeString + toValue = ValueAtom . toAtom + fromValue (ValueAtom x) = fromAtom x + fromValue _ = Nothing + +instance IsVariant String where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val +: + +\clearpage +\subsubsection*{Generic value boxing (continued)} + +Arrays are stored as a {\tt Vector Value}; this is somewhat inefficient, +but allows type-safe casting between different array representations. + +:d DBus.Types +instance IsValue a => IsValue (Vector a) where + typeOf v = TypeArray (vectorItemType v) + toValue v = ValueVector (vectorItemType v) (Data.Vector.map toValue v) + fromValue (ValueVector _ v) = Data.Vector.mapM fromValue v + fromValue _ = Nothing + +vectorItemType :: IsValue a => Vector a -> Type +vectorItemType v = typeOf (undefined `asTypeOf` Data.Vector.head v) + +instance IsValue a => IsVariant (Vector a) where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val +: + +:d DBus.Types +instance IsValue a => IsValue [a] where + typeOf v = TypeArray (typeOf (undefined `asTypeOf` head v)) + toValue = toValue . Data.Vector.fromList + fromValue = fmap Data.Vector.toList . fromValue + +instance IsValue a => IsVariant [a] where + toVariant = toVariant . Data.Vector.fromList + fromVariant = fmap Data.Vector.toList . fromVariant +: + +As an optimization, arrays of bytes are treated specially -- they can be +converted to/from packed bytestrings. + +:d DBus.Types +instance IsValue ByteString where + typeOf _ = TypeArray TypeWord8 + toValue = ValueBytes + fromValue (ValueBytes bs) = Just bs + fromValue (ValueVector TypeWord8 v) = Just (vectorToBytes v) + fromValue _ = Nothing + +instance IsVariant ByteString where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val +: + +:d DBus.Types +instance IsValue Data.ByteString.Lazy.ByteString where + typeOf _ = TypeArray TypeWord8 + toValue = toValue + . Data.ByteString.concat + . Data.ByteString.Lazy.toChunks + fromValue = fmap (\bs -> Data.ByteString.Lazy.fromChunks [bs]) + . fromValue + +instance IsVariant Data.ByteString.Lazy.ByteString where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val +: + +\clearpage +\subsubsection*{Generic value boxing (continued)} + +:d DBus.Types +instance (Ord k, IsAtom k, IsValue v) => IsValue (Map k v) where + typeOf m = TypeDictionary kt vt where + (kt, vt) = mapItemType m + + toValue m = ValueMap kt vt (bimap box m) where + (kt, vt) = mapItemType m + box k v = (toAtom k, toValue v) + + fromValue (ValueMap _ _ m) = bimapM unbox m where + unbox k v = do + k' <- fromAtom k + v' <- fromValue v + return (k', v') + fromValue _ = Nothing + +bimap :: Ord k' => (k -> v -> (k', v')) -> Map k v -> Map k' v' +bimap f = Data.Map.fromList . map (\(k, v) -> f k v) . Data.Map.toList + +bimapM :: (Monad m, Ord k') => (k -> v -> m (k', v')) -> Map k v -> m (Map k' v') +bimapM f = liftM Data.Map.fromList . mapM (\(k, v) -> f k v) . Data.Map.toList + +mapItemType :: (IsValue k, IsValue v) => Map k v -> (Type, Type) +mapItemType m = (typeOf k, typeOf v) where + mapItem :: Map k v -> (k, v) + mapItem _ = (undefined, undefined) + (k, v) = mapItem m + +instance (Ord k, IsAtom k, IsValue v) => IsVariant (Map k v) where + toVariant = Variant . toValue + fromVariant (Variant val) = fromValue val +: + +\clearpage +\subsubsection*{Generic value boxing (continued)} + +\dbus{}'s structures are essentially the same as Haskell's tuples, except they +can contain up to 255 items. There's no way I'm going to define 255 instances +for {\tt IsValue} and {\tt IsVariant}; other classes (such as {\tt Show}) only +go up to 15 or so, so that's how far {\tt dbus-core} goes too. + +I'm also not going to include all the instance declarations inline in this +document, since they're all essentially the same. Here's the instances for +two-element tuples, as a template. + +:d DBus.Types +instance (IsValue a1, IsValue a2) => IsValue (a1, a2) where + typeOf ~(a1, a2) = TypeStructure [typeOf a1, typeOf a2] + toValue (a1, a2) = ValueStructure [toValue a1, toValue a2] + fromValue (ValueStructure [a1, a2]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + return (a1', a2') + fromValue _ = Nothing + +instance (IsVariant a1, IsVariant a2) => IsVariant (a1, a2) where + toVariant (a1, a2) = Variant (ValueStructure [varToVal a1, varToVal a2]) + fromVariant (Variant (ValueStructure [a1, a2])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + return (a1', a2') + fromVariant _ = Nothing + +varToVal :: IsVariant a => a -> Value +varToVal a = case toVariant a of + Variant val -> val +: + +\clearpage +\subsection{Special string types} + +Various aspects of \dbus{} require the use of specially-formatted strings. Every +special string type gets its own Haskell type and construction function; this +allows the library to assume all such strings are correctly formatted. The +constructors will evaluate to {\tt Nothing} if their input is invalid. In +addition, partial versions (suffixed with {\tt \_}) are available for users +who don't care about validation; these will throw an exception if the input +is invalid. Finally, {\tt IsString} instances are available for all special +strings, so users can just enable {\tt OverloadedStrings} and use string +literals directly. + +Validation is performed using Parsec. Unfortunately, Parsec does not work +with packed strings; I'll define a few utility functions first, so the +validation logic is more obvious. Note that these discard the Parsec error +message; if some input doesn't match, the exact error is unlikely to be +interesting. + +:d text validation imports +import qualified Text.ParserCombinators.Parsec as Parsec +import Text.ParserCombinators.Parsec ((<|>), oneOf) +: + +:d text validation +skipSepBy1 :: Parsec.Parser a -> Parsec.Parser b -> Parsec.Parser () +skipSepBy1 p sep = do + void p + Parsec.skipMany (sep >> p) + +runParser :: Parsec.Parser a -> Text -> Maybe a +runParser parser text = case Parsec.parse parser "" (Data.Text.unpack text) of + Left _ -> Nothing + Right a -> Just a + +tryParse :: String -> (Text -> Maybe a) -> Text -> a +tryParse label parse text = case parse text of + Just x -> x + Nothing -> error ("Invalid " ++ label ++ ": " ++ show text) +: + +\clearpage +\subsubsection{Object paths} + +\begin{multicols}{2} + +\dbus{} is an object-oriented protocol; most \dbus{} sessions consist of method +calls sent to \emph{objects} exported by other applications. An objects is +identified by a \emph{object path}, such as {\tt /org/freedesktop/DBus}, which +is unique within each application. + +\vfill + +\columnbreak + +:d DBus.Types +newtype ObjectPath = ObjectPath Text + deriving (Eq, Ord, Show) + +objectPathText :: ObjectPath -> Text +objectPathText (ObjectPath text) = text + +objectPath :: Text -> Maybe ObjectPath +objectPath text = do + runParser parseObjectPath text + return (ObjectPath text) + +objectPath_ :: Text -> ObjectPath +objectPath_ = tryParse "object path" objectPath + +instance Data.String.IsString ObjectPath where + fromString = objectPath_ . Data.Text.pack +: + +\end{multicols} + +\begin{multicols}{2} + +An object path may be one of + +\begin{itemize} +\item The root path, {\tt "/"}. +\item {\tt '/'}, followed by one or more elements, separated by {\tt '/'}. + Each element contains characters in the set {\tt [a-zA-Z0-9\_]}, and + must have at least one character. +\end{itemize} + +Element names are separated by {\tt '/'}, and the path may not end in +{\tt '/'} unless it is the root path. + +\vfill + +\columnbreak + +:d DBus.Types +parseObjectPath :: Parsec.Parser () +parseObjectPath = root <|> object where + root = Parsec.try $ do + slash + Parsec.eof + + object = do + slash + skipSepBy1 element slash + Parsec.eof + + element = Parsec.skipMany1 (oneOf chars) + + slash = void (Parsec.char '/') + chars = concat [ ['a'..'z'] + , ['A'..'Z'] + , ['0'..'9'] + , "_"] +: + +\end{multicols} + +\clearpage +\subsubsection{Interface names} + +\begin{multicols}{2} + +Each object may have several \emph{interfaces}, each identified by an +\emph{interface name}. Interfaces are the basic units of \dbus{} APIs, and +even simple objects are expected to contain several (such as +{\tt org.freedesktop.DBus.Introspectable} or +{\tt org.freedesktop.DBus.Properties}). They correspond generally to Haskell +classes, or Python protocols. + +\vfill + +\columnbreak + +:d DBus.Types +newtype InterfaceName = InterfaceName Text + deriving (Eq, Ord, Show) + +interfaceNameText :: InterfaceName -> Text +interfaceNameText (InterfaceName text) = text + +interfaceName :: Text -> Maybe InterfaceName +interfaceName text = do + when (Data.Text.length text > 255) Nothing + runParser parseInterfaceName text + return (InterfaceName text) + +interfaceName_ :: Text -> InterfaceName +interfaceName_ = tryParse "interface name" interfaceName + +instance Data.String.IsString InterfaceName where + fromString = interfaceName_ . Data.Text.pack + +instance IsVariant InterfaceName where + toVariant = toVariant . interfaceNameText + fromVariant = fromVariant >=> interfaceName +: + +\end{multicols} + +\begin{multicols}{2} + +An interface name consists of two or more {\tt '.'}-separated elements. Each +element constists of characters from the set {\tt [a-zA-Z0-9\_]}, may not +start with a digit, and must have at least one character. + +\vfill + +\columnbreak + +:d DBus.Types +parseInterfaceName :: Parsec.Parser () +parseInterfaceName = name >> Parsec.eof where + alpha = ['a'..'z'] ++ ['A'..'Z'] ++ "_" + alphanum = alpha ++ ['0'..'9'] + element = do + void (oneOf alpha) + Parsec.skipMany (oneOf alphanum) + name = do + element + void (Parsec.char '.') + skipSepBy1 element (Parsec.char '.') +: + +\end{multicols} + +\clearpage +\subsubsection{Member names} + +\begin{multicols}{2} + +An interface, in turn, contains several \emph{members}, each identified by a +\emph{member name} such as {\tt Introspect}. A member might be either a +\emph{method}, which clients can call, or a \emph{signal}, which clients can +wait for. + +\vfill + +\columnbreak + +:d DBus.Types +newtype MemberName = MemberName Text + deriving (Eq, Ord, Show) + +memberNameText :: MemberName -> Text +memberNameText (MemberName text) = text + +memberName :: Text -> Maybe MemberName +memberName text = do + when (Data.Text.length text > 255) Nothing + runParser parseMemberName text + return (MemberName text) + +memberName_ :: Text -> MemberName +memberName_ = tryParse "member name" memberName + +instance Data.String.IsString MemberName where + fromString = memberName_ . Data.Text.pack + +instance IsVariant MemberName where + toVariant = toVariant . memberNameText + fromVariant = fromVariant >=> memberName +: + +\end{multicols} + +\begin{multicols}{2} + +Member names must contain only characters from the set {\tt [a-zA-Z0-9\_]}, +may not begin with a digit, and must be at least one character long. + +\vfill + +\columnbreak + +:d DBus.Types +parseMemberName :: Parsec.Parser () +parseMemberName = name >> Parsec.eof where + alpha = ['a'..'z'] ++ ['A'..'Z'] ++ "_" + alphanum = alpha ++ ['0'..'9'] + name = do + void (oneOf alpha) + Parsec.skipMany (oneOf alphanum) +: + +\end{multicols} + +\clearpage +\subsubsection{Error names} + +\begin{multicols}{2} + +Every error returned from a method call has an \emph{error name}, so +clients can know (generally) what went wrong without having to parse the +error message. Applications may define their own error names, or use one +of the standardized names listed in section~\ref{sec:standard-error-names}. + +Error names have the same format as interface names, so the parser logic +can be reused. + +\vfill + +\columnbreak + +:d DBus.Types +newtype ErrorName = ErrorName Text + deriving (Eq, Ord, Show) + +errorNameText :: ErrorName -> Text +errorNameText (ErrorName text) = text + +errorName :: Text -> Maybe ErrorName +errorName text = do + when (Data.Text.length text > 255) Nothing + runParser parseInterfaceName text + return (ErrorName text) + +errorName_ :: Text -> ErrorName +errorName_ = tryParse "error name" errorName + +instance Data.String.IsString ErrorName where + fromString = errorName_ . Data.Text.pack + +instance IsVariant ErrorName where + toVariant = toVariant . errorNameText + fromVariant = fromVariant >=> errorName +: + +\end{multicols} + +\clearpage +\subsubsection{Bus names} + +\begin{multicols}{2} + +Bus names are used when connecting to a central message dispatch bus. Every +connection is assigned a \emph{unique name}, such as {\tt :103.1}. This name +is usually used by the bus to send signals and method returns to client +applications. + +Additionally, applications may request a \emph{well-known} name such as +{\tt org.freedesktop.DBus}. These are similar to internet hostnames; client +applications are written to send messages to this address, where they can be +served by whatever server happens to be running at the time. + +\vfill + +\columnbreak + +:d DBus.Types +newtype BusName = BusName Text + deriving (Eq, Ord, Show) + +busNameText :: BusName -> Text +busNameText (BusName text) = text + +busName :: Text -> Maybe BusName +busName text = do + when (Data.Text.length text > 255) Nothing + runParser parseBusName text + return (BusName text) + +busName_ :: Text -> BusName +busName_ = tryParse "bus name" busName + +instance Data.String.IsString BusName where + fromString = busName_ . Data.Text.pack + +instance IsVariant BusName where + toVariant = toVariant . busNameText + fromVariant = fromVariant >=> busName +: + +\end{multicols} + +\begin{multicols}{2} + +Unique names begin with {\tt `:'} and contain two or more elements, separated +by {\tt `.'}. Each element consists of characters from the set +{\tt [a-zA-Z0-9\_-]}. + +Well-known names contain two or more elements, separated by {\tt `.'}. Each +element consists of characters from the set {\tt [a-zA-Z0-9\_-]}, and must +not start with a digit. + +\vfill + +\columnbreak + +:d DBus.Types +parseBusName :: Parsec.Parser () +parseBusName = name >> Parsec.eof where + alpha = ['a'..'z'] ++ ['A'..'Z'] ++ "_-" + alphanum = alpha ++ ['0'..'9'] + + name = unique <|> wellKnown + unique = do + void (Parsec.char ':') + elements alphanum + + wellKnown = elements alpha + + elements start = do + element start + Parsec.skipMany1 $ do + void (Parsec.char '.') + element start + + element start = do + void (oneOf start) + Parsec.skipMany (oneOf alphanum) +: + +\end{multicols} + +\clearpage +\subsection{Container boxes} + +:d DBus.Types +newtype Structure = Structure [Value] + deriving (Eq) + +instance Show Structure where + show (Structure xs) = showValue True (ValueStructure xs) + +instance IsVariant Structure where + toVariant (Structure xs) = Variant (ValueStructure xs) + fromVariant (Variant (ValueStructure xs)) = Just (Structure xs) + fromVariant _ = Nothing + +structureItems :: Structure -> [Variant] +structureItems (Structure xs) = map Variant xs +: + +:d DBus.Types +data Array + = Array Type (Vector Value) + | ArrayBytes ByteString + +instance Show Array where + show (Array t xs) = showValue True (ValueVector t xs) + show (ArrayBytes xs) = showValue True (ValueBytes xs) + +instance Eq Array where + x == y = norm x == norm y where + norm (Array TypeWord8 xs) = Left (vectorToBytes xs) + norm (Array t xs) = Right (t, xs) + norm (ArrayBytes xs) = Left xs + +instance IsVariant Array where + toVariant (Array t xs) = Variant (ValueVector t xs) + toVariant (ArrayBytes bs) = Variant (ValueBytes bs) + fromVariant (Variant (ValueVector t xs)) = Just (Array t xs) + fromVariant (Variant (ValueBytes bs)) = Just (ArrayBytes bs) + fromVariant _ = Nothing + +arrayItems :: Array -> [Variant] +arrayItems (Array _ xs) = map Variant (Data.Vector.toList xs) +arrayItems (ArrayBytes bs) = map toVariant (Data.ByteString.unpack bs) +: + +:d DBus.Types +data Dictionary = Dictionary Type Type (Map Atom Value) + deriving (Eq) + +instance Show Dictionary where + show (Dictionary kt vt xs) = showValue True (ValueMap kt vt xs) + +instance IsVariant Dictionary where + toVariant (Dictionary kt vt xs) = Variant (ValueMap kt vt xs) + fromVariant (Variant (ValueMap kt vt xs)) = Just (Dictionary kt vt xs) + fromVariant _ = Nothing + +dictionaryItems :: Dictionary -> [(Variant, Variant)] +dictionaryItems (Dictionary _ _ xs) = do + (k, v) <- Data.Map.toList xs + return (Variant (ValueAtom k), Variant v) +: + +\begin{comment} +\clearpage +\subsection{Boring type instances} + +:d DBus.Types +instance (IsValue a1, IsValue a2, IsValue a3) => IsValue (a1, a2, a3) where + typeOf ~(a1, a2, a3) = TypeStructure [typeOf a1, typeOf a2, typeOf a3] + toValue (a1, a2, a3) = ValueStructure [toValue a1, toValue a2, toValue a3] + fromValue (ValueStructure [a1, a2, a3]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + return (a1', a2', a3') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4) => IsValue (a1, a2, a3, a4) where + typeOf ~(a1, a2, a3, a4) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4] + toValue (a1, a2, a3, a4) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4] + fromValue (ValueStructure [a1, a2, a3, a4]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + return (a1', a2', a3', a4') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5) => IsValue (a1, a2, a3, a4, a5) where + typeOf ~(a1, a2, a3, a4, a5) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5] + toValue (a1, a2, a3, a4, a5) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5] + fromValue (ValueStructure [a1, a2, a3, a4, a5]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + return (a1', a2', a3', a4', a5') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6) => IsValue (a1, a2, a3, a4, a5, a6) where + typeOf ~(a1, a2, a3, a4, a5, a6) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6] + toValue (a1, a2, a3, a4, a5, a6) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + return (a1', a2', a3', a4', a5', a6') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7) => IsValue (a1, a2, a3, a4, a5, a6, a7) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7] + toValue (a1, a2, a3, a4, a5, a6, a7) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + return (a1', a2', a3', a4', a5', a6', a7') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8] + toValue (a1, a2, a3, a4, a5, a6, a7, a8) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + return (a1', a2', a3', a4', a5', a6', a7', a8') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9, IsValue a10) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9, typeOf a10] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9, toValue a10] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + a10' <- fromValue a10 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9, IsValue a10, IsValue a11) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9, typeOf a10, typeOf a11] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9, toValue a10, toValue a11] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + a10' <- fromValue a10 + a11' <- fromValue a11 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9, IsValue a10, IsValue a11, IsValue a12) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9, typeOf a10, typeOf a11, typeOf a12] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9, toValue a10, toValue a11, toValue a12] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + a10' <- fromValue a10 + a11' <- fromValue a11 + a12' <- fromValue a12 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9, IsValue a10, IsValue a11, IsValue a12, IsValue a13) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9, typeOf a10, typeOf a11, typeOf a12, typeOf a13] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9, toValue a10, toValue a11, toValue a12, toValue a13] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + a10' <- fromValue a10 + a11' <- fromValue a11 + a12' <- fromValue a12 + a13' <- fromValue a13 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12', a13') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9, IsValue a10, IsValue a11, IsValue a12, IsValue a13, IsValue a14) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9, typeOf a10, typeOf a11, typeOf a12, typeOf a13, typeOf a14] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9, toValue a10, toValue a11, toValue a12, toValue a13, toValue a14] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + a10' <- fromValue a10 + a11' <- fromValue a11 + a12' <- fromValue a12 + a13' <- fromValue a13 + a14' <- fromValue a14 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12', a13', a14') + fromValue _ = Nothing + +instance (IsValue a1, IsValue a2, IsValue a3, IsValue a4, IsValue a5, IsValue a6, IsValue a7, IsValue a8, IsValue a9, IsValue a10, IsValue a11, IsValue a12, IsValue a13, IsValue a14, IsValue a15) => IsValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) where + typeOf ~(a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) = TypeStructure [typeOf a1, typeOf a2, typeOf a3, typeOf a4, typeOf a5, typeOf a6, typeOf a7, typeOf a8, typeOf a9, typeOf a10, typeOf a11, typeOf a12, typeOf a13, typeOf a14, typeOf a15] + toValue (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) = ValueStructure [toValue a1, toValue a2, toValue a3, toValue a4, toValue a5, toValue a6, toValue a7, toValue a8, toValue a9, toValue a10, toValue a11, toValue a12, toValue a13, toValue a14, toValue a15] + fromValue (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15]) = do + a1' <- fromValue a1 + a2' <- fromValue a2 + a3' <- fromValue a3 + a4' <- fromValue a4 + a5' <- fromValue a5 + a6' <- fromValue a6 + a7' <- fromValue a7 + a8' <- fromValue a8 + a9' <- fromValue a9 + a10' <- fromValue a10 + a11' <- fromValue a11 + a12' <- fromValue a12 + a13' <- fromValue a13 + a14' <- fromValue a14 + a15' <- fromValue a15 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12', a13', a14', a15') + fromValue _ = Nothing +: + +:d DBus.Types +instance (IsVariant a1, IsVariant a2, IsVariant a3) => IsVariant (a1, a2, a3) where + toVariant (a1, a2, a3) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3]) + fromVariant (Variant (ValueStructure [a1, a2, a3])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + return (a1', a2', a3') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4) => IsVariant (a1, a2, a3, a4) where + toVariant (a1, a2, a3, a4) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + return (a1', a2', a3', a4') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5) => IsVariant (a1, a2, a3, a4, a5) where + toVariant (a1, a2, a3, a4, a5) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + return (a1', a2', a3', a4', a5') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6) => IsVariant (a1, a2, a3, a4, a5, a6) where + toVariant (a1, a2, a3, a4, a5, a6) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + return (a1', a2', a3', a4', a5', a6') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7) => IsVariant (a1, a2, a3, a4, a5, a6, a7) where + toVariant (a1, a2, a3, a4, a5, a6, a7) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + return (a1', a2', a3', a4', a5', a6', a7') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + return (a1', a2', a3', a4', a5', a6', a7', a8') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9, IsVariant a10) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9, varToVal a10]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + a10' <- (fromVariant . Variant) a10 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9, IsVariant a10, IsVariant a11) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9, varToVal a10, varToVal a11]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + a10' <- (fromVariant . Variant) a10 + a11' <- (fromVariant . Variant) a11 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9, IsVariant a10, IsVariant a11, IsVariant a12) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9, varToVal a10, varToVal a11, varToVal a12]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + a10' <- (fromVariant . Variant) a10 + a11' <- (fromVariant . Variant) a11 + a12' <- (fromVariant . Variant) a12 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9, IsVariant a10, IsVariant a11, IsVariant a12, IsVariant a13) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9, varToVal a10, varToVal a11, varToVal a12, varToVal a13]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + a10' <- (fromVariant . Variant) a10 + a11' <- (fromVariant . Variant) a11 + a12' <- (fromVariant . Variant) a12 + a13' <- (fromVariant . Variant) a13 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12', a13') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9, IsVariant a10, IsVariant a11, IsVariant a12, IsVariant a13, IsVariant a14) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9, varToVal a10, varToVal a11, varToVal a12, varToVal a13, varToVal a14]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + a10' <- (fromVariant . Variant) a10 + a11' <- (fromVariant . Variant) a11 + a12' <- (fromVariant . Variant) a12 + a13' <- (fromVariant . Variant) a13 + a14' <- (fromVariant . Variant) a14 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12', a13', a14') + fromVariant _ = Nothing + +instance (IsVariant a1, IsVariant a2, IsVariant a3, IsVariant a4, IsVariant a5, IsVariant a6, IsVariant a7, IsVariant a8, IsVariant a9, IsVariant a10, IsVariant a11, IsVariant a12, IsVariant a13, IsVariant a14, IsVariant a15) => IsVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) where + toVariant (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15) = Variant (ValueStructure [varToVal a1, varToVal a2, varToVal a3, varToVal a4, varToVal a5, varToVal a6, varToVal a7, varToVal a8, varToVal a9, varToVal a10, varToVal a11, varToVal a12, varToVal a13, varToVal a14, varToVal a15]) + fromVariant (Variant (ValueStructure [a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15])) = do + a1' <- (fromVariant . Variant) a1 + a2' <- (fromVariant . Variant) a2 + a3' <- (fromVariant . Variant) a3 + a4' <- (fromVariant . Variant) a4 + a5' <- (fromVariant . Variant) a5 + a6' <- (fromVariant . Variant) a6 + a7' <- (fromVariant . Variant) a7 + a8' <- (fromVariant . Variant) a8 + a9' <- (fromVariant . Variant) a9 + a10' <- (fromVariant . Variant) a10 + a11' <- (fromVariant . Variant) a11 + a12' <- (fromVariant . Variant) a12 + a13' <- (fromVariant . Variant) a13 + a14' <- (fromVariant . Variant) a14 + a15' <- (fromVariant . Variant) a15 + return (a1', a2', a3', a4', a5', a6', a7', a8', a9', a10', a11', a12', a13', a14', a15') + fromVariant _ = Nothing +: + +\end{comment} diff --git a/src/util.anansi b/src/util.anansi deleted file mode 100644 --- a/src/util.anansi +++ /dev/null @@ -1,233 +0,0 @@ -:# Copyright (C) 2009-2010 John Millikin -:# -:# 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 -:# 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 . - -\section{UUIDs} - -D-Bus {\sc uuid}s are 128-bit unique identifiers, used for server instances -and machine {\sc id}s. They are not compatible with {\sc rfc4122}. - -:f DBus/UUID.hs -|copyright| -module DBus.UUID - ( UUID - , toHex - , fromHex - ) where -|text imports| - -newtype UUID = UUID Text -- TODO: (Word64, Word64)? - deriving (Eq) - -instance Show UUID where - showsPrec d uuid = showParen (d > 10) $ - showString "UUID " . shows (toHex uuid) - -toHex :: UUID -> Text -toHex (UUID text) = text - -fromHex :: Text -> Maybe UUID -fromHex text = if validUUID text - then Just $ UUID text - else Nothing - -validUUID :: Text -> Bool -validUUID text = valid where - valid = and [TL.length text == 32, TL.all validChar text] - validChar c = or - [ c >= '0' && c <= '9' - , c >= 'a' && c <= 'f' - , c >= 'A' && c <= 'F' - ] -: - -\section{Misc. utility functions} - -:f DBus/Util.hs -|copyright| -module DBus.Util where -import Text.ParserCombinators.Parsec (Parser, parse) -import Data.Char (digitToInt) -import Data.List (isPrefixOf) - -checkLength :: Int -> String -> Maybe String -checkLength length' s | length s <= length' = Just s -checkLength _ _ = Nothing - -parseMaybe :: Parser a -> String -> Maybe a -parseMaybe p = either (const Nothing) Just . parse p "" - -mkUnsafe :: Show a => String -> (a -> Maybe b) -> a -> b -mkUnsafe label f x = case f x of - Just x' -> x' - Nothing -> error $ "Invalid " ++ label ++ ": " ++ show x - -hexToInt :: String -> Int -hexToInt = foldl ((+) . (16 *)) 0 . map digitToInt - -eitherToMaybe :: Either a b -> Maybe b -eitherToMaybe (Left _) = Nothing -eitherToMaybe (Right x) = Just x - -fromRight :: Either a b -> b -fromRight (Right x) = x -fromRight _ = error "DBus.Util.fromRight: Left" - -maybeIndex :: [a] -> Int -> Maybe a -maybeIndex (x:_ ) 0 = Just x -maybeIndex (_:xs) n | n > 0 = maybeIndex xs (n - 1) -maybeIndex _ _ = Nothing - --- | Read values from a monad until a guard value is read; return all --- values, including the guard. --- -readUntil :: (Monad m, Eq a) => [a] -> m a -> m [a] -readUntil guard getx = readUntil' [] where - guard' = reverse guard - step xs | isPrefixOf guard' xs = return . reverse $ xs - | otherwise = readUntil' xs - readUntil' xs = do - x <- getx - step $ x:xs - --- | Drop /n/ items from the end of a list -dropEnd :: Int -> [a] -> [a] -dropEnd n xs = take (length xs - n) xs - -void :: Monad m => m a -> m () -void m = m >> return () -: - -\subsection{Bundled ErrorT variant} - -The default {\tt ErrorT} type in the {\tt transformers} package has an idiotic -dependency on the {\tt Error} class, which is used to implement the obsolete -{\tt fail} function. This module is a variant, which doesn't include this -dependency. - -:f DBus/Util/MonadError.hs -|copyright| -module DBus.Util.MonadError - ( ErrorM (..) - , ErrorT (..) - , throwErrorM - , throwErrorT - ) where -newtype ErrorM e a = ErrorM { runErrorM :: Either e a } - -instance Functor (ErrorM e) where - fmap f m = ErrorM $ case runErrorM m of - Left err -> Left err - Right x -> Right $ f x - -instance Monad (ErrorM e) where - return = ErrorM . Right - (>>=) m k = case runErrorM m of - Left err -> ErrorM $ Left err - Right x -> k x - -throwErrorM :: e -> ErrorM e a -throwErrorM = ErrorM . Left - -newtype ErrorT e m a = ErrorT { runErrorT :: m (Either e a) } - -instance Monad m => Monad (ErrorT e m) where - return = ErrorT . return . Right - (>>=) m k = ErrorT $ do - x <- runErrorT m - case x of - Left l -> return $ Left l - Right r -> runErrorT $ k r - -throwErrorT :: Monad m => e -> ErrorT e m a -throwErrorT = ErrorT . return . Left -: - -\subsection{Extra test support} - -The test suite requires a whole bunch of imports - -:d test imports -import Test.QuickCheck -import qualified Test.Framework as F -import Test.Framework.Providers.QuickCheck2 (testProperty) - -import Control.Arrow ((&&&)) -import Control.Monad (replicateM) -import qualified Data.Binary.Get as G -import Data.Char (isPrint) -import Data.String -import Data.List (intercalate, isInfixOf) -import Data.Maybe (fromJust, isJust, isNothing) -import qualified Data.Map as Map -import qualified Data.Set as Set -import qualified Data.Text as T -import qualified Data.Text.Lazy as TL -import Data.Word (Word8, Word16, Word32, Word64) -import Data.Int (Int16, Int32, Int64) - -import DBus.Address -import DBus.Message.Internal -import DBus.Types -import DBus.Wire.Internal -import DBus.Wire.Marshal -import DBus.Wire.Unmarshal -import qualified DBus.Introspection as I -: - -:f Tests.hs -halfSized :: Gen a -> Gen a -halfSized gen = sized $ \n -> if n > 0 then - resize (n `div` 2) gen - else gen - -funEq :: Eq b => (a -> b) -> (a -> b) -> a -> Bool -funEq f g x = f x == g x - -sizedText :: (IsString a, Arbitrary a) => Integer -> Gen TL.Text -> Gen a -sizedText maxSize gen = step where - step = do - s <- gen - if toInteger (TL.length s) > maxSize - then halfSized step - else return . fromString . TL.unpack $ s - -atLeast :: Int -> Gen a -> Gen [a] -atLeast minSize g = sized $ \n -> do - count <- choose (minSize, max minSize n) - replicateM count g - -isRight :: Either a b -> Bool -isRight = either (const False) (const True) -: - -Some tests, such as address parsing, are single-case tests instead of -the more common ``property''. This function lets them be run only once. - -:f Tests.hs -test :: Testable a => F.TestName -> a -> F.Test -test name prop = F.plusTestOptions options (testProperty name prop) where - options = F.TestOptions Nothing (Just 1) Nothing Nothing -: - -QuickCheck doesn't define instances for fixed-size integral types or -variants of {\tt Text}, so define them here. - -:f Tests.hs -instance Arbitrary T.Text where - arbitrary = fmap T.pack arbitrary - -instance Arbitrary TL.Text where - arbitrary = fmap TL.pack arbitrary -: diff --git a/src/utilities.anansi b/src/utilities.anansi new file mode 100644 --- /dev/null +++ b/src/utilities.anansi @@ -0,0 +1,114 @@ +:# Copyright (C) 2009-2010 John Millikin +:# +:# 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 +:# 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 . + +\section{Miscellaneous} + +:f DBus/Util.hs +|copyright| +module DBus.Util + ( hexToInt + , maybeIndex + , readUntil + , dropEnd + , void + , untilM + ) where +import Data.Char (digitToInt) +import Data.List (isPrefixOf) + +hexToInt :: String -> Int +hexToInt = foldl ((+) . (16 *)) 0 . map digitToInt + +maybeIndex :: [a] -> Int -> Maybe a +maybeIndex (x:_ ) 0 = Just x +maybeIndex (_:xs) n | n > 0 = maybeIndex xs (n - 1) +maybeIndex _ _ = Nothing + +-- | Read values from a monad until a guard value is read; return all +-- values, including the guard. +-- +readUntil :: (Monad m, Eq a) => [a] -> m a -> m [a] +readUntil guard getx = readUntil' [] where + guard' = reverse guard + step xs | isPrefixOf guard' xs = return . reverse $ xs + | otherwise = readUntil' xs + readUntil' xs = do + x <- getx + step $ x:xs + +-- | Drop /n/ items from the end of a list +dropEnd :: Int -> [a] -> [a] +dropEnd n xs = take (length xs - n) xs + +void :: Monad m => m a -> m () +void m = m >> return () +: + +:f DBus/Util.hs +untilM :: Monad m => m Bool -> m a -> m [a] +untilM test comp = do + done <- test + if done + then return [] + else do + x <- comp + xs <- untilM test comp + return (x:xs) +: + +\subsection*{Bundled ErrorT variant} + +The default {\tt ErrorT} type in the {\tt transformers} package has an idiotic +dependency on the {\tt Error} class, which is used to implement the obsolete +{\tt fail} function. This module is a variant, which doesn't include this +dependency. + +:f DBus/Util/MonadError.hs +|copyright| +module DBus.Util.MonadError + ( ErrorM (..) + , ErrorT (..) + , throwErrorM + , throwErrorT + ) where +newtype ErrorM e a = ErrorM { runErrorM :: Either e a } + +instance Functor (ErrorM e) where + fmap f m = ErrorM $ case runErrorM m of + Left err -> Left err + Right x -> Right $ f x + +instance Monad (ErrorM e) where + return = ErrorM . Right + (>>=) m k = case runErrorM m of + Left err -> ErrorM $ Left err + Right x -> k x + +throwErrorM :: e -> ErrorM e a +throwErrorM = ErrorM . Left + +newtype ErrorT e m a = ErrorT { runErrorT :: m (Either e a) } + +instance Monad m => Monad (ErrorT e m) where + return = ErrorT . return . Right + (>>=) m k = ErrorT $ do + x <- runErrorT m + case x of + Left l -> return $ Left l + Right r -> runErrorT $ k r + +throwErrorT :: Monad m => e -> ErrorT e m a +throwErrorT = ErrorT . return . Left +: diff --git a/src/wire.anansi b/src/wire.anansi --- a/src/wire.anansi +++ b/src/wire.anansi @@ -1,1233 +1,1092 @@ -:# Copyright (C) 2009-2010 John Millikin -:# -:# 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 -:# 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 . - -\section{Wire format} - -{\tt DBus.Wire} is also split into an internal and external interface. - -:f DBus/Wire.hs -|copyright| -module DBus.Wire ( - |wire exports| - ) where -import DBus.Wire.Internal -import DBus.Wire.Marshal -import DBus.Wire.Unmarshal -: - -:f DBus/Wire/Internal.hs -|copyright| -module DBus.Wire.Internal where -import Data.Word (Word8, Word64) -import qualified DBus.Types as T -: - -\subsection{Endianness} - -:f DBus/Wire/Internal.hs -data Endianness = LittleEndian | BigEndian - deriving (Show, Eq) - -encodeEndianness :: Endianness -> Word8 -encodeEndianness LittleEndian = 108 -encodeEndianness BigEndian = 66 - -decodeEndianness :: Word8 -> Maybe Endianness -decodeEndianness 108 = Just LittleEndian -decodeEndianness 66 = Just BigEndian -decodeEndianness _ = Nothing -: - -:d wire exports - Endianness (..) -: - -:f Tests.hs -instance Arbitrary Endianness where - arbitrary = elements [LittleEndian, BigEndian] -: - -\subsection{Alignment} - -Every built-in type has an associated alignment. If a value of the given -type is marshaled, it must have {\sc nul} bytes inserted until it starts -on a byte index divisible by its alignment. - -:f DBus/Wire/Internal.hs -alignment :: T.Type -> Word8 -|alignments| - -padding :: Word64 -> Word8 -> Word64 -padding current count = required where - count' = fromIntegral count - missing = mod current count' - required = if missing > 0 - then count' - missing - else 0 -: - -\subsection{Marshaling} - -Marshaling is implemented using an error transformer over an internal -state. The {\tt Builder} type is used for efficient construction of lazy -byte strings, but it doesn't provide any way to retrieve the length of its -internal buffer, so the byte count is tracked separately. - -:f DBus/Wire/Marshal.hs -|copyright| -{-# LANGUAGE TypeFamilies #-} -module DBus.Wire.Marshal where -|text imports| -|marshal imports| -import DBus.Wire.Internal -import Control.Monad (when) -import Data.Maybe (fromJust) -import Data.Word (Word8, Word32, Word64) -import Data.Int (Int64) - -import qualified DBus.Types as T -import qualified DBus.Types.Internal as T -: - -:d marshal imports -import qualified Data.ByteString as BS -import qualified Data.ByteString.Lazy as L -import qualified Data.Binary.Builder as B -: - -:f DBus/Wire/Marshal.hs -data MarshalState = MarshalState {-# UNPACK #-} !B.Builder {-# UNPACK #-} !Word64 - -data MarshalR a = MarshalRL MarshalError | MarshalRR a {-# UNPACK #-} !MarshalState - -type Marshal = MarshalM () -newtype MarshalM a = MarshalM { unMarshalM :: Endianness -> MarshalState -> MarshalR a } - -instance Monad MarshalM where - {-# INLINE return #-} - return a = MarshalM $ \_ s -> MarshalRR a s - - {-# INLINE (>>=) #-} - m >>= k = MarshalM $ \e s -> case unMarshalM m e s of - MarshalRL err -> MarshalRL err - MarshalRR a s' -> unMarshalM (k a) e s' - - {-# INLINE (>>) #-} - m >> k = MarshalM $ \e s -> case unMarshalM m e s of - MarshalRL err -> MarshalRL err - MarshalRR _ s' -> unMarshalM k e s' - -throwError :: MarshalError -> MarshalM a -throwError err = MarshalM $ \_ _ -> MarshalRL err - -{-# INLINE getState #-} -getState :: MarshalM MarshalState -getState = MarshalM $ \_ s -> MarshalRR s s - -{-# INLINE putState #-} -putState :: MarshalState -> MarshalM () -putState s = MarshalM $ \_ _ -> MarshalRR () s -: - -Clients can perform marshaling via {\tt marshal} and {\tt runMarshal}, -which will generate a {\tt ByteString} with the fully marshaled data. - -:f DBus/Wire/Marshal.hs -runMarshal :: Marshal -> Endianness -> Either MarshalError L.ByteString -runMarshal m e = case unMarshalM m e (MarshalState B.empty 0) of - MarshalRL err -> Left err - MarshalRR _ (MarshalState builder _) -> Right $ B.toLazyByteString builder -: - -:f DBus/Wire/Marshal.hs -marshal :: T.Variant -> Marshal -marshal v = case v of - |marshalers| -: - -TODO: describe these functions - -:f DBus/Wire/Marshal.hs -appendS :: BS.ByteString -> Marshal -appendS bytes = MarshalM $ \_ (MarshalState builder count) -> let - builder' = B.append builder $ B.fromByteString bytes - count' = count + fromIntegral (BS.length bytes) - in MarshalRR () (MarshalState builder' count') -: - -:f DBus/Wire/Marshal.hs -appendL :: L.ByteString -> Marshal -appendL bytes = MarshalM $ \_ (MarshalState builder count) -> let - builder' = B.append builder $ B.fromLazyByteString bytes - count' = count + fromIntegral (L.length bytes) - in MarshalRR () (MarshalState builder' count') -: - -:f DBus/Wire/Marshal.hs -pad :: Word8 -> Marshal -pad count = MarshalM $ \e s@(MarshalState _ existing) -> let - padding' = fromIntegral $ padding existing count - bytes = BS.replicate padding' 0 - in unMarshalM (appendS bytes) e s -: - -Most numeric values already have marshalers implemented in the -{\tt Data.Binary.Builder} module; this function lets them be re-used easily. - -:f DBus/Wire/Marshal.hs -marshalBuilder :: Word8 -> (a -> B.Builder) -> (a -> B.Builder) -> a -> Marshal -marshalBuilder size be le x = do - pad size - MarshalM $ \e (MarshalState builder count) -> let - builder' = B.append builder $ case e of - BigEndian -> be x - LittleEndian -> le x - size' = fromIntegral size - in MarshalRR () (MarshalState builder' (count + size')) -: - -\subsubsection{Errors} - -Marshaling can fail for four reasons: - -\begin{itemize} -\item The message exceeds the maximum message size of $2^{27}$ bytes. -\item An array in the message exceeds the maximum array size of $2^{26}$ bytes. -\item The body's signature is not valid (for example, more than 255 fields). -\item A variant's signature is not valid -- same causes as an invalid body - signature. -\item Some text is invalid -- for example, it contains {\sc nul} - ({\tt '\textbackslash{}0'}) or invalid Unicode. -\end{itemize} - -:f DBus/Wire/Marshal.hs -data MarshalError - = MessageTooLong Word64 - | ArrayTooLong Word64 - | InvalidBodySignature Text - | InvalidVariantSignature Text - | InvalidText Text - deriving (Eq) - -instance Show MarshalError where - show (MessageTooLong x) = concat - ["Message too long (", show x, " bytes)."] - show (ArrayTooLong x) = concat - ["Array too long (", show x, " bytes)."] - show (InvalidBodySignature x) = concat - ["Invalid body signature: ", show x] - show (InvalidVariantSignature x) = concat - ["Invalid variant signature: ", show x] - show (InvalidText x) = concat - ["Text cannot be marshaled: ", show x] -: - -:d wire exports -, MarshalError (..) -: - -\subsection{Unmarshaling} - -Unmarshaling also uses an error transformer and internal state. - -:f DBus/Wire/Unmarshal.hs -|copyright| -|text extensions| -{-# LANGUAGE TypeFamilies #-} -module DBus.Wire.Unmarshal where -|text imports| -|unmarshal imports| -import Control.Monad (when, unless) -import Data.Maybe (fromJust, listToMaybe, fromMaybe) -import Data.Word (Word8, Word32, Word64) -import Data.Int (Int16, Int32, Int64) - -import DBus.Wire.Internal -import qualified DBus.Types.Internal as T -import DBus.Util (void) -: - -:d unmarshal imports -import Control.Monad (liftM) -import qualified DBus.Util.MonadError as E -import qualified Data.ByteString as B -import qualified Data.ByteString.Lazy as BL -: - -A specialised, state-like monad is used for performance reasons. This is -equivalent to {\tt State.StateT UnmarshalState (E.ErrorM UnmarshalError)}. - -:f DBus/Wire/Unmarshal.hs -data UnmarshalState = UnmarshalState BL.ByteString {-# UNPACK #-} !Word64 - -data UnmarshalR a = UnmarshalRL UnmarshalError | UnmarshalRR a {-# UNPACK #-} !UnmarshalState - -newtype Unmarshal a = Unmarshal { unUnmarshal :: Endianness -> UnmarshalState -> UnmarshalR a } - -instance Monad Unmarshal where - {-# INLINE return #-} - return a = Unmarshal $ \_ s -> UnmarshalRR a s - - {-# INLINE (>>=) #-} - m >>= k = Unmarshal $ \e s -> case unUnmarshal m e s of - UnmarshalRL err -> UnmarshalRL err - UnmarshalRR a s' -> unUnmarshal (k a) e s' - - {-# INLINE (>>) #-} - m >> k = Unmarshal $ \e s -> case unUnmarshal m e s of - UnmarshalRL err -> UnmarshalRL err - UnmarshalRR _ s' -> unUnmarshal k e s' - -throwError :: UnmarshalError -> Unmarshal a -throwError err = Unmarshal $ \_ _ -> UnmarshalRL err - -{-# INLINE getState #-} -getState :: Unmarshal UnmarshalState -getState = Unmarshal $ \_ s -> UnmarshalRR s s - -{-# INLINE putState #-} -putState :: UnmarshalState -> Unmarshal () -putState s = Unmarshal $ \_ _ -> UnmarshalRR () s -: - -:f DBus/Wire/Unmarshal.hs -runUnmarshal :: Unmarshal a -> Endianness -> BL.ByteString -> Either UnmarshalError a -runUnmarshal m e bytes = case unUnmarshal m e (UnmarshalState bytes 0) of - UnmarshalRL err -> Left err - UnmarshalRR a _ -> Right a -: - -:f DBus/Wire/Unmarshal.hs -unmarshal :: T.Signature -> Unmarshal [T.Variant] -unmarshal = mapM unmarshalType . T.signatureTypes - -unmarshalType :: T.Type -> Unmarshal T.Variant -|unmarshalers| -: - -TODO: describe these functions - -:f DBus/Wire/Unmarshal.hs -{-# INLINE consume #-} -consume :: Word64 -> Unmarshal BL.ByteString -consume count = Unmarshal $ \_ (UnmarshalState bytes offset) -> let - count' = fromIntegral count - (x, bytes') = BL.splitAt count' bytes - in if BL.length x == count' - then UnmarshalRR x (UnmarshalState bytes' (offset + count)) - else UnmarshalRL $ UnexpectedEOF offset -: - -:f DBus/Wire/Unmarshal.hs -skipPadding :: Word8 -> Unmarshal () -skipPadding count = do - (UnmarshalState _ offset) <- getState - bytes <- consume $ padding offset count - unless (BL.all (== 0) bytes) $ - throwError $ InvalidPadding offset -: - -:f DBus/Wire/Unmarshal.hs -skipTerminator :: Unmarshal () -skipTerminator = do - (UnmarshalState _ offset) <- getState - bytes <- consume 1 - unless (BL.all (== 0) bytes) $ - throwError $ MissingTerminator offset -: - -:f DBus/Wire/Unmarshal.hs -fromMaybeU :: Show a => Text -> (a -> Maybe b) -> a -> Unmarshal b -fromMaybeU label f x = case f x of - Just x' -> return x' - Nothing -> throwError . Invalid label . TL.pack . show $ x - -fromMaybeU' :: (Show a, T.Variable b) => Text -> (a -> Maybe b) -> a - -> Unmarshal T.Variant -fromMaybeU' label f x = do - x' <- fromMaybeU label f x - return $ T.toVariant x' -: - -:d unmarshal imports -import qualified Data.Binary.Get as G -: - -:f DBus/Wire/Unmarshal.hs -unmarshalGet :: Word8 -> G.Get a -> G.Get a -> Unmarshal a -unmarshalGet count be le = do - skipPadding count - bs <- consume . fromIntegral $ count - - Unmarshal $ \e s -> let - get = case e of - BigEndian -> be - LittleEndian -> le - in UnmarshalRR (G.runGet get bs) s - -unmarshalGet' :: T.Variable a => Word8 -> G.Get a -> G.Get a - -> Unmarshal T.Variant -unmarshalGet' count be le = T.toVariant `liftM` unmarshalGet count be le -: - -:f DBus/Wire/Unmarshal.hs -untilM :: Monad m => m Bool -> m a -> m [a] -untilM test comp = do - done <- test - if done - then return [] - else do - x <- comp - xs <- untilM test comp - return $ x:xs -: - -\subsubsection{Errors} - -Unmarshaling can fail for four reasons: - -\begin{itemize} -\item The message's declared protocol version is unsupported. -\item Unexpected {\sc eof}, when there are less bytes remaining than are - required. -\item An invalid byte sequence for a given value type. -\item Missing required header fields for the declared message type. -\item Non-zero bytes were found where padding was expected. -\item A string, signature, or object path was not {\sc null}-terminated. -\item An array's size didn't match the number of elements -\end{itemize} - -:f DBus/Wire/Unmarshal.hs -data UnmarshalError - = UnsupportedProtocolVersion Word8 - | UnexpectedEOF Word64 - | Invalid Text Text - | MissingHeaderField Text - | InvalidHeaderField Text T.Variant - | InvalidPadding Word64 - | MissingTerminator Word64 - | ArraySizeMismatch - deriving (Eq) - -instance Show UnmarshalError where - show (UnsupportedProtocolVersion x) = concat - ["Unsupported protocol version: ", show x] - show (UnexpectedEOF pos) = concat - ["Unexpected EOF at position ", show pos] - show (Invalid label x) = TL.unpack $ TL.concat - ["Invalid ", label, ": ", x] - show (MissingHeaderField x) = concat - ["Required field " , show x , " is missing."] - show (InvalidHeaderField x got) = concat - [ "Invalid header field ", show x, ": ", show got] - show (InvalidPadding pos) = concat - ["Invalid padding at position ", show pos] - show (MissingTerminator pos) = concat - ["Missing NUL terminator at position ", show pos] - show ArraySizeMismatch = "Array size mismatch" -: - -:d wire exports -, UnmarshalError (..) -: - -\subsection{Numerics} - -Numeric values are fixed-length, and aligned ``naturally'' -- ie, a 4-byte -integer will have a 4-byte alignment. - -:d alignments -alignment T.DBusByte = 1 -alignment T.DBusWord16 = 2 -alignment T.DBusWord32 = 4 -alignment T.DBusWord64 = 8 -alignment T.DBusInt16 = 2 -alignment T.DBusInt32 = 4 -alignment T.DBusInt64 = 8 -alignment T.DBusDouble = 8 -: - -Because some integral types are often used as components of other values, -there's separate functions for handling them. - -:f DBus/Wire/Marshal.hs -marshalWord32 :: Word32 -> Marshal -marshalWord32 = marshalBuilder 4 B.putWord32be B.putWord32le -: - -:f DBus/Wire/Marshal.hs -{-# INLINE marshalWord8 #-} -marshalWord8 :: Word8 -> Marshal -marshalWord8 x = MarshalM $ \_ (MarshalState builder count) -> let - builder' = B.append builder $ B.singleton x - in MarshalRR () (MarshalState builder' (count + 1)) -: - -:f DBus/Wire/Unmarshal.hs -unmarshalWord32 :: Unmarshal Word32 -unmarshalWord32 = unmarshalGet 4 G.getWord32be G.getWord32le -: - -:d marshalers -T.VarBoxWord8 x -> marshalWord8 x -T.VarBoxWord16 x -> marshalBuilder 2 B.putWord16be B.putWord16le x -T.VarBoxWord32 x -> marshalWord32 x -T.VarBoxWord64 x -> marshalBuilder 8 B.putWord64be B.putWord64le x -T.VarBoxInt16 x -> marshalBuilder 2 B.putWord16be B.putWord16le $ fromIntegral x -T.VarBoxInt32 x -> marshalBuilder 4 B.putWord32be B.putWord32le $ fromIntegral x -T.VarBoxInt64 x -> marshalBuilder 8 B.putWord64be B.putWord64le $ fromIntegral x -: - -:d unmarshalers -unmarshalType T.DBusByte = liftM (T.toVariant . BL.head) $ consume 1 -unmarshalType T.DBusWord16 = unmarshalGet' 2 G.getWord16be G.getWord16le -unmarshalType T.DBusWord32 = unmarshalGet' 4 G.getWord32be G.getWord32le -unmarshalType T.DBusWord64 = unmarshalGet' 8 G.getWord64be G.getWord64le - -unmarshalType T.DBusInt16 = do - x <- unmarshalGet 2 G.getWord16be G.getWord16le - return . T.toVariant $ (fromIntegral x :: Int16) - -unmarshalType T.DBusInt32 = do - x <- unmarshalGet 4 G.getWord32be G.getWord32le - return . T.toVariant $ (fromIntegral x :: Int32) - -unmarshalType T.DBusInt64 = do - x <- unmarshalGet 8 G.getWord64be G.getWord64le - return . T.toVariant $ (fromIntegral x :: Int64) -: - -{\tt Double}s are marshaled as in-bit IEEE-754 floating-point format. - -:d marshal imports -import Data.Binary.Put (runPut) -import qualified Data.Binary.IEEE754 as IEEE -: - -:d unmarshal imports -import qualified Data.Binary.IEEE754 as IEEE -: - -:d marshalers -T.VarBoxDouble x -> marshalDouble x -: - -:f DBus/Wire/Marshal.hs -marshalDouble :: Double -> Marshal -marshalDouble x = do - pad 8 - MarshalM $ \e s -> let - put = case e of - BigEndian -> IEEE.putFloat64be - LittleEndian -> IEEE.putFloat64le - bytes = runPut $ put x - in unMarshalM (appendL bytes) e s -: - -:d unmarshalers -unmarshalType T.DBusDouble = unmarshalGet' 8 IEEE.getFloat64be IEEE.getFloat64le -: - -\subsection{Booleans} - -Booleans are marshaled as 4-byte unsigned integers containing either of -the values 0 or 1. Yes, really. - -:d alignments -alignment T.DBusBoolean = 4 -: - -:d marshalers -T.VarBoxBool x -> marshalWord32 $ if x then 1 else 0 -: - -:d unmarshalers -unmarshalType T.DBusBoolean = unmarshalWord32 >>= - fromMaybeU' "boolean" (\x -> case x of - 0 -> Just False - 1 -> Just True - _ -> Nothing) -: - -\subsection{Strings and object paths} - -Strings are encoded in {\sc utf-8}, terminated with {\tt NUL}, and prefixed -with their length as an unsigned 32-bit integer. Their alignment is that of -their length. Object paths are marshaled just like strings, though additional -checks are required when unmarshaling. - -Because the encoding functions from {\tt Data.Text} raise exceptions on -error, checking their return value requires some ugly workarounds. - -:f DBus/Wire/Unicode.hs -|copyright| -module DBus.Wire.Unicode - ( maybeEncodeUtf8 - , maybeDecodeUtf8) where -import Data.ByteString.Lazy (ByteString) -import Data.Text.Lazy (Text) -import Data.Text.Lazy.Encoding (encodeUtf8, decodeUtf8) -import Data.Text.Encoding.Error (UnicodeException) -import qualified Control.Exception as Exc -import System.IO.Unsafe (unsafePerformIO) - -excToMaybe :: a -> Maybe a -excToMaybe x = unsafePerformIO $ fmap Just (Exc.evaluate x) `Exc.catch` unicodeError - -unicodeError :: UnicodeException -> IO (Maybe a) -unicodeError = const $ return Nothing - -maybeEncodeUtf8 :: Text -> Maybe ByteString -maybeEncodeUtf8 = excToMaybe . encodeUtf8 - -maybeDecodeUtf8 :: ByteString -> Maybe Text -maybeDecodeUtf8 = excToMaybe . decodeUtf8 -: - -:d marshal imports -import DBus.Wire.Unicode (maybeEncodeUtf8) -: - -:f DBus/Wire/Marshal.hs -marshalText :: Text -> Marshal -marshalText x = do - bytes <- case maybeEncodeUtf8 x of - Just x' -> return x' - Nothing -> throwError $ InvalidText x - when (L.any (== 0) bytes) $ - throwError $ InvalidText x - marshalWord32 . fromIntegral . L.length $ bytes - appendL bytes - marshalWord8 0 -: - -:d unmarshal imports -import DBus.Wire.Unicode (maybeDecodeUtf8) -: - -:f DBus/Wire/Unmarshal.hs -unmarshalText :: Unmarshal Text -unmarshalText = do - byteCount <- unmarshalWord32 - bytes <- consume . fromIntegral $ byteCount - skipTerminator - fromMaybeU "text" maybeDecodeUtf8 bytes -: - -:d alignments -alignment T.DBusString = 4 -alignment T.DBusObjectPath = 4 -: - -:d marshalers -T.VarBoxString x -> marshalText x -T.VarBoxObjectPath x -> marshalText . T.strObjectPath $ x -: - -:d unmarshalers -unmarshalType T.DBusString = liftM T.toVariant unmarshalText - -unmarshalType T.DBusObjectPath = unmarshalText >>= - fromMaybeU' "object path" T.mkObjectPath -: - -\subsection{Signatures} - -Signatures are similar to strings, except their length is limited to 255 -characters and is therefore stored as a single byte. - -:f DBus/Wire/Marshal.hs -marshalSignature :: T.Signature -> Marshal -marshalSignature x = do - let bytes = T.bytesSignature x - let size = fromIntegral . BS.length $ bytes - marshalWord8 size - appendS bytes - marshalWord8 0 -: - -:f DBus/Wire/Unmarshal.hs -unmarshalSignature :: Unmarshal T.Signature -unmarshalSignature = do - byteCount <- BL.head `liftM` consume 1 - lazy <- consume $ fromIntegral byteCount - skipTerminator - let bytes = B.concat $ BL.toChunks lazy - fromMaybeU "signature" T.mkBytesSignature bytes -: - -:d alignments -alignment T.DBusSignature = 1 -: - -:d marshalers -T.VarBoxSignature x -> marshalSignature x -: - -:d unmarshalers -unmarshalType T.DBusSignature = liftM T.toVariant unmarshalSignature -: - -\subsection{Containers} - -\subsubsection{Arrays} - -:d alignments -alignment (T.DBusArray _) = 4 -: - -:d marshalers -T.VarBoxArray x -> marshalArray x -: - -:d unmarshalers -unmarshalType (T.DBusArray t) = T.toVariant `liftM` unmarshalArray t -: - -Marshaling arrays is complicated, because the array body must be marshaled -\emph{first} to calculate the array length. This requires building a -temporary marshaler, to get the padding right. - -:d marshal imports -import qualified DBus.Constants as C -: - -:f DBus/Wire/Marshal.hs -marshalArray :: T.Array -> Marshal -marshalArray x = do - (arrayPadding, arrayBytes) <- getArrayBytes (T.arrayType x) x - let arrayLen = L.length arrayBytes - when (arrayLen > fromIntegral C.arrayMaximumLength) - (throwError $ ArrayTooLong $ fromIntegral arrayLen) - marshalWord32 $ fromIntegral arrayLen - appendL $ L.replicate arrayPadding 0 - appendL arrayBytes -: - -:f DBus/Wire/Marshal.hs -getArrayBytes :: T.Type -> T.Array -> MarshalM (Int64, L.ByteString) -getArrayBytes T.DBusByte x = return (0, bytes) where - Just bytes = T.arrayToBytes x -: - -:f DBus/Wire/Marshal.hs -getArrayBytes itemType x = do - let vs = T.arrayItems x - s <- getState - (MarshalState _ afterLength) <- marshalWord32 0 >> getState - (MarshalState _ afterPadding) <- pad (alignment itemType) >> getState - - putState $ MarshalState B.empty afterPadding - (MarshalState itemBuilder _) <- mapM_ marshal vs >> getState - - let itemBytes = B.toLazyByteString itemBuilder - paddingSize = fromIntegral $ afterPadding - afterLength - - putState s - return (paddingSize, itemBytes) -: - -Unmarshaling is much easier, especially if it's a byte array. - -:f DBus/Wire/Unmarshal.hs -unmarshalArray :: T.Type -> Unmarshal T.Array -unmarshalArray T.DBusByte = do - byteCount <- unmarshalWord32 - T.arrayFromBytes `liftM` consume (fromIntegral byteCount) -: - -:f DBus/Wire/Unmarshal.hs -unmarshalArray itemType = do - let getOffset = do - (UnmarshalState _ o) <- getState - return o - byteCount <- unmarshalWord32 - skipPadding (alignment itemType) - start <- getOffset - let end = start + fromIntegral byteCount - vs <- untilM (liftM (>= end) getOffset) (unmarshalType itemType) - end' <- getOffset - when (end' > end) $ - throwError ArraySizeMismatch - fromMaybeU "array" (T.arrayFromItems itemType) vs -: - -\subsubsection{Dictionaries} - -:d alignments -alignment (T.DBusDictionary _ _) = 4 -: - -:d marshalers -T.VarBoxDictionary x -> marshalArray (T.dictionaryToArray x) -: - -:d unmarshalers -unmarshalType (T.DBusDictionary kt vt) = do - let pairType = T.DBusStructure [kt, vt] - array <- unmarshalArray pairType - fromMaybeU' "dictionary" T.arrayToDictionary array -: - -\subsubsection{Structures} - -:d alignments -alignment (T.DBusStructure _) = 8 -: - -:d marshalers -T.VarBoxStructure (T.Structure vs) -> do - pad 8 - mapM_ marshal vs -: - -:d unmarshalers -unmarshalType (T.DBusStructure ts) = do - skipPadding 8 - liftM (T.toVariant . T.Structure) $ mapM unmarshalType ts -: - -\subsubsection{Variants} - -:d alignments -alignment T.DBusVariant = 1 -: - -:d marshalers -T.VarBoxVariant x -> do - let textSig = T.typeCode . T.variantType $ x - sig <- case T.variantSignature x of - Just x' -> return x' - Nothing -> throwError $ InvalidVariantSignature textSig - marshalSignature sig - marshal x -: - -:d unmarshalers -unmarshalType T.DBusVariant = do - let getType sig = case T.signatureTypes sig of - [t] -> Just t - _ -> Nothing - - t <- fromMaybeU "variant signature" getType =<< unmarshalSignature - T.toVariant `liftM` unmarshalType t -: - -\subsection{Messages} - -:d marshal imports -import qualified DBus.Message.Internal as M -: - -:d unmarshal imports -import qualified DBus.Message.Internal as M -: - -\subsubsection{Flags} - -:d unmarshal imports -import Data.Bits ((.&.)) -import qualified Data.Set as Set -: - -:d marshal imports -import Data.Bits ((.|.)) -import qualified Data.Set as Set -: - -:f DBus/Wire/Marshal.hs -encodeFlags :: Set.Set M.Flag -> Word8 -encodeFlags flags = foldr (.|.) 0 $ map flagValue $ Set.toList flags where - flagValue M.NoReplyExpected = 0x1 - flagValue M.NoAutoStart = 0x2 -: - -:f DBus/Wire/Unmarshal.hs -decodeFlags :: Word8 -> Set.Set M.Flag -decodeFlags word = Set.fromList flags where - flagSet = [ (0x1, M.NoReplyExpected) - , (0x2, M.NoAutoStart) - ] - flags = flagSet >>= \(x, y) -> [y | word .&. x > 0] -: - -\subsubsection{Header fields} - -:f DBus/Wire/Marshal.hs -encodeField :: M.HeaderField -> T.Structure -encodeField (M.Path x) = encodeField' 1 x -encodeField (M.Interface x) = encodeField' 2 x -encodeField (M.Member x) = encodeField' 3 x -encodeField (M.ErrorName x) = encodeField' 4 x -encodeField (M.ReplySerial x) = encodeField' 5 x -encodeField (M.Destination x) = encodeField' 6 x -encodeField (M.Sender x) = encodeField' 7 x -encodeField (M.Signature x) = encodeField' 8 x - -encodeField' :: T.Variable a => Word8 -> a -> T.Structure -encodeField' code x = T.Structure - [ T.toVariant code - , T.toVariant $ T.toVariant x - ] -: - -:f DBus/Wire/Unmarshal.hs -decodeField :: T.Structure - -> E.ErrorM UnmarshalError [M.HeaderField] -decodeField struct = case unpackField struct of - (1, x) -> decodeField' x M.Path "path" - (2, x) -> decodeField' x M.Interface "interface" - (3, x) -> decodeField' x M.Member "member" - (4, x) -> decodeField' x M.ErrorName "error name" - (5, x) -> decodeField' x M.ReplySerial "reply serial" - (6, x) -> decodeField' x M.Destination "destination" - (7, x) -> decodeField' x M.Sender "sender" - (8, x) -> decodeField' x M.Signature "signature" - _ -> return [] - -decodeField' :: T.Variable a => T.Variant -> (a -> b) -> Text - -> E.ErrorM UnmarshalError [b] -decodeField' x f label = case T.fromVariant x of - Just x' -> return [f x'] - Nothing -> E.throwErrorM $ InvalidHeaderField label x -: - -:f DBus/Wire/Unmarshal.hs -unpackField :: T.Structure -> (Word8, T.Variant) -unpackField struct = (c', v') where - T.Structure [c, v] = struct - c' = fromJust . T.fromVariant $ c - v' = fromJust . T.fromVariant $ v -: - -\subsubsection{Header layout} - -TODO: describe header layout here - -\subsubsection{Marshaling} - -:d wire exports -, marshalMessage -: - -:f DBus/Wire/Marshal.hs -|apidoc marshalMessage| -marshalMessage :: M.Message a => Endianness -> M.Serial -> a - -> Either MarshalError L.ByteString -marshalMessage e serial msg = runMarshal marshaler e where - body = M.messageBody msg - marshaler = do - sig <- checkBodySig body - empty <- getState - mapM_ marshal body - (MarshalState bodyBytesB _) <- getState - putState empty - marshalEndianness e - let bodyBytes = B.toLazyByteString bodyBytesB - marshalHeader msg serial sig - $ fromIntegral . L.length $ bodyBytes - pad 8 - appendL bodyBytes - checkMaximumSize -: - -:f DBus/Wire/Marshal.hs -checkBodySig :: [T.Variant] -> MarshalM T.Signature -checkBodySig vs = let - textSig = TL.concat . map (T.typeCode . T.variantType) $ vs - bytesSig = BS.concat . map (T.typeCodeB . T.variantType) $ vs - invalid = throwError $ InvalidBodySignature textSig - in case T.mkBytesSignature bytesSig of - Just x -> return x - Nothing -> invalid -: - -:f DBus/Wire/Marshal.hs -marshalHeader :: M.Message a => a -> M.Serial -> T.Signature -> Word32 - -> Marshal -marshalHeader msg serial bodySig bodyLength = do - let fields = M.Signature bodySig : M.messageHeaderFields msg - marshalWord8 . M.messageTypeCode $ msg - marshalWord8 . encodeFlags . M.messageFlags $ msg - marshalWord8 C.protocolVersion - marshalWord32 bodyLength - marshalWord32 . M.serialValue $ serial - let fieldType = T.DBusStructure [T.DBusByte, T.DBusVariant] - marshalArray . fromJust . T.toArray fieldType - $ map encodeField fields -: - -:f DBus/Wire/Marshal.hs -marshalEndianness :: Endianness -> Marshal -marshalEndianness = marshal . T.toVariant . encodeEndianness -: - -:f DBus/Wire/Marshal.hs -checkMaximumSize :: Marshal -checkMaximumSize = do - (MarshalState _ messageLength) <- getState - when (messageLength > fromIntegral C.messageMaximumLength) - (throwError $ MessageTooLong $ fromIntegral messageLength) -: - -\subsubsection{Unmarshaling} - -:d unmarshal imports -import qualified DBus.Constants as C -: - -:d wire exports -, unmarshalMessage -: - -:f DBus/Wire/Unmarshal.hs -|apidoc unmarshalMessage| -unmarshalMessage :: Monad m => (Word32 -> m BL.ByteString) - -> m (Either UnmarshalError M.ReceivedMessage) -unmarshalMessage getBytes' = E.runErrorT $ do - let getBytes = E.ErrorT . liftM Right . getBytes' - - |read fixed-length header| - |read full header| - |read body| - |build message| -: - -The first part of the header has a fixed size of 16 bytes, so it can be -retrieved without any size calculations. - -:d read fixed-length header -let fixedSig = "yyyyuuu" -fixedBytes <- getBytes 16 -: - -The first field of interest is the protocol version; if the incoming -message's version is different from this library, the message cannot be -parsed. - -:d read fixed-length header -let messageVersion = BL.index fixedBytes 3 -when (messageVersion /= C.protocolVersion) $ - E.throwErrorT $ UnsupportedProtocolVersion messageVersion -: - -Next is the endianness, used for parsing pretty much every other field. - -:d read fixed-length header -let eByte = BL.index fixedBytes 0 -endianness <- case decodeEndianness eByte of - Just x' -> return x' - Nothing -> E.throwErrorT . Invalid "endianness" . TL.pack . show $ eByte -: - -With the endianness out of the way, the rest of the fixed header -can be decoded - -:d read fixed-length header -let unmarshal' x bytes = case runUnmarshal (unmarshal x) endianness bytes of - Right x' -> return x' - Left e -> E.throwErrorT e -fixed <- unmarshal' fixedSig fixedBytes -let typeCode = fromJust . T.fromVariant $ fixed !! 1 -let flags = decodeFlags . fromJust . T.fromVariant $ fixed !! 2 -let bodyLength = fromJust . T.fromVariant $ fixed !! 4 -let serial = fromJust . T.fromVariant $ fixed !! 5 -: - -The last field of the fixed header is actually part of the field array, -but is treated as a single {\tt Word32} so it'll be known how many bytes -to retrieve. - -:d read fixed-length header -let fieldByteCount = fromJust . T.fromVariant $ fixed !! 6 -: - -With the field byte count, the remainder of the header bytes can be -pulled out of the monad. - -:d read full header -let headerSig = "yyyyuua(yv)" -fieldBytes <- getBytes fieldByteCount -let headerBytes = BL.append fixedBytes fieldBytes -header <- unmarshal' headerSig headerBytes -: - -And the header fields can be parsed. - -:d read full header -let fieldArray = fromJust . T.fromVariant $ header !! 6 -let fieldStructures = fromJust . T.fromArray $ fieldArray -fields <- case E.runErrorM $ concat `liftM` mapM decodeField fieldStructures of - Left err -> E.throwErrorT err - Right x -> return x -: - -The body is always aligned to 8 bytes, so pull out the padding before -unmarshaling it. - -:d read body -let bodyPadding = padding (fromIntegral fieldByteCount + 16) 8 -void (getBytes (fromIntegral bodyPadding)) -: - -:f DBus/Wire/Unmarshal.hs -findBodySignature :: [M.HeaderField] -> T.Signature -findBodySignature fields = fromMaybe "" signature where - signature = listToMaybe [x | M.Signature x <- fields] -: - -:d read body -let bodySig = findBodySignature fields -: - -Then pull the body bytes, and unmarshal it. - -:d read body -bodyBytes <- getBytes bodyLength -body <- unmarshal' bodySig bodyBytes -: - -Even if the received message was structurally valid, building the -{\tt ReceivedMessage} can still fail due to missing header fields. - -:d build message -y <- case E.runErrorM $ buildReceivedMessage typeCode fields of - Right x -> return x - Left err -> E.throwErrorT $ MissingHeaderField err -return $ y serial flags body -: - -This really belongs in the Message section... - -:f DBus/Wire/Unmarshal.hs -buildReceivedMessage :: Word8 -> [M.HeaderField] -> E.ErrorM Text - (M.Serial -> (Set.Set M.Flag) -> [T.Variant] - -> M.ReceivedMessage) -: - -Method calls - -:f DBus/Wire/Unmarshal.hs -buildReceivedMessage 1 fields = do - path <- require "path" [x | M.Path x <- fields] - member <- require "member name" [x | M.Member x <- fields] - return $ \serial flags body -> let - iface = listToMaybe [x | M.Interface x <- fields] - dest = listToMaybe [x | M.Destination x <- fields] - sender = listToMaybe [x | M.Sender x <- fields] - msg = M.MethodCall path member iface dest flags body - in M.ReceivedMethodCall serial sender msg -: - -Method returns - -:f DBus/Wire/Unmarshal.hs -buildReceivedMessage 2 fields = do - replySerial <- require "reply serial" [x | M.ReplySerial x <- fields] - return $ \serial _ body -> let - dest = listToMaybe [x | M.Destination x <- fields] - sender = listToMaybe [x | M.Sender x <- fields] - msg = M.MethodReturn replySerial dest body - in M.ReceivedMethodReturn serial sender msg -: - -Errors - -:f DBus/Wire/Unmarshal.hs -buildReceivedMessage 3 fields = do - name <- require "error name" [x | M.ErrorName x <- fields] - replySerial <- require "reply serial" [x | M.ReplySerial x <- fields] - return $ \serial _ body -> let - dest = listToMaybe [x | M.Destination x <- fields] - sender = listToMaybe [x | M.Sender x <- fields] - msg = M.Error name replySerial dest body - in M.ReceivedError serial sender msg -: - -Signals - -:f DBus/Wire/Unmarshal.hs -buildReceivedMessage 4 fields = do - path <- require "path" [x | M.Path x <- fields] - member <- require "member name" [x | M.Member x <- fields] - iface <- require "interface" [x | M.Interface x <- fields] - return $ \serial _ body -> let - dest = listToMaybe [x | M.Destination x <- fields] - sender = listToMaybe [x | M.Sender x <- fields] - msg = M.Signal path member iface dest body - in M.ReceivedSignal serial sender msg -: - -Unknown - -:f DBus/Wire/Unmarshal.hs -buildReceivedMessage typeCode fields = return $ \serial flags body -> let - sender = listToMaybe [x | M.Sender x <- fields] - msg = M.Unknown typeCode flags body - in M.ReceivedUnknown serial sender msg -: - -:f DBus/Wire/Unmarshal.hs -require :: Text -> [a] -> E.ErrorM Text a -require _ (x:_) = return x -require label _ = E.throwErrorM label -: - -:f Tests.hs -prop_Unmarshal :: Endianness -> Variant -> Property -prop_Unmarshal e x = valid ==> unmarshaled == Right [x] where - sig = mkSignature . typeCode . variantType $ x - Just sig' = sig - - bytes = runMarshal (marshal x) e - Right bytes' = bytes - - valid = isJust sig && isRight bytes - unmarshaled = runUnmarshal (unmarshal sig') e bytes' - -prop_MarshalMessage e serial msg expected = valid ==> correct where - bytes = marshalMessage e serial msg - Right bytes' = bytes - - getBytes = G.getLazyByteString . fromIntegral - unmarshaled = G.runGet (unmarshalMessage getBytes) bytes' - - valid = isRight bytes - correct = unmarshaled == Right expected - -prop_WireMethodCall e serial msg = prop_MarshalMessage e serial msg - $ ReceivedMethodCall serial Nothing msg - -prop_WireMethodReturn e serial msg = prop_MarshalMessage e serial msg - $ ReceivedMethodReturn serial Nothing msg - -prop_WireError e serial msg = prop_MarshalMessage e serial msg - $ ReceivedError serial Nothing msg - -prop_WireSignal e serial msg = prop_MarshalMessage e serial msg - $ ReceivedSignal serial Nothing msg -: - -:d test cases -, F.testGroup "Wire format" - [ testProperty "Marshal -> Ummarshal" prop_Unmarshal - , F.testGroup "Messages" - [ testProperty "Method calls" prop_WireMethodCall - , testProperty "Method returns" prop_WireMethodReturn - , testProperty "Errors" prop_WireError - , testProperty "Signals" prop_WireSignal - ] - ] +:# Copyright (C) 2009-2011 John Millikin +:# +:# 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 +:# 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 . + +\section{Wire format} + +\begin{multicols}{2} + +\dbus{} uses a simple binary format to serialize messages. Because the format +is binary, the \emph{endianness} of serialized values is important. \dbus{} +supports both big- and little-endian serialization, so clients can choose +whichever is more efficient on their hardware. + +\vfill +\columnbreak + +:d DBus.Wire +data Endianness = LittleEndian | BigEndian + deriving (Show, Eq) +: + +\end{multicols} + +\begin{multicols}{2} + +When written over the wire, message endianness is represented as a single +byte: {\tt 0x6C} for little-endian, {\tt 0x42} for big-endian. These magic +numbers are the {\sc ascii} values for {\tt 'l'} and {\tt 'B'}, respectively. + +\vfill +\columnbreak + +:d DBus.Wire +encodeEndianness :: Endianness -> Word8 +encodeEndianness LittleEndian = 0x6C +encodeEndianness BigEndian = 0x42 + +decodeEndianness :: Word8 -> Maybe Endianness +decodeEndianness 0x6C = Just LittleEndian +decodeEndianness 0x42 = Just BigEndian +decodeEndianness _ = Nothing +: + +\end{multicols} + +\begin{multicols}{2} + +Each built-in type has an associated alignment. When serialized, padding is +inserted between values to ensure they always start at their preferred +alignment. + +Numeric values are fixed-length, and aligned ``naturally''; eg, a 4-byte +integer will have a 4-byte alignment. Types with a length prefix, such as +strings and arrays, use their length's alignment. + +\vfill +\columnbreak + +:d DBus.Wire +alignment :: Type -> Word8 +alignment TypeBoolean = 4 +alignment TypeWord8 = 1 +alignment TypeWord16 = 2 +alignment TypeWord32 = 4 +alignment TypeWord64 = 8 +alignment TypeInt16 = 2 +alignment TypeInt32 = 4 +alignment TypeInt64 = 8 +alignment TypeDouble = 8 +alignment TypeString = 4 +alignment TypeObjectPath = 4 +alignment TypeSignature = 1 +alignment (TypeArray _) = 4 +alignment (TypeDictionary _ _) = 4 +alignment (TypeStructure _) = 8 +alignment TypeVariant = 1 +: + +:d DBus.Wire +padding :: Word64 -> Word8 -> Word64 +padding current count = required where + count' = fromIntegral count + missing = mod current count' + required = if missing > 0 + then count' - missing + else 0 +: + +\end{multicols} + +\clearpage +\subsection{Serialization support} + +\begin{multicols}{2} + +Messages can be quite large, so it's important that both the serializer and +parser be efficient. The standard {\tt Get} and {\tt Put} monads are too slow, +so I define my own type for building and parsing binary data. This is +equivalent to an {\tt ErrorT . ReaderT . StateT} stack, but inlined and +strict. + +\vfill +\columnbreak + +:d DBus.Wire +data WireR s a + = WireRL String + | WireRR a {-# UNPACK #-} !s + +newtype Wire s a = Wire + { unWire :: Endianness -> s -> WireR s a + } + +instance Monad (Wire s) where + {-# INLINE return #-} + return a = Wire (\_ s -> WireRR a s) + + {-# INLINE (>>=) #-} + m >>= k = Wire $ \e s -> case unWire m e s of + WireRL err -> WireRL err + WireRR a s' -> unWire (k a) e s' + + {-# INLINE (>>) #-} + m >> k = Wire $ \e s -> case unWire m e s of + WireRL err -> WireRL err + WireRR _ s' -> unWire k e s' + +throwError :: String -> Wire s a +throwError err = Wire (\_ _ -> WireRL err) + +{-# INLINE getState #-} +getState :: Wire s s +getState = Wire (\_ s -> WireRR s s) + +{-# INLINE putState #-} +putState :: s -> Wire s () +putState s = Wire (\_ _ -> WireRR () s) + +{-# INLINE chooseEndian #-} +chooseEndian :: a -> a -> Wire s a +chooseEndian big little = Wire (\e s -> case e of + BigEndian -> WireRR big s + LittleEndian -> WireRR little s) +: + +\end{multicols} + +\clearpage +\subsubsection{Marshaling} + +\begin{multicols}{2} + +Marshaling is the process of converting a sequence of values into a +{\tt ByteString}. The {\tt Builder} type is used for efficient construction +of lazy byte strings, but it doesn't provide any way to retrieve the length +of its internal buffer, so the byte count is tracked separately. + +\vfill +\columnbreak + +:d DBus.Wire +type Marshal = Wire MarshalState + +newtype MarshalError = MarshalError Text + deriving (Show, Eq) + +data MarshalState = MarshalState + {-# UNPACK #-} !Data.Binary.Builder.Builder + {-# UNPACK #-} !Word64 +: + +\end{multicols} + +\begin{multicols}{2} + +TODO + +\vfill +\columnbreak + +:d DBus.Wire +marshal :: Value -> Marshal () +marshal (ValueAtom x) = marshalAtom x +marshal (ValueBytes xs) = marshalStrictBytes xs +marshal (ValueVector t xs) = marshalVector t xs +marshal (ValueMap kt vt xs) = marshalMap kt vt xs +marshal (ValueStructure xs) = marshalStructure xs +marshal (ValueVariant x) = marshalVariant x +: + +:d DBus.Wire +marshalAtom :: Atom -> Marshal () +marshalAtom (AtomWord8 x) = marshalWord8 x +marshalAtom (AtomWord16 x) = marshalWord16 x +marshalAtom (AtomWord32 x) = marshalWord32 x +marshalAtom (AtomWord64 x) = marshalWord64 x +marshalAtom (AtomInt16 x) = marshalInt16 x +marshalAtom (AtomInt32 x) = marshalInt32 x +marshalAtom (AtomInt64 x) = marshalInt64 x +marshalAtom (AtomDouble x) = marshalDouble x +marshalAtom (AtomBool x) = marshalBool x +marshalAtom (AtomText x) = marshalText x +marshalAtom (AtomObjectPath x) = marshalObjectPath x +marshalAtom (AtomSignature x) = marshalSignature x +: + +\end{multicols} + +\clearpage + +TODO: describe these functions + +:d DBus.Wire +appendB :: Word64 -> Data.Binary.Builder.Builder -> Marshal () +appendB size bytes = Wire (\_ (MarshalState builder count) -> let + builder' = Data.Binary.Builder.append builder bytes + count' = count + size + in WireRR () (MarshalState builder' count')) +: + +:d DBus.Wire +appendS :: ByteString -> Marshal () +appendS bytes = appendB + (fromIntegral (Data.ByteString.length bytes)) + (Data.Binary.Builder.fromByteString bytes) +: + +:d DBus.Wire +appendL :: Data.ByteString.Lazy.ByteString -> Marshal () +appendL bytes = appendB + (fromIntegral (Data.ByteString.Lazy.length bytes)) + (Data.Binary.Builder.fromLazyByteString bytes) +: + +:d DBus.Wire +pad :: Word8 -> Marshal () +pad count = do + (MarshalState _ existing) <- getState + let padding' = fromIntegral (padding existing count) + appendS (Data.ByteString.replicate padding' 0) +: + +Most numeric values already have marshalers implemented in the +{\tt Data.Binary.Builder} module; this function lets them be re-used easily. + +:d DBus.Wire +marshalBuilder :: Word8 + -> (a -> Data.Binary.Builder.Builder) + -> (a -> Data.Binary.Builder.Builder) + -> a -> Marshal () +marshalBuilder size be le x = do + builder <- chooseEndian (be x) (le x) + pad size + appendB (fromIntegral size) builder +: + + +\clearpage +\subsubsection{Unmarshaling} + +\begin{multicols}{2} + +TODO + +\vfill +\columnbreak + +:d DBus.Wire +type Unmarshal = Wire UnmarshalState + +newtype UnmarshalError = UnmarshalError Text + deriving (Show, Eq) + +data UnmarshalState = UnmarshalState + {-# UNPACK #-} !ByteString + {-# UNPACK #-} !Word64 +: + +\end{multicols} + +\begin{multicols}{2} + +TODO + +\vfill +\columnbreak + +:d DBus.Wire +unmarshal :: Type -> Unmarshal Value +unmarshal TypeWord8 = liftM toValue unmarshalWord8 +unmarshal TypeWord16 = liftM toValue unmarshalWord16 +unmarshal TypeWord32 = liftM toValue unmarshalWord32 +unmarshal TypeWord64 = liftM toValue unmarshalWord64 +unmarshal TypeInt16 = liftM toValue unmarshalInt16 +unmarshal TypeInt32 = liftM toValue unmarshalInt32 +unmarshal TypeInt64 = liftM toValue unmarshalInt64 +unmarshal TypeDouble = liftM toValue unmarshalDouble +unmarshal TypeBoolean = liftM toValue unmarshalBool +unmarshal TypeString = liftM toValue unmarshalText +unmarshal TypeObjectPath = liftM toValue unmarshalObjectPath +unmarshal TypeSignature = liftM toValue unmarshalSignature +unmarshal (TypeArray TypeWord8) = liftM toValue unmarshalByteArray +unmarshal (TypeArray t) = liftM (ValueVector t) (unmarshalArray t) +unmarshal (TypeDictionary kt vt) = unmarshalDictionary kt vt +unmarshal (TypeStructure ts) = unmarshalStructure ts +unmarshal TypeVariant = unmarshalVariant +: + +\end{multicols} + +\clearpage + +TODO: describe these functions + +:d DBus.Wire +{-# INLINE consume #-} +consume :: Word64 -> Unmarshal ByteString +consume count = do + (UnmarshalState bytes offset) <- getState + let count' = fromIntegral count + let (x, bytes') = Data.ByteString.splitAt count' bytes + let lenConsumed = Data.ByteString.length x + if lenConsumed == count' + then do + putState (UnmarshalState bytes' (offset + count)) + return x + else throwError (concat + [ "Unexpected EOF at offset " + , show (offset + fromIntegral lenConsumed) + ]) +: + +:d DBus.Wire +skipPadding :: Word8 -> Unmarshal () +skipPadding count = do + (UnmarshalState _ offset) <- getState + bytes <- consume (padding offset count) + unless (Data.ByteString.all (== 0) bytes) (throwError (concat + [ "Value padding ", show bytes + , " contains invalid bytes." + ])) +: + +:d DBus.Wire +skipTerminator :: Unmarshal () +skipTerminator = do + byte <- unmarshalWord8 + when (byte /= 0) (throwError "Textual value is not NUL-terminated.") +: + +:d DBus.Wire +fromMaybeU :: Show a => String -> (a -> Maybe b) -> a -> Unmarshal b +fromMaybeU label f x = case f x of + Just x' -> return x' + Nothing -> throwError (concat ["Invalid ", label, ": ", show x]) +: + +:d DBus.Wire +unmarshalGet :: Word8 -> Data.Binary.Get.Get a -> Data.Binary.Get.Get a -> Unmarshal a +unmarshalGet count be le = do + skipPadding count + bytes <- consume (fromIntegral count) + get <- chooseEndian be le + let lazy = Data.ByteString.Lazy.fromChunks [bytes] + return (Data.Binary.Get.runGet get lazy) +: + + +\clearpage +\subsection{Atoms} +\subsubsection{Integers} + +:d DBus.Wire +marshalWord8 :: Word8 -> Marshal () +marshalWord8 x = appendB 1 (Data.Binary.Builder.singleton x) + +unmarshalWord8 :: Unmarshal Word8 +unmarshalWord8 = liftM Data.ByteString.head (consume 1) +: + +\begin{multicols}{2} + +:d DBus.Wire +marshalWord16 :: Word16 -> Marshal () +marshalWord16 = marshalBuilder 2 + Data.Binary.Builder.putWord16be + Data.Binary.Builder.putWord16le + +marshalWord32 :: Word32 -> Marshal () +marshalWord32 = marshalBuilder 4 + Data.Binary.Builder.putWord32be + Data.Binary.Builder.putWord32le + +marshalWord64 :: Word64 -> Marshal () +marshalWord64 = marshalBuilder 8 + Data.Binary.Builder.putWord64be + Data.Binary.Builder.putWord64le + +marshalInt16 :: Int16 -> Marshal () +marshalInt16 = marshalWord16 . fromIntegral + +marshalInt32 :: Int32 -> Marshal () +marshalInt32 = marshalWord32 . fromIntegral + +marshalInt64 :: Int64 -> Marshal () +marshalInt64 = marshalWord64 . fromIntegral +: + +\columnbreak + +:d DBus.Wire +unmarshalWord16 :: Unmarshal Word16 +unmarshalWord16 = unmarshalGet 2 + Data.Binary.Get.getWord16be + Data.Binary.Get.getWord16le + +unmarshalWord32 :: Unmarshal Word32 +unmarshalWord32 = unmarshalGet 4 + Data.Binary.Get.getWord32be + Data.Binary.Get.getWord32le + +unmarshalWord64 :: Unmarshal Word64 +unmarshalWord64 = unmarshalGet 8 + Data.Binary.Get.getWord64be + Data.Binary.Get.getWord64le + +unmarshalInt16 :: Unmarshal Int16 +unmarshalInt16 = liftM fromIntegral unmarshalWord16 + +unmarshalInt32 :: Unmarshal Int32 +unmarshalInt32 = liftM fromIntegral unmarshalWord32 + +unmarshalInt64 :: Unmarshal Int64 +unmarshalInt64 = liftM fromIntegral unmarshalWord64 +: + +\end{multicols} + +\clearpage +\subsubsection{Doubles} + +\begin{multicols}{2} + +{\tt Double}s are marshaled in 64-bit IEEE-754 floating-point format. + +\vfill +\columnbreak + +:d DBus.Wire +marshalDouble :: Double -> Marshal () +marshalDouble x = do + put <- chooseEndian + Data.Binary.IEEE754.putFloat64be + Data.Binary.IEEE754.putFloat64le + pad 8 + appendL (runPut (put x)) + +unmarshalDouble :: Unmarshal Double +unmarshalDouble = unmarshalGet 8 + Data.Binary.IEEE754.getFloat64be + Data.Binary.IEEE754.getFloat64le +: + +\end{multicols} + +\subsubsection{Booleans} + +\begin{multicols}{2} + +Booleans are marshaled as 4-byte unsigned integers containing either of +the values 0 or 1. Yes, really. + +\vfill +\columnbreak + +:d DBus.Wire +marshalBool :: Bool -> Marshal () +marshalBool False = marshalWord32 0 +marshalBool True = marshalWord32 1 + +unmarshalBool :: Unmarshal Bool +unmarshalBool = do + word <- unmarshalWord32 + case word of + 0 -> return False + 1 -> return True + _ -> throwError (concat + [ "Invalid boolean: " + , show word + ]) +: + +\end{multicols} + +\clearpage +\subsubsection{Strings and object paths} + +Strings are encoded in {\sc utf-8}, terminated with {\tt NUL}, and prefixed +with their length as an unsigned 32-bit integer. Their alignment is that of +their length. Object paths are marshaled just like strings, though additional +checks are required when unmarshaling. + +:d DBus.Wire +marshalText :: Text -> Marshal () +marshalText text = do + let bytes = Data.Text.Encoding.encodeUtf8 text + when (Data.ByteString.any (== 0) bytes) (throwError (concat + [ "String " + , show text + , " contained forbidden character: '\\x00'" + ])) + marshalWord32 (fromIntegral (Data.ByteString.length bytes)) + appendS bytes + marshalWord8 0 +: + +:d DBus.Wire +unmarshalText :: Unmarshal Text +unmarshalText = do + byteCount <- unmarshalWord32 + bytes <- consume (fromIntegral byteCount) + skipTerminator + fromMaybeU "text" maybeDecodeUtf8 bytes + +maybeDecodeUtf8 :: ByteString -> Maybe Text +maybeDecodeUtf8 bs = case Data.Text.Encoding.decodeUtf8' bs of + Right text -> Just text + _ -> Nothing +: + +:d DBus.Wire +marshalObjectPath :: ObjectPath -> Marshal () +marshalObjectPath = marshalText . objectPathText +: + +:d DBus.Wire +unmarshalObjectPath :: Unmarshal ObjectPath +unmarshalObjectPath = do + text <- unmarshalText + fromMaybeU "object path" objectPath text +: + +\clearpage +\subsubsection{Signatures} + +Signatures are similar to strings, except their length is limited to 255 +characters and is therefore stored as a single byte. + +:d DBus.Wire +signatureBytes :: Signature -> ByteString +signatureBytes (Signature ts) = Data.ByteString.Char8.pack (concatMap typeCode ts) + +marshalSignature :: Signature -> Marshal () +marshalSignature x = do + let bytes = signatureBytes x + marshalWord8 (fromIntegral (Data.ByteString.length bytes)) + appendS bytes + marshalWord8 0 +: + +:d DBus.Wire +unmarshalSignature :: Unmarshal Signature +unmarshalSignature = do + byteCount <- unmarshalWord8 + bytes <- consume (fromIntegral byteCount) + skipTerminator + fromMaybeU "signature" parseSignature bytes +: + +\clearpage +\subsection{Containers} +\subsubsection{Arrays} + +Marshaling arrays is complicated, because the array body must be marshaled +\emph{first} to calculate the array length. This requires building a +temporary marshaler, to get the padding right. + +:d DBus.Wire +arrayMaximumLength :: Int64 +arrayMaximumLength = 67108864 +: + +:d DBus.Wire +marshalVector :: Type -> Vector Value -> Marshal () +marshalVector t x = do + (arrayPadding, arrayBytes) <- getArrayBytes t x + let arrayLen = Data.ByteString.Lazy.length arrayBytes + when (arrayLen > arrayMaximumLength) (throwError (concat + [ "Marshaled array size (" + , show arrayLen + , " bytes) exceeds maximum limit of (" + , show arrayMaximumLength + , " bytes)." + ])) + marshalWord32 (fromIntegral arrayLen) + appendL (Data.ByteString.Lazy.replicate arrayPadding 0) + appendL arrayBytes + +marshalStrictBytes :: ByteString -> Marshal () +marshalStrictBytes bytes = do + let arrayLen = Data.ByteString.length bytes + when (fromIntegral arrayLen > arrayMaximumLength) (throwError (concat + [ "Marshaled array size (" + , show arrayLen + , " bytes) exceeds maximum limit of (" + , show arrayMaximumLength + , " bytes)." + ])) + marshalWord32 (fromIntegral arrayLen) + appendS bytes +: + +:d DBus.Wire +getArrayBytes :: Type -> Vector Value -> Marshal (Int64, Data.ByteString.Lazy.ByteString) +getArrayBytes itemType vs = do + s <- getState + (MarshalState _ afterLength) <- marshalWord32 0 >> getState + (MarshalState _ afterPadding) <- pad (alignment itemType) >> getState + + putState (MarshalState Data.Binary.Builder.empty afterPadding) + (MarshalState itemBuilder _) <- Data.Vector.mapM_ marshal vs >> getState + + let itemBytes = Data.Binary.Builder.toLazyByteString itemBuilder + paddingSize = fromIntegral (afterPadding - afterLength) + + putState s + return (paddingSize, itemBytes) +: + +Unmarshaling is much easier, especially if it's a byte array. + +:d DBus.Wire +unmarshalByteArray :: Unmarshal ByteString +unmarshalByteArray = do + byteCount <- unmarshalWord32 + consume (fromIntegral byteCount) + +unmarshalArray :: Type -> Unmarshal (Vector Value) +unmarshalArray itemType = do + let getOffset = do + (UnmarshalState _ o) <- getState + return o + byteCount <- unmarshalWord32 + skipPadding (alignment itemType) + start <- getOffset + let end = start + fromIntegral byteCount + vs <- untilM (liftM (>= end) getOffset) (unmarshal itemType) + end' <- getOffset + when (end' > end) (throwError (concat + [ "Array data size exeeds array size of " + , show end + ])) + return (Data.Vector.fromList vs) +: + +\clearpage +\subsubsection{Dictionaries} + +:d DBus.Wire +dictionaryToArray :: Map Atom Value -> Vector Value +dictionaryToArray = Data.Vector.fromList . map step . Data.Map.toList where + step (k, v) = ValueStructure [ValueAtom k, v] +: + +:d DBus.Wire +arrayToDictionary :: Vector Value -> Map Atom Value +arrayToDictionary = Data.Map.fromList . map step . Data.Vector.toList where + step (ValueStructure [ValueAtom k, v]) = (k, v) + step _ = error "arrayToDictionary: internal error" +: + +:d DBus.Wire +marshalMap :: Type -> Type -> Map Atom Value -> Marshal () +marshalMap kt vt x = let + structType = TypeStructure [kt, vt] + array = dictionaryToArray x + in marshalVector structType array +: + +:d DBus.Wire +unmarshalDictionary :: Type -> Type -> Unmarshal Value +unmarshalDictionary kt vt = do + let pairType = TypeStructure [kt, vt] + array <- unmarshalArray pairType + return (ValueMap kt vt (arrayToDictionary array)) +: + +\clearpage +\subsubsection{Structures} + +:d DBus.Wire +marshalStructure :: [Value] -> Marshal () +marshalStructure vs = do + pad 8 + mapM_ marshal vs +: + +:d DBus.Wire +unmarshalStructure :: [Type] -> Unmarshal Value +unmarshalStructure ts = do + skipPadding 8 + liftM ValueStructure (mapM unmarshal ts) +: + +\subsubsection{Variants} + +:d DBus.Wire +marshalVariant :: Variant -> Marshal () +marshalVariant var@(Variant val) = do + sig <- case checkSignature [valueType val] of + Just x' -> return x' + Nothing -> throwError (concat + [ "Signature " + , show (typeCode (valueType val)) + , " for variant " + , show var + , " is malformed or too large." + ]) + marshalSignature sig + marshal val +: + +:d DBus.Wire +unmarshalVariant :: Unmarshal Value +unmarshalVariant = do + let getType sig = case signatureTypes sig of + [t] -> Just t + _ -> Nothing + + t <- fromMaybeU "variant signature" getType =<< unmarshalSignature + (toValue . Variant) `liftM` unmarshal t +: + +\clearpage +\subsection{Messages} + +:d DBus.Wire +protocolVersion :: Word8 +protocolVersion = 1 + +messageMaximumLength :: Word64 +messageMaximumLength = 134217728 +: + +\subsubsection{Flags} + +:d DBus.Wire +encodeFlags :: Set Flag -> Word8 +encodeFlags flags = foldr (.|.) 0 (map flagValue (Data.Set.toList flags)) where + flagValue NoReplyExpected = 0x1 + flagValue NoAutoStart = 0x2 +: + +:d DBus.Wire +decodeFlags :: Word8 -> Set Flag +decodeFlags word = Data.Set.fromList flags where + flagSet = [ (0x1, NoReplyExpected) + , (0x2, NoAutoStart) + ] + flags = flagSet >>= \(x, y) -> [y | word .&. x > 0] +: + +\clearpage +\subsubsection{Header fields} + +:d DBus.Wire +encodeField :: HeaderField -> Value +encodeField (HeaderPath x) = encodeField' 1 x +encodeField (HeaderInterface x) = encodeField' 2 x +encodeField (HeaderMember x) = encodeField' 3 x +encodeField (HeaderErrorName x) = encodeField' 4 x +encodeField (HeaderReplySerial x) = encodeField' 5 x +encodeField (HeaderDestination x) = encodeField' 6 x +encodeField (HeaderSender x) = encodeField' 7 x +encodeField (HeaderSignature x) = encodeField' 8 x + +encodeField' :: IsVariant a => Word8 -> a -> Value +encodeField' code x = toValue (code, toVariant x) +: + +:d DBus.Wire +decodeField :: (Word8, Variant) + -> E.ErrorM UnmarshalError [HeaderField] +decodeField struct = case struct of + (1, x) -> decodeField' x HeaderPath "path" + (2, x) -> decodeField' x HeaderInterface "interface" + (3, x) -> decodeField' x HeaderMember "member" + (4, x) -> decodeField' x HeaderErrorName "error name" + (5, x) -> decodeField' x HeaderReplySerial "reply serial" + (6, x) -> decodeField' x HeaderDestination "destination" + (7, x) -> decodeField' x HeaderSender "sender" + (8, x) -> decodeField' x HeaderSignature "signature" + _ -> return [] + +decodeField' :: IsVariant a => Variant -> (a -> b) -> Text + -> E.ErrorM UnmarshalError [b] +decodeField' x f label = case fromVariant x of + Just x' -> return [f x'] + Nothing -> E.throwErrorM (UnmarshalError (Data.Text.pack (concat + [ "Header field " + , show label + , " contains invalid value " + , show x + ]))) +: + +\clearpage +\subsubsection{Marshaling} + +:d DBus.Wire +|apidoc DBus.Wire.marshalMessage| +marshalMessage :: Message a => Endianness -> Serial -> a + -> Either MarshalError Data.ByteString.ByteString +marshalMessage e serial msg = runMarshal where + body = messageBody msg + marshaler = do + sig <- checkBodySig body + empty <- getState + mapM_ (marshal . (\(Variant x) -> x)) body + (MarshalState bodyBytesB _) <- getState + putState empty + marshal (toValue (encodeEndianness e)) + let bodyBytes = Data.Binary.Builder.toLazyByteString bodyBytesB + marshalHeader msg serial sig (fromIntegral (Data.ByteString.Lazy.length bodyBytes)) + pad 8 + appendL bodyBytes + checkMaximumSize + emptyState = MarshalState Data.Binary.Builder.empty 0 + runMarshal = case unWire marshaler e emptyState of + WireRL err -> Left (MarshalError (Data.Text.pack err)) + WireRR _ (MarshalState builder _) -> Right (toStrict builder) + toStrict = Data.ByteString.concat + . Data.ByteString.Lazy.toChunks + . Data.Binary.Builder.toLazyByteString + +checkBodySig :: [Variant] -> Marshal Signature +checkBodySig vs = case checkSignature (map variantType vs) of + Just x -> return x + Nothing -> throwError (concat + [ "Message body ", show vs + , " has too many items" + ]) + +marshalHeader :: Message a => a -> Serial -> Signature -> Word32 + -> Marshal () +marshalHeader msg serial bodySig bodyLength = do + let fields = HeaderSignature bodySig : messageHeaderFields msg + marshalWord8 (messageTypeCode msg) + marshalWord8 (encodeFlags (messageFlags msg)) + marshalWord8 protocolVersion + marshalWord32 bodyLength + marshalWord32 (serialValue serial) + let fieldType = TypeStructure [TypeWord8, TypeVariant] + marshalVector fieldType (Data.Vector.fromList (map encodeField fields)) + +checkMaximumSize :: Marshal () +checkMaximumSize = do + (MarshalState _ messageLength) <- getState + when (messageLength > messageMaximumLength) (throwError (concat + [ "Marshaled message size (", show messageLength + , " bytes) exeeds maximum limit of (" + , show messageMaximumLength, " bytes)." + ])) +: + +\clearpage +\subsubsection{Unmarshaling} + +:d DBus.Wire +unmarshalMessageM :: Monad m => (Word32 -> m ByteString) + -> m (Either UnmarshalError ReceivedMessage) +unmarshalMessageM getBytes' = E.runErrorT $ do + let getBytes = E.ErrorT . liftM Right . getBytes' + + |read fixed-length header| + |read full header| + |read body| + |build message| +: + +The first part of the header has a fixed size of 16 bytes, so it can be +retrieved without any size calculations. + +:d read fixed-length header +let fixedSig = "yyyyuuu" +fixedBytes <- getBytes 16 +: + +The first field of interest is the protocol version; if the incoming +message's version is different from this library, the message cannot be +parsed. + +:d read fixed-length header +let messageVersion = Data.ByteString.index fixedBytes 3 +when (messageVersion /= protocolVersion) (E.throwErrorT (UnmarshalError (Data.Text.pack (concat + [ "Unsupported protocol version: " + , show messageVersion + ])))) +: + +Next is the endianness, used for parsing pretty much every other field. + +:d read fixed-length header +let eByte = Data.ByteString.index fixedBytes 0 +endianness <- case decodeEndianness eByte of + Just x' -> return x' + Nothing -> E.throwErrorT (UnmarshalError (Data.Text.pack (concat + [ "Invalid endianness: " + , show eByte + ]))) +: + +With the endianness out of the way, the rest of the fixed header +can be decoded + +:d read fixed-length header +let unmarshalSig = mapM unmarshal . signatureTypes +let unmarshal' x bytes = case unWire (unmarshalSig x) endianness (UnmarshalState bytes 0) of + WireRR x' _ -> return x' + WireRL err -> E.throwErrorT (UnmarshalError (Data.Text.pack err)) +fixed <- unmarshal' fixedSig fixedBytes +let messageType = fromJust (fromValue (fixed !! 1)) +let flags = decodeFlags (fromJust (fromValue (fixed !! 2))) +let bodyLength = fromJust (fromValue (fixed !! 4)) +let serial = fromJust (fromVariant (Variant (fixed !! 5))) +: + +The last field of the fixed header is actually part of the field array, +but is treated as a single {\tt Word32} so it'll be known how many bytes +to retrieve. + +:d read fixed-length header +let fieldByteCount = fromJust (fromValue (fixed !! 6)) +: + +With the field byte count, the remainder of the header bytes can be +pulled out of the monad. + +:d read full header +let headerSig = "yyyyuua(yv)" +fieldBytes <- getBytes fieldByteCount +let headerBytes = Data.ByteString.append fixedBytes fieldBytes +header <- unmarshal' headerSig headerBytes +: + +And the header fields can be parsed. + +:d read full header +let fieldArray = Data.Vector.toList (fromJust (fromValue (header !! 6))) +fields <- case E.runErrorM $ concat `liftM` mapM decodeField fieldArray of + Left err -> E.throwErrorT err + Right x -> return x +: + +The body is always aligned to 8 bytes, so pull out the padding before +unmarshaling it. + +:d read body +let bodyPadding = padding (fromIntegral fieldByteCount + 16) 8 +void (getBytes (fromIntegral bodyPadding)) +: + +:d DBus.Wire +findBodySignature :: [HeaderField] -> Signature +findBodySignature fields = fromMaybe "" (listToMaybe [x | HeaderSignature x <- fields]) +: + +:d read body +let bodySig = findBodySignature fields +: + +Then pull the body bytes, and unmarshal it. + +:d read body +bodyBytes <- getBytes bodyLength +body <- unmarshal' bodySig bodyBytes +: + +Even if the received message was structurally valid, building the +{\tt ReceivedMessage} can still fail due to missing header fields. + +:d build message +y <- case E.runErrorM (buildReceivedMessage messageType fields) of + Right x -> return x + Left err -> E.throwErrorT (UnmarshalError (Data.Text.pack (concat + [ "Header field " + , show err + , " is required, but missing" + ]))) +return (y serial flags (map Variant body)) +: + +This really belongs in the Message section... + +:d DBus.Wire +buildReceivedMessage :: Word8 -> [HeaderField] -> E.ErrorM Text + (Serial -> (Set Flag) -> [Variant] + -> ReceivedMessage) +: + +Method calls + +:d DBus.Wire +buildReceivedMessage 1 fields = do + path <- require "path" [x | HeaderPath x <- fields] + member <- require "member name" [x | HeaderMember x <- fields] + return $ \serial flags body -> let + iface = listToMaybe [x | HeaderInterface x <- fields] + dest = listToMaybe [x | HeaderDestination x <- fields] + sender = listToMaybe [x | HeaderSender x <- fields] + msg = MethodCall path member iface dest flags body + in ReceivedMethodCall serial sender msg +: + +Method returns + +:d DBus.Wire +buildReceivedMessage 2 fields = do + replySerial <- require "reply serial" [x | HeaderReplySerial x <- fields] + return $ \serial _ body -> let + dest = listToMaybe [x | HeaderDestination x <- fields] + sender = listToMaybe [x | HeaderSender x <- fields] + msg = MethodReturn replySerial dest body + in ReceivedMethodReturn serial sender msg +: + +Errors + +:d DBus.Wire +buildReceivedMessage 3 fields = do + name <- require "error name" [x | HeaderErrorName x <- fields] + replySerial <- require "reply serial" [x | HeaderReplySerial x <- fields] + return $ \serial _ body -> let + dest = listToMaybe [x | HeaderDestination x <- fields] + sender = listToMaybe [x | HeaderSender x <- fields] + msg = Error name replySerial dest body + in ReceivedError serial sender msg +: + +Signals + +:d DBus.Wire +buildReceivedMessage 4 fields = do + path <- require "path" [x | HeaderPath x <- fields] + member <- require "member name" [x | HeaderMember x <- fields] + iface <- require "interface" [x | HeaderInterface x <- fields] + return $ \serial _ body -> let + dest = listToMaybe [x | HeaderDestination x <- fields] + sender = listToMaybe [x | HeaderSender x <- fields] + msg = Signal dest path iface member body + in ReceivedSignal serial sender msg +: + +Unknown + +:d DBus.Wire +buildReceivedMessage messageType fields = return $ \serial flags body -> let + sender = listToMaybe [x | HeaderSender x <- fields] + msg = Unknown messageType flags body + in ReceivedUnknown serial sender msg +: + +:d DBus.Wire +require :: Text -> [a] -> E.ErrorM Text a +require _ (x:_) = return x +require label _ = E.throwErrorM label +: + +To simplify the public interface, the incremental interface to message +unmarshaling is hidden. Clients just need to pass in a single bytestring. +This is OK, because clients do not need to read full messages off a socket +(they typically use this for parsing stored messages). + +:d DBus.Wire +|apidoc DBus.Wire.unmarshalMessage| +unmarshalMessage :: ByteString -> Either UnmarshalError ReceivedMessage +unmarshalMessage = Data.Binary.Get.runGet get . toLazy where + get = unmarshalMessageM getBytes + getBytes = Data.Binary.Get.getByteString . fromIntegral + toLazy bs = Data.ByteString.Lazy.fromChunks [bs] : diff --git a/tests/Tests.hs b/tests/Tests.hs new file mode 100644 --- /dev/null +++ b/tests/Tests.hs @@ -0,0 +1,925 @@ +{-# LANGUAGE OverloadedStrings #-} + +-- Copyright (C) 2010-2011 John Millikin +-- +-- 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 +-- 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 . + +module Main (tests, main) where + +import Test.Framework (Test, testGroup) +import qualified Test.Framework +import Test.Framework.Providers.QuickCheck2 (testProperty) +import Test.Framework.Providers.HUnit (testCase) +import Test.HUnit (Assertion, assertFailure) +import qualified Test.HUnit +import Test.QuickCheck hiding ((.&.)) + +import Control.Applicative ((<$>), (<*>)) +import qualified Control.Exception +import Control.Monad (liftM, liftM2) +import qualified Data.Binary.Builder +import Data.Bits ((.&.)) +import Data.ByteString (ByteString) +import qualified Data.ByteString +import qualified Data.ByteString.Lazy +import Data.Char (chr) +import Data.List (intercalate) +import Data.Text (Text) +import qualified Data.Text as T +import qualified Data.Text +import qualified Data.Text.Lazy +import Data.Word (Word8, Word16, Word32, Word64) +import Data.Int (Int16, Int32, Int64) +import Data.Map (Map) +import qualified Data.Map +import Data.Maybe (isJust, fromJust) +import qualified Data.Set +import Data.String (IsString, fromString) +import qualified Data.Vector +import qualified System.Posix.Env + +import DBus.Address +import DBus.Client () +import DBus.Client.Simple () +import DBus.Connection () +import DBus.Message () +import DBus.Message.Internal hiding (errorName) +import DBus.Types +import DBus.Types.Internal +import DBus.Wire (marshalMessage, unmarshalMessage) +import qualified DBus.Wire +import qualified DBus.Wire.Internal +import qualified DBus.Introspection + +tests :: Test +tests = testGroup "tests" + [ test_Address + , test_Signature + , test_Types + , test_Variant + , test_ObjectPath + , test_ContainerBoxes + , test_InterfaceName + , test_MemberName + , test_ErrorName + , test_BusName + , test_Wire + , test_Introspection + ] + +main :: IO () +main = Test.Framework.defaultMain [tests] + +test_Address :: Test +test_Address = testGroup "address" + [ testGroup "valid" + [ testCase "colon" $ do + addr <- requireJust (address ":") + assertEqual (addressMethod addr) "" + assertEqual (addressParameters addr) (Data.Map.fromList []) + , testCase "just-scheme" $ do + addr <- requireJust (address "a:") + assertEqual (addressMethod addr) "a" + assertEqual (addressParameters addr) (Data.Map.fromList []) + , testCase "param" $ do + addr <- requireJust (address "a:b=c") + assertEqual (addressMethod addr) "a" + assertEqual (addressParameters addr) (Data.Map.fromList [("b", "c")]) + , testCase "trailing-semicolon" $ do + addrs <- requireJust (addresses "a:;") + assertEqual (length addrs) 1 + let [addr1] = addrs + assertEqual (addressMethod addr1) "a" + assertEqual (addressParameters addr1) (Data.Map.fromList []) + , testCase "two-schemes" $ do + addrs <- requireJust (addresses "a:;b:") + assertEqual (length addrs) 2 + let [addr1, addr2] = addrs + assertEqual (addressMethod addr1) "a" + assertEqual (addressParameters addr1) (Data.Map.fromList []) + assertEqual (addressMethod addr2) "b" + assertEqual (addressParameters addr2) (Data.Map.fromList []) + , testCase "trailing-comma" $ do + addr <- requireJust (address "a:b=c,") + assertEqual (addressMethod addr) "a" + assertEqual (addressParameters addr) (Data.Map.fromList [("b", "c")]) + , testCase "encoded" $ do + addr <- requireJust (address "a:b=%678") + assertEqual (addressMethod addr) "a" + assertEqual (addressParameters addr) (Data.Map.fromList [("b", "g8")]) + ] + , testGroup "invalid" + [ testCase "empty" (assertNothing (address "")) + , testCase "no-colon" (assertNothing (address "a")) + , testCase "no-equals" (assertNothing (address "a:b")) + , testCase "no-param" (assertNothing (address "a:,")) + , testCase "no-param-value" (assertNothing (address "a:b=")) + ] + , testGroup "passthrough" + [ testCase "plain" (assertEqual (Just "a:b=c") (addressText `fmap` address "a:b=c")) + , testCase "encoded" (assertEqual (Just "a:b=Z%5B") (addressText `fmap` address "a:b=%5a%5b")) + , testCase "optionally-encoded" (assertEqual (Just "a:b=-_/\\*.") (addressText `fmap` address "a:b=-_/\\*.")) + , testCase "multiple-params" (assertEqual (Just "a:b=c,d=e") (addressText `fmap` address "a:b=c,d=e")) + ] + , testGroup "instances" + [ testCase "eq" (assertEqual (address "a:b=c") (address "a:b=c")) + , testCase "show" (assertEqual "(Address \"a:b=c\")" (showsPrec 11 (fromJust (address "a:b=c")) "")) + ] + , testGroup "well-known" + [ testCase "system" (withEnv "DBUS_SYSTEM_BUS_ADDRESS" (Just "a:b=c;d:") (do + addrs <- getSystem + assertEqual addrs (Just ["a:b=c", "d:"]))) + , testCase "default-system" (withEnv "DBUS_SYSTEM_BUS_ADDRESS" Nothing (do + addrs <- getSystem + assertEqual addrs (Just ["unix:path=/var/run/dbus/system_bus_socket"]))) + , testCase "session" (withEnv "DBUS_SESSION_BUS_ADDRESS" (Just "a:b=c;d:") (do + addrs <- getSession + assertEqual addrs (Just ["a:b=c", "d:"]))) + , testCase "starter" (withEnv "DBUS_STARTER_BUS_ADDRESS" (Just "a:b=c;d:") (do + addrs <- getStarter + assertEqual addrs (Just ["a:b=c", "d:"]))) + ] + , testGroup "properties" + [ testProperty "address-parsing" (forAll genAddressText (isJust . address)) + ] + ] + +test_Signature :: Test +test_Signature = testGroup "signature" + [ testGroup "valid" + [ testGroup "atom" + [ testCase "bool" $ do + sig <- requireJust (signature "b") + assertEqual (signatureTypes sig) [TypeBoolean] + , testCase "word8" $ do + sig <- requireJust (signature "y") + assertEqual (signatureTypes sig) [TypeWord8] + , testCase "word16" $ do + sig <- requireJust (signature "q") + assertEqual (signatureTypes sig) [TypeWord16] + , testCase "word32" $ do + sig <- requireJust (signature "u") + assertEqual (signatureTypes sig) [TypeWord32] + , testCase "word64" $ do + sig <- requireJust (signature "t") + assertEqual (signatureTypes sig) [TypeWord64] + , testCase "int16" $ do + sig <- requireJust (signature "n") + assertEqual (signatureTypes sig) [TypeInt16] + , testCase "int32" $ do + sig <- requireJust (signature "i") + assertEqual (signatureTypes sig) [TypeInt32] + , testCase "int64" $ do + sig <- requireJust (signature "x") + assertEqual (signatureTypes sig) [TypeInt64] + , testCase "double" $ do + sig <- requireJust (signature "d") + assertEqual (signatureTypes sig) [TypeDouble] + , testCase "string" $ do + sig <- requireJust (signature "s") + assertEqual (signatureTypes sig) [TypeString] + , testCase "object-path" $ do + sig <- requireJust (signature "o") + assertEqual (signatureTypes sig) [TypeObjectPath] + , testCase "signature" $ do + sig <- requireJust (signature "g") + assertEqual (signatureTypes sig) [TypeSignature] + ] + , testGroup "container" + [ testCase "variant" $ do + sig <- requireJust (signature "v") + assertEqual (signatureTypes sig) [TypeVariant] + , testCase "array" $ do + sig <- requireJust (signature "ay") + assertEqual (signatureTypes sig) [TypeArray TypeWord8] + , testCase "struct" $ do + sig <- requireJust (signature "(yy)") + assertEqual (signatureTypes sig) [TypeStructure [TypeWord8, TypeWord8]] + , testCase "dictionary" $ do + sig <- requireJust (signature "a{yy}") + assertEqual (signatureTypes sig) [TypeDictionary TypeWord8 TypeWord8] + ] + , testCase "empty" $ do + sig <- requireJust (signature "") + assertEqual (signatureTypes sig) [] + ] + , testGroup "invalid" + [ testCase "struct-code" (assertNothing (signature "r")) + , testCase "struct-empty" (assertNothing (signature "()")) + , testCase "dict-code" (assertNothing (signature "e")) + , testCase "dict-container-key" (assertNothing (signature "a{vy}")) + , testCase "unix-fd" (assertNothing (signature "h")) + ] + , testGroup "length" + [ testCase "length-254" $ do + sig <- requireJust (signature (T.replicate 254 "y")) + assertEqual (signatureTypes sig) (replicate 254 TypeWord8) + , testCase "length-255" $ do + sig <- requireJust (signature (T.replicate 255 "y")) + assertEqual (signatureTypes sig) (replicate 255 TypeWord8) + , testCase "length-256" (assertNothing (signature (T.replicate 256 "y"))) + ] + , testGroup "instances" + [ testCase "show" (assertEqual "(Signature \"y\")" (showsPrec 11 (fromJust (signature "y")) "")) + ] + , testGroup "properties" + [ testProperty "signature-parsing" (forAll genSignatureText (isJust . signature)) + , let prop types = checkSignature types == signature (T.pack (concatMap typeCode types)) in + testProperty "check-signature" (forAll (listOf1 arbitrary) prop) + ] + ] + +test_Types :: Test +test_Types = testGroup "types" + [ testGroup "instances" + [ testCase "eq" (assertEqual TypeWord8 TypeWord8) + , testGroup "show" + [ testCase "Boolean" (assertEqual "Bool" (show TypeBoolean)) + , testCase "Word8" (assertEqual "Word8" (show TypeWord8)) + , testCase "Word16" (assertEqual "Word16" (show TypeWord16)) + , testCase "Word32" (assertEqual "Word32" (show TypeWord32)) + , testCase "Word64" (assertEqual "Word64" (show TypeWord64)) + , testCase "Int16" (assertEqual "Int16" (show TypeInt16)) + , testCase "Int32" (assertEqual "Int32" (show TypeInt32)) + , testCase "Int64" (assertEqual "Int64" (show TypeInt64)) + , testCase "Double" (assertEqual "Double" (show TypeDouble)) + , testCase "String" (assertEqual "String" (show TypeString)) + , testCase "Signature" (assertEqual "Signature" (show TypeSignature)) + , testCase "ObjectPath" (assertEqual "ObjectPath" (show TypeObjectPath)) + , testCase "Variant" (assertEqual "Variant" (show TypeVariant)) + , testCase "Array" (assertEqual "[Word8]" (show (TypeArray TypeWord8))) + , testCase "Dictionary" (assertEqual "Map Word8 (Map Word8 Word8)" (show (TypeDictionary TypeWord8 (TypeDictionary TypeWord8 TypeWord8)))) + , testCase "Structure" (assertEqual "(Word8, Word16)" (show (TypeStructure [TypeWord8, TypeWord16]))) + ] + ] + ] + +test_Variant :: Test +test_Variant = testGroup "variant" + [ testGroup "instances-of-IsAtom" + [ testCase "bool" (assertAtom TypeBoolean True) + , testCase "word8" (assertAtom TypeWord8 (0 :: Word8)) + , testCase "word16" (assertAtom TypeWord16 (0 :: Word16)) + , testCase "word32" (assertAtom TypeWord32 (0 :: Word32)) + , testCase "word64" (assertAtom TypeWord64 (0 :: Word64)) + , testCase "int16" (assertAtom TypeInt16 (0 :: Int16)) + , testCase "int32" (assertAtom TypeInt32 (0 :: Int32)) + , testCase "int64" (assertAtom TypeInt64 (0 :: Int64)) + , testCase "double" (assertAtom TypeDouble (0 :: Double)) + , testCase "text" (assertAtom TypeString (Data.Text.pack "")) + , testCase "lazy-text" (assertAtom TypeString (Data.Text.Lazy.pack "")) + , testCase "string" (assertAtom TypeString ("" :: String)) + , testCase "object-path" (assertAtom TypeObjectPath (objectPath_ "/")) + , testCase "signature" (assertAtom TypeSignature (signature_ "")) + ] + , testGroup "instances-of-IsValue" + [ testCase "variant" (assertValue TypeVariant (toVariant True)) + , testCase "list" (assertValue (TypeArray TypeBoolean) [True]) + , testCase "vector" (assertValue (TypeArray TypeBoolean) (Data.Vector.fromList [True])) + , testCase "bytestring-strict" (assertValue (TypeArray TypeWord8) Data.ByteString.empty) + , testCase "bytestring-lazy" (assertValue (TypeArray TypeWord8) Data.ByteString.Lazy.empty) + , testCase "map" (assertValue (TypeDictionary TypeBoolean TypeBoolean) (Data.Map.fromList [(True, True)])) + , testCase "tuple-2" (assertValue (TypeStructure (replicate 2 TypeBoolean)) (True, True)) + , testCase "tuple-3" (assertValue (TypeStructure (replicate 3 TypeBoolean)) (True, True, True)) + , testCase "tuple-4" (assertValue (TypeStructure (replicate 4 TypeBoolean)) (True, True, True, True)) + , testCase "tuple-5" (assertValue (TypeStructure (replicate 5 TypeBoolean)) (True, True, True, True, True)) + , testCase "tuple-6" (assertValue (TypeStructure (replicate 6 TypeBoolean)) (True, True, True, True, True, True)) + , testCase "tuple-7" (assertValue (TypeStructure (replicate 7 TypeBoolean)) (True, True, True, True, True, True, True)) + , testCase "tuple-8" (assertValue (TypeStructure (replicate 8 TypeBoolean)) (True, True, True, True, True, True, True, True)) + , testCase "tuple-9" (assertValue (TypeStructure (replicate 9 TypeBoolean)) (True, True, True, True, True, True, True, True, True)) + , testCase "tuple-10" (assertValue (TypeStructure (replicate 10 TypeBoolean)) (True, True, True, True, True, True, True, True, True, True)) + , testCase "tuple-11" (assertValue (TypeStructure (replicate 11 TypeBoolean)) (True, True, True, True, True, True, True, True, True, True, True)) + , testCase "tuple-12" (assertValue (TypeStructure (replicate 12 TypeBoolean)) (True, True, True, True, True, True, True, True, True, True, True, True)) + , testCase "tuple-13" (assertValue (TypeStructure (replicate 13 TypeBoolean)) (True, True, True, True, True, True, True, True, True, True, True, True, True)) + , testCase "tuple-14" (assertValue (TypeStructure (replicate 14 TypeBoolean)) (True, True, True, True, True, True, True, True, True, True, True, True, True, True)) + , testCase "tuple-15" (assertValue (TypeStructure (replicate 15 TypeBoolean)) (True, True, True, True, True, True, True, True, True, True, True, True, True, True, True)) + ] + , testGroup "show-variant" + [ testCase "bool" (assertEqual "Variant True" (show (toVariant True))) + , testCase "word8" (assertEqual "Variant 0" (show (toVariant (0 :: Word8)))) + , testCase "word16" (assertEqual "Variant 0" (show (toVariant (0 :: Word16)))) + , testCase "word32" (assertEqual "Variant 0" (show (toVariant (0 :: Word32)))) + , testCase "word64" (assertEqual "Variant 0" (show (toVariant (0 :: Word64)))) + , testCase "int16" (assertEqual "Variant 0" (show (toVariant (0 :: Int16)))) + , testCase "int32" (assertEqual "Variant 0" (show (toVariant (0 :: Int32)))) + , testCase "int64" (assertEqual "Variant 0" (show (toVariant (0 :: Int64)))) + , testCase "double" (assertEqual "Variant 0.1" (show (toVariant (0.1 :: Double)))) + , testCase "string" (assertEqual "Variant \"\"" (show (toVariant (T.pack "")))) + , testCase "object-path" (assertEqual "Variant (ObjectPath \"/\")" (show (toVariant (objectPath_ "/")))) + , testCase "signature" (assertEqual "Variant (Signature \"\")" (show (toVariant (signature_ "")))) + , testCase "variant" (assertEqual "Variant (Variant True)" (show (toVariant (toVariant True)))) + , testCase "array" (assertEqual "Variant [True, False]" (show (toVariant [True, False]))) + , testGroup "array" + [ testCase "bytestring-strict" (assertEqual "Variant b\"\"" (show (toVariant Data.ByteString.empty))) + , testCase "bytestring-lazy" (assertEqual "Variant b\"\"" (show (toVariant Data.ByteString.Lazy.empty))) + , testCase "array-of-word8" (assertEqual "Variant b\"\"" (show (toVariant ([] :: [Word8])))) + ] + , testCase "dictionary" (assertEqual "(Variant {False: True, True: False})" (showsPrec 11 (toVariant (Data.Map.fromList [(True, False), (False, True)])) "")) + , testCase "structure" (assertEqual "(Variant (True, False))" (showsPrec 11 (toVariant (True, False)) "")) + ] + , testCase "compare-byte-storage" $ do + assertEqual (toValue (Data.Vector.fromList [0 :: Word8])) + (toValue (Data.Vector.fromList [0 :: Word8])) + assertEqual (toValue (Data.Vector.fromList [0 :: Word8])) + (toValue (Data.ByteString.pack [0])) + assertEqual (toValue (Data.Vector.fromList [0 :: Word8])) + (toValue (Data.ByteString.Lazy.pack [0])) + + assertEqual (toValue (Data.ByteString.pack [0])) + (toValue (Data.Vector.fromList [0 :: Word8])) + assertEqual (toValue (Data.ByteString.pack [0])) + (toValue (Data.ByteString.pack [0])) + assertEqual (toValue (Data.ByteString.pack [0])) + (toValue (Data.ByteString.Lazy.pack [0])) + + assertEqual (toValue (Data.ByteString.Lazy.pack [0])) + (toValue (Data.Vector.fromList [0 :: Word8])) + assertEqual (toValue (Data.ByteString.Lazy.pack [0])) + (toValue (Data.ByteString.pack [0])) + assertEqual (toValue (Data.ByteString.Lazy.pack [0])) + (toValue (Data.ByteString.Lazy.pack [0])) + ] + +test_ContainerBoxes :: Test +test_ContainerBoxes = testGroup "container-boxes" + [ testGroup "structure" + [ testCase "instance-of-Eq" (assertEqual (Structure []) (Structure [])) + , testCase "instance-of-Show" (assertEqual "(True, False)" (show (Structure [toValue True, toValue False]))) + , testCase "instance-of-IsVariant" (assertVariant (TypeStructure [TypeBoolean]) (Structure [toValue True])) + ] + , testGroup "array" + [ testCase "instance-of-Eq" $ do + assertEqual (Array TypeBoolean (Data.Vector.fromList [toValue True])) + (Array TypeBoolean (Data.Vector.fromList [toValue True])) + assertEqual (Array TypeWord8 (Data.Vector.fromList [toValue (0 :: Word8)])) + (ArrayBytes (Data.ByteString.pack [0])) + , testCase "instance-of-Show" $ do + assertEqual "[True, False]" (show (Array TypeBoolean (Data.Vector.fromList [toValue True, toValue False]))) + assertEqual "b\"\"" (show (Array TypeWord8 Data.Vector.empty)) + assertEqual "b\"\"" (show (ArrayBytes Data.ByteString.empty)) + , testCase "instance-of-IsVariant" $ do + assertVariant (TypeArray TypeWord8) (Array TypeWord8 Data.Vector.empty) + assertVariant (TypeArray TypeWord8) (ArrayBytes Data.ByteString.empty) + ] + , testGroup "dictionary" + [ testCase "instance-of-Eq" (assertEqual (Dictionary TypeWord8 TypeWord8 Data.Map.empty) + (Dictionary TypeWord8 TypeWord8 Data.Map.empty)) + , testCase "instance-of-Show" (assertEqual "{}" (show (Dictionary TypeWord8 TypeWord8 Data.Map.empty))) + , testCase "instance-of-IsVariant" (assertVariant (TypeDictionary TypeWord8 TypeWord8) (Dictionary TypeWord8 TypeWord8 Data.Map.empty)) + ] + ] + +test_ObjectPath :: Test +test_ObjectPath = testGroup "object-path" + [ testGroup "valid" + [ testCase "root" (assertJust (objectPath "/")) + , testCase "plain-1" (assertJust (objectPath "/foo")) + , testCase "plain-2" (assertJust (objectPath "/foo/bar")) + , testCase "start-with-digit" (assertJust (objectPath "/foo/0")) + , testCase "all-characters" (assertJust (objectPath "/abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789")) + ] + , testGroup "invalid" + [ testCase "empty" (assertNothing (objectPath "")) + , testCase "bad-char" (assertNothing (objectPath "/f!oo")) + , testCase "end-with-slash" (assertNothing (objectPath "/foo/")) + , testCase "empty-element" (assertNothing (objectPath "/foo//bar")) + , testCase "trailing-chars" (assertNothing (objectPath "/foo!")) + ] + ] + +test_InterfaceName :: Test +test_InterfaceName = testGroup "interface-name" + [ testCase "instance-of-IsVariant" (assertVariant TypeString (interfaceName_ "foo.bar")) + , testGroup "valid" + [ testCase "plain" (assertJust (interfaceName "foo.bar")) + , testCase "has-digit" (assertJust (interfaceName "foo.bar0")) + , testCase "all-characters" (assertJust (interfaceName "a.abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789")) + ] + , testGroup "invalid" + [ testCase "empty" (assertNothing (interfaceName "")) + , testCase "one-element" (assertNothing (interfaceName "foo")) + , testCase "start-with-digit" (assertNothing (interfaceName "foo.0bar")) + , testCase "trailing-chars" (assertNothing (interfaceName "foo.bar!")) + ] + , testGroup "length" + [ testCase "length-254" (assertJust (interfaceName ("f." `T.append` T.replicate 252 "y"))) + , testCase "length-255" (assertJust (interfaceName ("f." `T.append` T.replicate 253 "y"))) + , testCase "length-256" (assertNothing (interfaceName ("f." `T.append` T.replicate 254 "y"))) + ] + ] + +test_MemberName :: Test +test_MemberName = testGroup "member-name" + [ testCase "instance-of-IsVariant" (assertVariant TypeString (memberName_ "foo")) + , testGroup "valid" + [ testCase "plain" (assertJust (memberName "foo")) + , testCase "has-digit" (assertJust (memberName "foo0")) + , testCase "all-characters" (assertJust (memberName "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789")) + ] + , testGroup "invalid" + [ testCase "empty" (assertNothing (memberName "")) + , testCase "start-with-digit" (assertNothing (memberName "0foo")) + , testCase "trailing-chars" (assertNothing (memberName "foo!")) + ] + , testGroup "length" + [ testCase "length-254" (assertJust (memberName (T.replicate 254 "y"))) + , testCase "length-255" (assertJust (memberName (T.replicate 255 "y"))) + , testCase "length-256" (assertNothing (memberName (T.replicate 256 "y"))) + ] + ] + +test_ErrorName :: Test +test_ErrorName = testGroup "error-name" + [ testCase "instance-of-IsVariant" (assertVariant TypeString (errorName_ "foo.bar")) + , testGroup "valid" + [ testCase "plain" (assertJust (errorName "foo.bar")) + , testCase "has-digit" (assertJust (errorName "foo.bar0")) + , testCase "all-characters" (assertJust (errorName "a.abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789")) + ] + , testGroup "invalid" + [ testCase "empty" (assertNothing (errorName "")) + , testCase "one-element" (assertNothing (errorName "foo")) + , testCase "start-with-digit" (assertNothing (errorName "foo.0bar")) + , testCase "trailing-chars" (assertNothing (errorName "foo.bar!")) + ] + , testGroup "length" + [ testCase "length-254" (assertJust (errorName ("f." `T.append` T.replicate 252 "y"))) + , testCase "length-255" (assertJust (errorName ("f." `T.append` T.replicate 253 "y"))) + , testCase "length-256" (assertNothing (errorName ("f." `T.append` T.replicate 254 "y"))) + ] + ] + +test_BusName :: Test +test_BusName = testGroup "bus-name" + [ testCase "instance-of-IsVariant" (assertVariant TypeString (busName_ "foo.bar")) + , testGroup "valid" + [ testGroup "unique" + [ testCase "plain" (assertJust (busName ":foo.bar")) + , testCase "start-with-digit" (assertJust (busName ":foo.0bar")) + , testCase "all-characters" (assertJust (busName ":a.abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789")) + ] + , testGroup "well-known" + [ testCase "plain" (assertJust (busName "foo.bar")) + , testCase "has-digit" (assertJust (busName "foo.bar0")) + , testCase "all-characters" (assertJust (busName "a.abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789")) + ] + ] + , testGroup "invalid" + [ testCase "empty" (assertNothing (busName "")) + , testCase "well-known-start-with-digit" (assertNothing (busName "foo.0bar")) + , testCase "well-known-one-element" (assertNothing (busName "foo")) + , testCase "unique-one-element" (assertNothing (busName ":foo")) + , testCase "trailing-chars" (assertNothing (busName "foo.bar!")) + ] + , testGroup "length" + [ testCase "length-254" (assertJust (busName (":0." `T.append` T.replicate 251 "y"))) + , testCase "length-255" (assertJust (busName (":0." `T.append` T.replicate 252 "y"))) + , testCase "length-256" (assertNothing (busName (":0." `T.append` T.replicate 253 "y"))) + ] + ] + +test_Wire :: Test +test_Wire = testGroup "wire" + [ testProperty "value-passthrough" prop_ValuePassthrough + , testGroup "message-passthrough" + [ testProperty "method-call" (forAll (arbitrary :: Gen MethodCall) (\msg e s -> + let Right bytes = marshalMessage e s msg in + let Right received = unmarshalMessage bytes in + ReceivedMethodCall s Nothing msg == received)) + , testProperty "method-return" (forAll (arbitrary :: Gen MethodReturn) (\msg e s -> + let Right bytes = marshalMessage e s msg in + let Right received = unmarshalMessage bytes in + ReceivedMethodReturn s Nothing msg == received)) + , testProperty "error" (forAll (arbitrary :: Gen Error) (\msg e s -> + let Right bytes = marshalMessage e s msg in + let Right received = unmarshalMessage bytes in + ReceivedError s Nothing msg == received)) + , testProperty "signal" (forAll (arbitrary :: Gen Signal) (\msg e s -> + let Right bytes = marshalMessage e s msg in + let Right received = unmarshalMessage bytes in + ReceivedSignal s Nothing msg == received)) + ] + ] + +test_Introspection :: Test +test_Introspection = testGroup "introspection" + [ testProperty "xml-passthrough" (\obj -> + let (DBus.Introspection.Object path _ _) = obj in + let Just xml = DBus.Introspection.toXML obj in + DBus.Introspection.fromXML path xml == Just obj) + ] + +prop_ValuePassthrough :: Value -> DBus.Wire.Endianness -> Bool +prop_ValuePassthrough v e = unmarshaled == v where + Right bytes = marshal e v + Right unmarshaled = unmarshal e (valueType v) bytes + +marshal :: DBus.Wire.Endianness -> Value -> Either String ByteString +marshal e v = case DBus.Wire.Internal.unWire (DBus.Wire.Internal.marshal v) e (DBus.Wire.Internal.MarshalState Data.Binary.Builder.empty 0) of + DBus.Wire.Internal.WireRR _ (DBus.Wire.Internal.MarshalState builder _) -> Right (Data.ByteString.concat (Data.ByteString.Lazy.toChunks (Data.Binary.Builder.toLazyByteString builder))) + DBus.Wire.Internal.WireRL err -> Left err + +unmarshal :: DBus.Wire.Endianness -> Type -> ByteString -> Either String Value +unmarshal e t bytes = case DBus.Wire.Internal.unWire (DBus.Wire.Internal.unmarshal t) e (DBus.Wire.Internal.UnmarshalState bytes 0) of + DBus.Wire.Internal.WireRR v _ -> Right v + DBus.Wire.Internal.WireRL err -> Left err + +genAddressText :: Gen Text +genAddressText = gen where + methodChars = filter (`notElem` ":;") ['!'..'~'] + keyChars = filter (`notElem` "=;,") ['!'..'~'] + optionallyEncoded = map (:[]) (concat + [ ['0'..'9'] + , ['a'..'z'] + , ['A'..'Z'] + , "-_/\\*." + ]) + + param = do + key <- listOf1 (elements keyChars) + value <- listOf1 (oneof + [ elements optionallyEncoded + , do + c1 <- genHex + c2 <- genHex + return ['%', c1, c2] + ]) + return (key ++ "=" ++ concat value) + + gen = do + method <- listOf (elements methodChars) + params <- listOf param + return (T.pack (method ++ ":" ++ (intercalate "," params))) + +genHex :: Gen Char +genHex = elements (['0'..'9'] ++ ['a'..'f'] ++ ['A'..'F']) + +genSignatureText :: Gen Text +genSignatureText = gen where + anyType = oneof [atom, container] + atom = elements ["b", "y", "q", "u", "t", "n", "i", "x", "d", "s", "o", "g"] + container = oneof + [ return "v" + , do + t <- anyType + return ('a' : t) + , do + kt <- atom + vt <- anyType + return (concat ["a{", kt, vt, "}"]) + , do + ts <- listOf1 (halfSized anyType) + return (concat (["("] ++ ts ++ [")"])) + ] + gen = do + chars <- fmap concat (listOf anyType) + if length chars > 255 + then halfSized gen + else return (T.pack chars) + +halfSized :: Gen a -> Gen a +halfSized gen = sized (\n -> if n > 0 + then resize (div n 2) gen + else gen) + +requireJust :: Maybe a -> IO a +requireJust (Just a) = return a +requireJust Nothing = do + assertFailure "expected: (Just _)\n but got: Nothing" -- throws + error "requireJust: assertFailure didn't fail" + +assertJust :: Maybe a -> IO () +assertJust (Just _) = return () +assertJust Nothing = assertFailure "expected: (Just _)\n but got: Nothing" + +assertNothing :: Maybe a -> Assertion +assertNothing Nothing = return () +assertNothing (Just _) = assertFailure "expected: (Just _)\n but got: Nothing" + +assertEqual :: (Show a, Eq a) => a -> a -> Assertion +assertEqual = Test.HUnit.assertEqual "" + +assertAtom :: (Eq a, Show a, IsAtom a) => Type -> a -> Assertion +assertAtom t a = do + assertEqual t (atomType (toAtom a)) + assertEqual (fromAtom (toAtom a)) (Just a) + assertEqual (toAtom a) (toAtom a) + assertValue t a + +assertValue :: (Eq a, Show a, IsValue a) => Type -> a -> Assertion +assertValue t a = do + assertEqual t (DBus.Types.typeOf a) + assertEqual t (DBus.Types.Internal.typeOf a) + assertEqual t (valueType (toValue a)) + assertEqual (fromValue (toValue a)) (Just a) + assertEqual (toValue a) (toValue a) + assertVariant t a + +assertVariant :: (Eq a, Show a, IsVariant a) => Type -> a -> Assertion +assertVariant t a = do + assertEqual t (variantType (toVariant a)) + assertEqual (fromVariant (toVariant a)) (Just a) + assertEqual (toVariant a) (toVariant a) + +withEnv :: String -> Maybe String -> IO a -> IO a +withEnv name value io = do + let set val = case val of + Just x -> System.Posix.Env.setEnv name x True + Nothing -> System.Posix.Env.unsetEnv name + old <- System.Posix.Env.getEnv name + Control.Exception.bracket_ (set value) (set old) io + +instance IsString Address where + fromString s = case address (T.pack s) of + Just addr -> addr + Nothing -> error ("Invalid address: " ++ show s) + +instance Arbitrary Type where + arbitrary = oneof [atom, container] where + atom = elements + [ TypeBoolean + , TypeWord8 + , TypeWord16 + , TypeWord32 + , TypeWord64 + , TypeInt16 + , TypeInt32 + , TypeInt64 + , TypeDouble + , TypeString + , TypeObjectPath + , TypeSignature + ] + container = oneof + [ return TypeVariant + , liftM TypeArray arbitrary + , liftM2 TypeDictionary atom arbitrary + , liftM TypeStructure (listOf1 (halfSized arbitrary)) + ] + +instance Arbitrary Atom where + arbitrary = oneof + [ liftM AtomWord8 arbitrary + , liftM AtomWord16 arbitrary + , liftM AtomWord32 arbitrary + , liftM AtomWord64 arbitrary + , liftM AtomInt16 arbitrary + , liftM AtomInt32 arbitrary + , liftM AtomInt64 arbitrary + , liftM AtomBool arbitrary + , liftM AtomDouble arbitrary + , liftM AtomText arbitrary + , liftM AtomObjectPath arbitrary + , liftM AtomSignature arbitrary + ] + +instance Arbitrary Value where + arbitrary = oneof + [ liftM ValueAtom arbitrary + , liftM ValueBytes arbitrary + + -- TODO: proper arbitrary ValueVector + , elements + [ toValue (Data.Vector.fromList ([] :: [Word8])) + , toValue (Data.Vector.fromList ([0, 1, 2, 3, 4, 5] :: [Word8])) + , toValue (Data.Vector.fromList ([0, 1, 2, 3, 4, 5] :: [Word16])) + , toValue (Data.Vector.fromList ([0, 1, 2, 3, 4, 5] :: [Word32])) + , toValue (Data.Vector.fromList ([0, 1, 2, 3, 4, 5] :: [Word64])) + , toValue (Data.Vector.fromList (["foo", "bar", "baz"] :: [Text])) + ] + + -- TODO: proper arbitrary ValueMap + , elements + [ toValue (Data.Map.fromList [] :: Map Text Text) + , toValue (Data.Map.fromList [("foo", "bar"), ("baz", "qux")] :: Map Text Text) + ] + + , liftM ValueStructure (listOf1 (halfSized arbitrary)) + , liftM ValueVariant arbitrary + ] + +instance Arbitrary Variant where + arbitrary = do + val <- arbitrary + case checkSignature [valueType val] of + Just _ -> return (Variant val) + Nothing -> halfSized arbitrary + +instance Arbitrary Data.Text.Text where + arbitrary = liftM Data.Text.pack genUnicode + +genUnicode :: Gen [Char] +genUnicode = string where + string = sized $ \n -> do + k <- choose (0,n) + sequence [ char | _ <- [1..k] ] + + excluding :: [a -> Bool] -> Gen a -> Gen a + excluding bad gen = loop where + loop = do + x <- gen + if or (map ($ x) bad) + then loop + else return x + + reserved = [lowSurrogate, highSurrogate, noncharacter] + lowSurrogate c = c >= 0xDC00 && c <= 0xDFFF + highSurrogate c = c >= 0xD800 && c <= 0xDBFF + noncharacter c = masked == 0xFFFE || masked == 0xFFFF where + masked = c .&. 0xFFFF + + ascii = choose (0x20, 0x7F) + plane0 = choose (0xF0, 0xFFFF) + plane1 = oneof [ choose (0x10000, 0x10FFF) + , choose (0x11000, 0x11FFF) + , choose (0x12000, 0x12FFF) + , choose (0x13000, 0x13FFF) + , choose (0x1D000, 0x1DFFF) + , choose (0x1F000, 0x1FFFF) + ] + plane2 = oneof [ choose (0x20000, 0x20FFF) + , choose (0x21000, 0x21FFF) + , choose (0x22000, 0x22FFF) + , choose (0x23000, 0x23FFF) + , choose (0x24000, 0x24FFF) + , choose (0x25000, 0x25FFF) + , choose (0x26000, 0x26FFF) + , choose (0x27000, 0x27FFF) + , choose (0x28000, 0x28FFF) + , choose (0x29000, 0x29FFF) + , choose (0x2A000, 0x2AFFF) + , choose (0x2B000, 0x2BFFF) + , choose (0x2F000, 0x2FFFF) + ] + plane14 = choose (0xE0000, 0xE0FFF) + planes = [ascii, plane0, plane1, plane2, plane14] + + char = chr `fmap` excluding reserved (oneof planes) + +instance Arbitrary Data.ByteString.ByteString where + arbitrary = liftM Data.ByteString.pack arbitrary + +instance Arbitrary Data.ByteString.Lazy.ByteString where + arbitrary = liftM Data.ByteString.Lazy.fromChunks arbitrary + +instance Arbitrary ObjectPath where + -- TODO: proper arbitrary generation + arbitrary = elements + [ objectPath_ "/" + , objectPath_ "/foo" + , objectPath_ "/foo/bar" + ] + +instance Arbitrary InterfaceName where + -- TODO: proper arbitrary generation + arbitrary = elements + [ interfaceName_ "foo.bar" + , interfaceName_ "foo.bar0" + ] + +instance Arbitrary MemberName where + -- TODO: proper arbitrary generation + arbitrary = elements + [ memberName_ "foo" + , memberName_ "foo0" + ] + +instance Arbitrary ErrorName where + -- TODO: proper arbitrary generation + arbitrary = elements + [ errorName_ "foo.bar" + , errorName_ "foo.bar0" + ] + +instance Arbitrary BusName where + -- TODO: proper arbitrary generation + arbitrary = elements + [ busName_ "foo.bar" + , busName_ ":foo.bar" + , busName_ ":foo.bar" + ] + +instance (Arbitrary a, Ord a) => Arbitrary (Data.Set.Set a) where + arbitrary = liftM Data.Set.fromList arbitrary + +instance Arbitrary Signature where + arbitrary = liftM signature_ genSignatureText + +instance Arbitrary DBus.Wire.Endianness where + arbitrary = elements [DBus.Wire.BigEndian, DBus.Wire.LittleEndian] + +instance Arbitrary Flag where + arbitrary = elements [NoReplyExpected, NoAutoStart] + +instance Arbitrary Serial where + arbitrary = liftM Serial arbitrary + +instance Arbitrary MethodCall where + arbitrary = MethodCall + <$> arbitrary + <*> arbitrary + <*> arbitrary + <*> arbitrary + <*> arbitrary + <*> genMessageBody + +instance Arbitrary MethodReturn where + arbitrary = MethodReturn + <$> arbitrary + <*> arbitrary + <*> genMessageBody + +instance Arbitrary Error where + arbitrary = Error + <$> arbitrary + <*> arbitrary + <*> arbitrary + <*> genMessageBody + +instance Arbitrary Signal where + arbitrary = Signal + <$> arbitrary + <*> arbitrary + <*> arbitrary + <*> arbitrary + <*> genMessageBody + +genMessageBody :: Gen [Variant] +genMessageBody = do + vars <- arbitrary + case checkSignature (map variantType vars) of + Just _ -> return vars + Nothing -> halfSized genMessageBody + +instance Arbitrary DBus.Introspection.Object where + arbitrary = arbitrary >>= subObject + +subObject :: ObjectPath -> Gen DBus.Introspection.Object +subObject parentPath = sized $ \n -> resize (min n 4) $ do + let nonRoot = do + x <- arbitrary + case objectPathText x of + "/" -> nonRoot + x' -> return x' + + thisPath <- nonRoot + let path' = case objectPathText parentPath of + "/" -> thisPath + x -> Data.Text.append x thisPath + let path = objectPath_ path' + ifaces <- arbitrary + children <- halfSized (listOf (subObject path)) + return (DBus.Introspection.Object path ifaces children) + +instance Arbitrary DBus.Introspection.Interface where + arbitrary = DBus.Introspection.Interface + <$> arbitrary + <*> arbitrary + <*> arbitrary + <*> arbitrary + +instance Arbitrary DBus.Introspection.Method where + arbitrary = DBus.Introspection.Method + <$> arbitrary + <*> arbitrary + <*> arbitrary + +instance Arbitrary DBus.Introspection.Signal where + arbitrary = DBus.Introspection.Signal + <$> arbitrary + <*> arbitrary + +instance Arbitrary DBus.Introspection.Parameter where + arbitrary = DBus.Introspection.Parameter + <$> arbitrary + <*> singleType + +instance Arbitrary DBus.Introspection.Property where + arbitrary = DBus.Introspection.Property + <$> arbitrary + <*> arbitrary + <*> elements + [ [] + , [ DBus.Introspection.Read ] + , [ DBus.Introspection.Write ] + , [ DBus.Introspection.Read + , DBus.Introspection.Write ] + ] + +singleType :: Gen Signature +singleType = do + t <- arbitrary + case checkSignature [t] of + Just s -> return s + Nothing -> halfSized singleType diff --git a/tests/dbus-core-tests.cabal b/tests/dbus-core-tests.cabal new file mode 100644 --- /dev/null +++ b/tests/dbus-core-tests.cabal @@ -0,0 +1,35 @@ +name: dbus-core-tests +version: 0 +build-type: Simple +cabal-version: >= 1.6 + +flag coverage + default: False + manual: True + +executable dbus-core_tests + main-is: Tests.hs + ghc-options: -Wall -fno-warn-orphans + hs-source-dirs: ../hs,. + + if flag(coverage) + ghc-options: -fhpc + + build-depends: + base > 3 && < 5 + , binary >= 0.4 && < 0.6 + , bytestring >= 0.9 && < 0.10 + , containers >= 0.1 && < 0.5 + , data-binary-ieee754 >= 0.3 && < 0.5 + , libxml-sax >= 0.7 && < 0.8 + , network >= 2.2 && < 2.4 + , parsec >= 2.0 && < 3.2 + , text >= 0.8 && < 0.12 + , unix >= 2.2 && < 2.5 + , vector >= 0.7 && < 0.8 + , xml-types >= 0.3 && < 0.4 + , QuickCheck == 2.4.* + , HUnit == 1.2.* + , test-framework >= 0.2 && < 0.4 + , test-framework-quickcheck2 == 0.2.9 + , test-framework-hunit == 0.2.6