diff --git a/DBus/Bus.lhs b/DBus/Bus.lhs new file mode 100644 --- /dev/null +++ b/DBus/Bus.lhs @@ -0,0 +1,102 @@ +% 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 . + +\ignore{ +\begin{code} +{-# LANGUAGE DeriveDataTypeable #-} +module DBus.Bus + ( getSystemBus + , getSessionBus + , register + ) where + +import Data.Typeable (Typeable, cast) +import Data.Maybe (fromJust) +import qualified Data.Set as Set +import System.Environment (getEnv) +import qualified Control.Exception as E +import qualified DBus.Bus.Address as A +import qualified DBus.Bus.Connection as C +import qualified DBus.Message as M +import qualified DBus.Types as T +\end{code} +} + +\begin{code} +getBus :: A.Address -> IO (C.Connection, T.BusName) +getBus addr = do + c <- C.connect . C.findTransport $ addr + name <- register c + return (c, name) +\end{code} + +\begin{code} +findBusName :: M.ReceivedMessage -> Maybe T.BusName +findBusName (M.ReceivedMethodReturn _ _ msg) = name where + name = case M.methodReturnBody msg of + [x] -> T.fromVariant x + _ -> Nothing +findBusName _ = Nothing +\end{code} + +\begin{code} +register :: C.Connection -> IO T.BusName +register c = do + C.send c return hello + reply <- C.recv c >>= \x -> case x of + Right x' -> return x' + Left err -> E.throwIO . E.AssertionFailed $ err + case findBusName reply of + Just x -> return x + Nothing -> E.throwIO . E.AssertionFailed $ "Received inappropriate reply to Hello()." +\end{code} + +\section{Default connections} + +\begin{code} +getSystemBus :: IO (C.Connection, T.BusName) +getSystemBus = getBus addr where + systemBusPath = "unix:path=/var/run/dbus/system_bus_socket" + Just [addr] = A.parseAddresses systemBusPath +\end{code} + +\begin{code} +getSessionBus :: IO (C.Connection, T.BusName) +getSessionBus = do + env <- getEnv "DBUS_SESSION_BUS_ADDRESS" + case A.parseAddresses env of + Just (addr:_) -> getBus addr + _ -> E.throwIO $ BadAddress env +\end{code} + +\begin{code} +data BadAddress = BadAddress String + deriving (Show, Typeable) + +instance E.Exception BadAddress where + toException = E.SomeException + fromException = cast +\end{code} + +\begin{code} +hello :: M.MethodCall +hello = M.MethodCall + (fromJust . T.mkObjectPath $ "/org/freedesktop/DBus") + (fromJust . T.mkMemberName $ "Hello") + (T.mkInterfaceName "org.freedesktop.DBus") + (T.mkBusName "org.freedesktop.DBus") + Set.empty + [] +\end{code} diff --git a/DBus/Bus/Address.lhs b/DBus/Bus/Address.lhs new file mode 100644 --- /dev/null +++ b/DBus/Bus/Address.lhs @@ -0,0 +1,148 @@ +% 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 . + +\ignore{ +\begin{code} +module DBus.Bus.Address + ( Address + , addressMethod + , addressParameters + , strAddress + , parseAddresses + ) where + +import Data.Char (ord, digitToInt, chr) +import qualified Data.Map as M +import Data.List (intercalate) +import Text.Printf (printf) +import qualified Text.Parsec as P +import Text.Parsec ((<|>)) +\end{code} +} + +\section{Addresses} + +\subsection{Formatting} + +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. + +\begin{code} +optionallyEncoded :: String +optionallyEncoded = ['0'..'9'] ++ ['a'..'z'] ++ ['A'..'Z'] ++ "-_/\\*." +\end{code} + +The address simply stores its method and parameter map, with a custom +{\tt Show} instance to provide easier debugging. + +\begin{code} +data Address = Address + { addressMethod :: String + , addressParameters :: M.Map String String + } deriving (Eq) + +instance Show Address where + showsPrec d x = showParen (d> 10) $ + showString' ["Address \"", strAddress x, "\""] where + showString' = foldr (.) id . map showString +\end{code} + +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. + +\begin{code} +parseAddresses :: String -> Maybe [Address] +parseAddresses s = eitherToMaybe $ P.parse parser "" s where + address = do + method <- P.many (P.noneOf ":;") + P.char ':' + params <- P.sepEndBy param (P.char ',') + return $ Address method (M.fromList params) + + param = do + key <- P.many1 (P.noneOf "=;,") + P.char '=' + value <- P.many1 (encodedValue <|> unencodedValue) + return (key, value) + + parser = do + as <- P.sepEndBy1 address (P.char ';') + P.eof + return as + + unencodedValue = P.oneOf optionallyEncoded + encodedValue = do + P.char '%' + hex <- P.count 2 P.hexDigit + return . chr . hexToInt $ hex +\end{code} + +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. + +\begin{code} +strAddress :: Address -> String +strAddress (Address t ps) = t ++ ":" ++ ps' where + ps' = intercalate "," $ do + (k, v) <- M.toList ps + [k ++ "=" ++ (v >>= encode)] + encode c | elem c optionallyEncoded = [c] + | otherwise = printf "%%%02X" (ord c) +\end{code} + +Finally, a couple parser utility functions. + +\begin{code} +hexToInt :: String -> Int +hexToInt = foldl ((+) . (16 *)) 0 . map digitToInt +\end{code} + +\begin{code} +eitherToMaybe :: Either a b -> Maybe b +eitherToMaybe (Left _) = Nothing +eitherToMaybe (Right x) = Just x +\end{code} diff --git a/DBus/Bus/Connection.lhs b/DBus/Bus/Connection.lhs new file mode 100644 --- /dev/null +++ b/DBus/Bus/Connection.lhs @@ -0,0 +1,199 @@ +% 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 . + +\ignore{ +\begin{code} +{-# LANGUAGE DeriveDataTypeable #-} +module DBus.Bus.Connection + ( Transport (..) + , findTransport + , Connection + , connect + , send + , recv + ) where + +import qualified Control.Concurrent as C +import qualified Control.Exception as E +import Data.Word (Word32) +import qualified Data.ByteString.Lazy as L +import Data.ByteString.Lazy.UTF8 (toString, fromString) +import qualified Data.Map as Map +import Data.Typeable (Typeable, cast) +import qualified Network as N +import qualified System.IO as I +import qualified DBus.Types as T +import DBus.Message (Message, ReceivedMessage, marshal, unmarshal) +import qualified DBus.Bus.Address as A +import DBus.Protocol.Authentication (authenticate) +\end{code} +} + +\section{Transports} + +A transport is anything which can be used to construct a (send, recv) +computation pair. + +\begin{code} +data Transport = Transport + { transportAddress :: A.Address + , transportConnect :: IO + ( L.ByteString -> IO () + , Word32 -> IO L.ByteString + ) + } +\end{code} + +\begin{code} +instance Show Transport where + showsPrec d (Transport a _) = showParen (d > 10) $ + showString' [""] where + showString' = foldr (.) id . map showString +\end{code} + +\begin{code} +findTransport :: A.Address -> Transport +findTransport a = transport' (A.addressMethod a) a where + transport' "unix" = unix + transport' _ = unknownTransport +\end{code} + +\subsection{UNIX} + +known parameters: + * path + * abstract + * tmpdir (only for listening) + +If an invalid set of parameters is provided, the transport will still +be built, but will not be able to connect. + +\begin{code} +data BadParameters = BadParameters String + deriving (Show, Typeable) + +instance E.Exception BadParameters where + toException = E.SomeException + fromException = cast + +unix :: A.Address -> Transport +unix a = handleTransport a connect' where + params = A.addressParameters a + path = Map.lookup "path" params + abstract = Map.lookup "abstract" params + path' = case (path, abstract) of + (Just _, Just _) -> E.throwIO (BadParameters "got path and abstract") + (Nothing, Nothing) -> E.throwIO (BadParameters "need path or abstract") + (Just x, Nothing) -> return x + (Nothing, Just x) -> return $ '\x00':x + connect' = N.connectTo "localhost" =<< fmap N.UnixSocket path' +\end{code} + +\subsection{TCP} + +known parameters: + * host (optional, default "localhost") + * port + * family (optional, choices are "ipv4" or "ipv6" + +TCP support is TODO + +\begin{code}% +tcp :: A.Address -> Transport +tcp a@(A.Address _ params) = handleTransport a connect' where + host = lookup "host" params + port = parsePort =<< lookup "post" params + family = parseFamily =<< lookup "family" params + connect' = do + -- check host + -- check port + -- check family + -- return handle +parsePort :: String -> Maybe PortNumber + +parseFamily :: String -> Maybe Family +\end{code}% + +\subsection{Generic handle-based transport} + +both UNIX and TCP use generic handle-based transport: + +\begin{code} +handleTransport :: A.Address -> IO I.Handle -> Transport +handleTransport addr io = Transport addr $ do + h <- io + I.hSetBuffering h I.NoBuffering + I.hSetBinaryMode h True + let get' = L.hGet h .fromIntegral + return (L.hPut h, get') +\end{code} + +\subsection{Unknown transports} + +\begin{code} +unknownTransport :: A.Address -> Transport +unknownTransport a = Transport a $ do + let m = A.addressMethod a + let err = "Unknown method " ++ show m ++ + " in address " ++ (show . A.strAddress) a ++ "." + + E.throwIO . E.AssertionFailed $ err +\end{code} + +\section{Connections} + +\begin{code} +data Connection = Connection Transport (C.MVar T.Serial) + (L.ByteString -> IO ()) + (Word32 -> IO L.ByteString) + +instance Show Connection where + showsPrec d (Connection (Transport a _) _ _ _) = showParen (d > 10) $ + showString' [""] where + showString' = foldr (.) id . map showString +\end{code} + +\begin{code} +connect :: Transport -> IO Connection +connect t@(Transport _ connect') = do + (put, get) <- connect' + serialMVar <- C.newMVar T.firstSerial + let c = Connection t serialMVar put get + let put' = put . fromString + let get' = fmap toString . get + authenticate put' get' + return c +\end{code} + +\begin{code} +send :: Message a => Connection -> (T.Serial -> IO b) -> a -> IO b +send (Connection _ mvar put _) io msg = withSerial mvar $ \serial -> do + x <- io serial + put . marshal T.LittleEndian serial $ msg + return x + +withSerial :: C.MVar T.Serial -> (T.Serial -> IO a) -> IO a +withSerial m io = E.block $ do + s <- C.takeMVar m + let s' = T.nextSerial s + x <- E.unblock (io s) `E.onException` C.putMVar m s' + C.putMVar m s' + return x +\end{code} + +\begin{code} +recv :: Connection -> IO (Either String ReceivedMessage) +recv (Connection _ _ _ get) = unmarshal get +\end{code} diff --git a/DBus/Message.lhs b/DBus/Message.lhs new file mode 100644 --- /dev/null +++ b/DBus/Message.lhs @@ -0,0 +1,527 @@ +% 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 . + +\ignore{ +\begin{code} +module DBus.Message + ( Message (..) + , Flag (..) + , HeaderField (..) + , MethodCall (..) + , MethodReturn (..) + , Error (..) + , Signal (..) + , ReceivedMessage (..) + , receivedSerial + , receivedSender + , marshal + , unmarshal + ) where + +import Control.Monad (unless) +import qualified Control.Monad.Error as E +import Data.Bits ((.|.), (.&.)) +import Data.Word (Word8, Word32) +import qualified Data.ByteString.Lazy as L +import Data.Maybe (fromJust, fromMaybe, listToMaybe, mapMaybe) +import qualified Data.Set as S + +import qualified DBus.Protocol.Marshal as M +import qualified DBus.Protocol.Unmarshal as U +import DBus.Protocol.Padding (padding) +import qualified DBus.Types as T +\end{code} +} + +\clearpage +\section{Messages} + +A message represents a single message, with a header and body. Some parts +of the header, such as the serial, endianness, and body length, are not +included in the message --- instead, they are generated when a message is +marshalled. + +\begin{code} +class Message a where + messageTypeCode :: a -> Word8 + messageHeaderFields :: a -> [HeaderField] + messageFlags :: a -> S.Set Flag + messageBody :: a -> [T.Variant] +\end{code} + +All messages are assumed to be using protocol version 1. + +\begin{code} +protocolVersion :: Word8 +protocolVersion = 1 +\end{code} + +\subsection{Flags} + +Flags are represented as the integral value of each flag OR'd into a single +byte. + +The instance of {\tt Ord} only exists for storing flags in a set. Flags have +no inherent ordering. + +\begin{code} +data Flag = NoReplyExpected + | NoAutoStart + deriving (Show, Eq, Ord) +\end{code} + +\begin{code} +encodeFlags :: [Flag] -> Word8 +encodeFlags flags = foldr (.|.) 0 $ map flagValue flags where + flagValue NoReplyExpected = 0x1 + flagValue NoAutoStart = 0x2 +\end{code} + +\begin{code} +decodeFlags :: Word8 -> [Flag] +decodeFlags flagsByte = flags where + flagSet = [(0x1, NoReplyExpected), (0x2, NoAutoStart)] + flags = flagSet >>= \(x, y) -> [y | flagsByte .&. x > 0] +\end{code} + +\subsection{Header fields} + +\begin{code} +data HeaderField = Path T.ObjectPath + | Interface T.InterfaceName + | Member T.MemberName + | ErrorName T.ErrorName + | ReplySerial T.Serial + | Destination T.BusName + | Sender T.BusName + | Signature T.Signature + deriving (Show, Eq) +\end{code} + +\begin{code} +header' :: T.Variable a => Word8 -> a -> T.Variant +header' code x = T.toVariant $ T.Structure + [ T.toVariant code + , T.toVariant $ T.toVariant x + ] + +unheader :: T.Variant -> Maybe (Word8, T.Variant) +unheader structV = do + struct <- T.fromVariant structV + (c, v) <- case struct of + T.Structure [x, y] -> return (x, y) + _ -> Nothing + c' <- T.fromVariant c + v' <- T.fromVariant v + return (c', v') + +instance T.Variable HeaderField where + defaultSignature _ = fromJust . T.mkSignature $ "(yv)" + + toVariant (Path x) = header' 1 x + toVariant (Interface x) = header' 2 x + toVariant (Member x) = header' 3 x + toVariant (ErrorName x) = header' 4 x + toVariant (ReplySerial x) = header' 5 x + toVariant (Destination x) = header' 6 x + toVariant (Sender x) = header' 7 x + toVariant (Signature x) = header' 8 x + + fromVariant v = unheader v >>= \v' -> case v' of + (1, x) -> fmap Path $ T.fromVariant x + (2, x) -> fmap Interface $ T.fromVariant x + (3, x) -> fmap Member $ T.fromVariant x + (4, x) -> fmap ErrorName $ T.fromVariant x + (5, x) -> fmap ReplySerial $ T.fromVariant x + (6, x) -> fmap Destination $ T.fromVariant x + (7, x) -> fmap Sender $ T.fromVariant x + (8, x) -> fmap Signature $ T.fromVariant x + _ -> Nothing +\end{code} + +\subsection{Message types} + +\subsubsection{Method calls} + +\begin{code} +data MethodCall = MethodCall + { methodCallPath :: T.ObjectPath + , methodCallMember :: T.MemberName + , methodCallInterface :: Maybe T.InterfaceName + , methodCallDestination :: Maybe T.BusName + , methodCallFlags :: S.Set Flag + , methodCallBody :: [T.Variant] + } + deriving (Show, Eq) + +instance Message MethodCall where + messageTypeCode _ = 1 + messageFlags = methodCallFlags + messageBody = methodCallBody + messageHeaderFields m = concat + [ [ Path $ methodCallPath m + , Member $ methodCallMember m + ] + , maybe' Interface . methodCallInterface $ m + , maybe' Destination . methodCallDestination $ m + ] +\end{code} + +\subsubsection{Method returns} + +\begin{code} +data MethodReturn = MethodReturn + { methodReturnSerial :: T.Serial + , methodReturnDestination :: Maybe T.BusName + , methodReturnFlags :: S.Set Flag + , methodReturnBody :: [T.Variant] + } + deriving (Show, Eq) + +instance Message MethodReturn where + messageTypeCode _ = 2 + messageFlags = methodReturnFlags + messageBody = methodReturnBody + messageHeaderFields m = concat + [ [ ReplySerial $ methodReturnSerial m + ] + , maybe' Destination . methodReturnDestination $ m + ] +\end{code} + +\subsubsection{Errors} + +\begin{code} +data Error = Error + { errorName :: T.ErrorName + , errorSerial :: T.Serial + , errorDestination :: Maybe T.BusName + , errorFlags :: S.Set Flag + , errorBody :: [T.Variant] + } + deriving (Show, Eq) + +instance Message Error where + messageTypeCode _ = 3 + messageFlags = errorFlags + messageBody = errorBody + messageHeaderFields m = concat + [ [ ErrorName $ errorName m + , ReplySerial $ errorSerial m + ] + , maybe' Destination . errorDestination $ m + ] +\end{code} + +\subsubsection{Signals} + +\begin{code} +data Signal = Signal + { signalPath :: T.ObjectPath + , signalMember :: T.MemberName + , signalInterface :: T.InterfaceName + , signalFlags :: S.Set Flag + , signalBody :: [T.Variant] + } + deriving (Show, Eq) + +instance Message Signal where + messageTypeCode _ = 4 + messageFlags = signalFlags + messageBody = signalBody + messageHeaderFields m = + [ Path $ signalPath m + , Member $ signalMember m + , Interface $ signalInterface m + ] +\end{code} + +\begin{code} +maybe' :: (a -> b) -> Maybe a -> [b] +maybe' f = maybe [] (\x' -> [f x']) +\end{code} + +\subsection{Message headers} + +\begin{code} +data MessageHeader = MessageHeader + { headerEndianness :: T.Endianness + , headerTypeCode :: Word8 + , headerFlags :: S.Set Flag + , headerProtocol :: Word8 + , headerBodySize :: Word32 + , headerSerial :: T.Serial + , headerFields :: [HeaderField] + } deriving (Show, Eq) +\end{code} + +\begin{code} +buildHeader :: Message a => T.Endianness -> T.Serial -> a -> Word32 + -> MessageHeader +buildHeader endianness serial m bodyLen = header where + ts = concatMap (T.signatureTypes . T.variantSignature) $ messageBody m + bodySig = fromJust . T.mkSignature $ concatMap T.typeString ts + fields = Signature bodySig : messageHeaderFields m + header = MessageHeader + endianness + (messageTypeCode m) + (messageFlags m) + protocolVersion + bodyLen + serial + fields +\end{code} + +\subsection{Marshaling} + +{\tt marshal} converts a message into a byte string, suitable for sending +over the bus. + +\begin{code} +marshal :: Message a => T.Endianness -> T.Serial -> a -> L.ByteString +marshal e s m = L.append headerBytes bodyBytes where + bodyBytes = M.marshal e $ messageBody m + bodyLength = fromIntegral . L.length $ bodyBytes + header = marshalHeader (buildHeader e s m bodyLength) + headerBytes = M.marshal e $ header ++ [T.toVariant (T.Structure [])] +\end{code} + +Build the header struct for a message. Endianness, the serial, and body +length are provided. + +\begin{code} +marshalHeader :: MessageHeader -> [T.Variant] +marshalHeader h = map ($ h) + [ T.toVariant . headerEndianness + , T.toVariant . headerTypeCode + , T.toVariant . encodeFlags . S.toList . headerFlags + , T.toVariant . headerProtocol + , T.toVariant . headerBodySize + , T.toVariant . headerSerial + , T.toVariant . fromJust . T.toArray . headerFields + ] +\end{code} + +\subsection{Unmarshaling} + +\subsubsection{Received messages} + +Any messages parsed from the connection are stored in a +{\tt ReceivedMessage} value, so clients can know which type of message +was received, where it was sent from, and its serial. + +Unknown message types are parsed, but only to get the serial and bus name +(which might be useful for returning an {\tt Error}). Clients should ignore +unknown messages. + +\begin{code} +data ReceivedMessage = + ReceivedMethodCall T.Serial (Maybe T.BusName) MethodCall + | ReceivedMethodReturn T.Serial (Maybe T.BusName) MethodReturn + | ReceivedError T.Serial (Maybe T.BusName) Error + | ReceivedSignal T.Serial (Maybe T.BusName) Signal + | ReceivedUnknown T.Serial (Maybe T.BusName) + deriving (Show, Eq) + +receivedSerial :: ReceivedMessage -> T.Serial +receivedSerial (ReceivedMethodCall s _ _) = s +receivedSerial (ReceivedMethodReturn s _ _) = s +receivedSerial (ReceivedError s _ _) = s +receivedSerial (ReceivedSignal s _ _) = s +receivedSerial (ReceivedUnknown s _) = s + +receivedSender :: ReceivedMessage -> Maybe T.BusName +receivedSender (ReceivedMethodCall _ s _) = s +receivedSender (ReceivedMethodReturn _ s _) = s +receivedSender (ReceivedError _ s _) = s +receivedSender (ReceivedSignal _ s _) = s +receivedSender (ReceivedUnknown _ s) = s +\end{code} + +Unmarshaling is a three-step process: retrieve the raw bytes, parse the +header, then parse the body. With the header and body, it is possible to +construct a {\tt ReceivedMessage} of the proper type and attributes. + +\begin{code} +unmarshal :: Monad m => (Word32 -> m L.ByteString) + -> m (Either String ReceivedMessage) +unmarshal getBytes = E.runErrorT $ do + (endianness, headerBytes, bodyBytes) <- getRaw $ E.lift . getBytes + header <- parseHeader endianness headerBytes + let signature = findBodySignature . headerFields $ header + body <- U.unmarshal endianness signature bodyBytes + + mkReceived + (headerTypeCode header) + (headerSerial header) + (headerFields header) + (headerFlags header) + body +\end{code} + +First, some minimal parsing is required to retrieve the full byte buffer +from the input. This depends on the fixed structure of the message header to +pull in every required byte without fully parsing the header fields. + +\begin{code} +type RawMessage = (T.Endianness, L.ByteString, L.ByteString) +getRaw :: (E.Error e, E.MonadError e m) => + (Word32 -> m L.ByteString) -> m RawMessage +getRaw get = do + let fixed'Sig = fromJust . T.mkSignature $ "yyyy" + let fixedSig = fromJust . T.mkSignature $ "yyyyuuu" + + -- Protocol version + fixedBytes <- get 16 + fixed' <- U.unmarshal T.LittleEndian fixed'Sig fixedBytes + checkMatchingVersion $ fixed' !! 3 + + -- Endianness + endianness <- getEndianness $ fixed' !! 0 + + -- Header field bytes + fixed <- U.unmarshal endianness fixedSig fixedBytes + let fieldByteCount = fromJust . T.fromVariant $ fixed !! 6 + fieldBytes <- get fieldByteCount + + -- Post-field padding + let bodyPadding = padding (fromIntegral fieldByteCount + 16) 8 + get . fromIntegral $ bodyPadding + + -- Body bytes + let bodyByteCount = fromJust . T.fromVariant $ fixed !! 4 + bodyBytes <- get bodyByteCount + return (endianness, L.append fixedBytes fieldBytes, bodyBytes) +\end{code} + +\begin{code} +checkMatchingVersion :: (E.Error e, E.MonadError e m) => T.Variant -> m () +checkMatchingVersion v = unless (messageVersion == protocolVersion) $ do + E.throwError . E.strMsg . concat $ + [ "Protocol version mismatch: " + , show messageVersion + , " != " + , show protocolVersion + ] + where messageVersion = fromJust . T.fromVariant $ v +\end{code} + +\begin{code} +getEndianness :: (E.Error e, E.MonadError e m) => T.Variant -> m T.Endianness +getEndianness v = maybe bad return $ T.fromVariant v where + word = fromJust . T.fromVariant $ v :: Word8 + bad = E.throwError . E.strMsg + $ "Invalid endianness code: " ++ show word +\end{code} + +Next, the header is parsed into a proper {\tt MessageHeader}. + +\begin{code} +parseHeader :: (E.Error e, E.MonadError e m) + => T.Endianness -> L.ByteString -> m MessageHeader +parseHeader endianness bytes = do + let signature = fromJust . T.mkSignature $ "yyyyuua(yv)" + vs <- U.unmarshal endianness signature bytes + let fieldArray = fromJust . T.fromVariant $ vs !! 6 + let fields = mapMaybe T.fromVariant $ T.arrayItems fieldArray + let flagByte = fromJust . T.fromVariant $ vs !! 2 + return $ MessageHeader + endianness + (fromJust . T.fromVariant $ vs !! 1) + (S.fromList . decodeFlags $ flagByte) + (fromJust . T.fromVariant $ vs !! 3) + (fromJust . T.fromVariant $ vs !! 4) + (fromJust . T.fromVariant $ vs !! 5) + fields +\end{code} + +If the header fields contain a body signature, it should be used for +unmarshaling the body. Otherwise, the body is assumed to be empty. + +\begin{code} +findBodySignature :: [HeaderField] -> T.Signature +findBodySignature fields = fromMaybe empty signature where + empty = fromJust . T.mkSignature $ "" + signature = listToMaybe [x | Signature x <- fields] +\end{code} + +\begin{code} +mkReceived :: (E.Error e, E.MonadError e m) + => Word8 -> T.Serial -> [HeaderField] -> S.Set Flag + -> [T.Variant] -> m ReceivedMessage +mkReceived 1 = mkReceived' ReceivedMethodCall mkMethodCall +mkReceived 2 = mkReceived' ReceivedMethodReturn mkMethodReturn +mkReceived 3 = mkReceived' ReceivedError mkError +mkReceived 4 = mkReceived' ReceivedSignal mkSignal +mkReceived _ = undefined -- mkReceived' ReceivedUnknown mkUnknown +\end{code} + +\begin{code} +mkReceived' :: (E.Error e, E.MonadError e m) + => (T.Serial -> Maybe T.BusName -> a -> ReceivedMessage) + -> ([HeaderField] -> S.Set Flag -> [T.Variant] -> m a) + -> T.Serial -> [HeaderField] -> S.Set Flag -> [T.Variant] + -> m ReceivedMessage +mkReceived' mkRecv mkMsg serial fields flags body = do + msg <- mkMsg fields flags body + let sender = listToMaybe [x | Sender x <- fields] + return $ mkRecv serial sender msg +\end{code} + +\begin{code} +mkMethodCall :: (E.Error e, E.MonadError e m) => [HeaderField] -> S.Set Flag + -> [T.Variant] -> m MethodCall +mkMethodCall fields flags body = do + path <- require "path" [x | Path x <- fields] + member <- require "member name" [x | Member x <- fields] + let iface = listToMaybe [x | Interface x <- fields] + let dest = listToMaybe [x | Destination x <- fields] + return $ MethodCall path member iface dest flags body +\end{code} + +\begin{code} +mkMethodReturn :: (E.Error e, E.MonadError e m) => [HeaderField] -> S.Set Flag + -> [T.Variant] -> m MethodReturn +mkMethodReturn fields flags body = do + serial <- require "reply serial" [x | ReplySerial x <- fields] + let dest = listToMaybe [x | Destination x <- fields] + return $ MethodReturn serial dest flags body +\end{code} + +\begin{code} +mkError :: (E.Error e, E.MonadError e m) => [HeaderField] -> S.Set Flag + -> [T.Variant] -> m Error +mkError fields flags body = do + name <- require "error name" [x | ErrorName x <- fields] + serial <- require "reply serial" [x | ReplySerial x <- fields] + let dest = listToMaybe [x | Destination x <- fields] + return $ Error name serial dest flags body +\end{code} + +\begin{code} +mkSignal :: (E.Error e, E.MonadError e m) => [HeaderField] -> S.Set Flag + -> [T.Variant] -> m Signal +mkSignal fields flags body = do + path <- require "path" [x | Path x <- fields] + member <- require "member" [x | Member x <- fields] + iface <- require "interface" [x | Interface x <- fields] + return $ Signal path member iface flags body +\end{code} + +\begin{code} +require :: (E.Error e, E.MonadError e m) => String -> [a] -> m a +require _ (x:_) = return x +require label _ = E.throwError . E.strMsg $ "Required field " ++ show label ++ " is missing." +\end{code} diff --git a/DBus/Types.lhs b/DBus/Types.lhs new file mode 100644 --- /dev/null +++ b/DBus/Types.lhs @@ -0,0 +1,47 @@ +% 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 . + +\ignore{ +\begin{code} +module DBus.Types + ( module DBus.Types.Atom + , module DBus.Types.Containers + , module DBus.Types.Endianness + , module DBus.Types.Names + , module DBus.Types.ObjectPath + , module DBus.Types.Serial + , module DBus.Types.Signature + ) where + +import DBus.Types.Atom +import DBus.Types.Containers +import DBus.Types.Endianness +import DBus.Types.Names +import DBus.Types.ObjectPath +import DBus.Types.Serial +import DBus.Types.Signature +\end{code} +} + +\clearpage +\section{Types} + +\input{DBus/Types/Atom.lhs} +\input{DBus/Types/Signature.lhs} +\input{DBus/Types/Names.lhs} +\input{DBus/Types/ObjectPath.lhs} +\input{DBus/Types/Serial.lhs} +\input{DBus/Types/Endianness.lhs} +\input{DBus/Types/Containers.lhs} diff --git a/DBus/Types/Atom.lhs b/DBus/Types/Atom.lhs new file mode 100644 --- /dev/null +++ b/DBus/Types/Atom.lhs @@ -0,0 +1,103 @@ +% 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 . + +\subsection{Atoms} + +\ignore{ +\begin{code} +{-# LANGUAGE TypeSynonymInstances #-} +module DBus.Types.Atom + ( Atom + , Atomic + , toAtom + , fromAtom + , atomSignature + , atomToVariant + , atomFromVariant + ) where + +import Control.Monad (msum) +import Data.Word (Word8, Word16, Word32, Word64) +import Data.Int (Int16, Int32, Int64) +import qualified DBus.Types.Signature as S +import qualified DBus.Types.ObjectPath as O +import {-# SOURCE #-} qualified DBus.Types.Containers as C +\end{code} +} + +Any atomic value can be used as a dictionary key. Types which might be +used for dict keys should implement {\tt Atomic}. + +\begin{code} +newtype Atom = Atom C.Variant + deriving (Show, Eq) + +class C.Variable a => Atomic a where + toAtom :: a -> Atom + +atomToVariant :: Atom -> C.Variant +atomToVariant (Atom x) = x + +atomFromVariant :: C.Variant -> Maybe Atom +atomFromVariant v = msum as where + v' :: C.Variable a => Maybe a + v' = C.fromVariant v + fa :: (Atomic a, Functor f) => f a -> f Atom + fa = fmap toAtom + + as = [fa (v' :: Maybe Bool) + ,fa (v' :: Maybe Word8) + ,fa (v' :: Maybe Word16) + ,fa (v' :: Maybe Word32) + ,fa (v' :: Maybe Word64) + ,fa (v' :: Maybe Int16) + ,fa (v' :: Maybe Int32) + ,fa (v' :: Maybe Int64) + ,fa (v' :: Maybe Double) + ,fa (v' :: Maybe String) + ,fa (v' :: Maybe O.ObjectPath) + ,fa (v' :: Maybe S.Signature) + ] +\end{code} + +\begin{code} +fromAtom :: C.Variable a => Atom -> Maybe a +fromAtom (Atom x) = C.fromVariant x +\end{code} + +\begin{code} +atomSignature :: Atom -> S.Signature +atomSignature (Atom v) = C.variantSignature v +\end{code} + +\subsubsection{Built-in atomic types} + +\begin{code} +toAtom' :: Atomic a => a -> Atom +toAtom' = Atom . C.toVariant + +instance Atomic Bool where toAtom = toAtom' +instance Atomic Word8 where toAtom = toAtom' +instance Atomic Word16 where toAtom = toAtom' +instance Atomic Word32 where toAtom = toAtom' +instance Atomic Word64 where toAtom = toAtom' +instance Atomic Int16 where toAtom = toAtom' +instance Atomic Int32 where toAtom = toAtom' +instance Atomic Int64 where toAtom = toAtom' +instance Atomic Double where toAtom = toAtom' +instance Atomic String where toAtom = toAtom' +instance Atomic O.ObjectPath where toAtom = toAtom' +instance Atomic S.Signature where toAtom = toAtom' +\end{code} diff --git a/DBus/Types/Containers.lhs b/DBus/Types/Containers.lhs new file mode 100644 --- /dev/null +++ b/DBus/Types/Containers.lhs @@ -0,0 +1,326 @@ +% 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 . + +\ignore{ +\begin{code} +{-# LANGUAGE TypeSynonymInstances #-} +{-# LANGUAGE ExistentialQuantification #-} +{-# LANGUAGE DeriveDataTypeable #-} +module DBus.Types.Containers + ( Variant + , Variable + , toVariant + , fromVariant + , defaultSignature + , variantSignature + + , Array + , toArray + , fromArray + , arrayItems + , arrayFromItems + , arraySignature + + , Dictionary + , toDictionary + , fromDictionary + , dictionaryItems + , dictionaryFromItems + , dictionarySignature + + , Structure (..) + , structureSignature + ) where + +import Control.Arrow ((***)) +import Data.Typeable (Typeable, cast) +import Data.Maybe (fromJust) +import Data.Word (Word8, Word16, Word32, Word64) +import Data.Int (Int16, Int32, Int64) +import qualified DBus.Types.Signature as S +import qualified DBus.Types.ObjectPath as O +import qualified DBus.Types.Atom as A +\end{code} +} +\subsection{Containers} + +\subsubsection{Variants} + +Any value which can be converted to a {\tt Variant} can be stored in D-Bus +containers or marshaled. Additionally, external types may implement the +{\tt Variable} interface to provide custom conversion to/from built-in D-Bus +types. + +The {\tt defaultSignature} function will be passed {\tt unknown} to determine +the signature an empty array or dictionary. + +\begin{code} +class Variable a where + defaultSignature :: a -> S.Signature + toVariant :: a -> Variant + fromVariant :: Variant -> Maybe a +\end{code} + +\begin{code} +data Variant = forall a. (Variable a, Typeable a, Show a) => + Variant S.Signature a + deriving (Typeable) + +instance Show Variant where + showsPrec d (Variant sig x) = showParen (d > 10) $ + s "Variant " . s sigStr . s " " . showsPrec 11 x + where sigStr = show . S.strSignature $ sig + s = showString +\end{code} + +Ghetto Eq instance -- the types contained in variants are known to have +fixed {\tt show} representations, so this works well enough. + +It might not work right for {\tt Double}, though. + +\begin{code} +instance Eq Variant where + x == y = show x == show y +\end{code} + +Variants are themselves variables. + +\begin{code} +instance Variable Variant where + defaultSignature _ = sig' "v" + toVariant = variant' "v" + fromVariant = cast' +\end{code} + +\begin{code} +variantSignature :: Variant -> S.Signature +variantSignature (Variant s _) = s +\end{code} + +\begin{code} +instance Variable Bool where + defaultSignature _ = sig' "b" + toVariant = variant' "b" + fromVariant = cast' +\end{code} + +\begin{code} +instance Variable Word8 where + defaultSignature _ = sig' "y" + toVariant = variant' "y" + fromVariant = cast' +\end{code} + +\begin{code} +instance Variable Word16 where + defaultSignature _ = sig' "q" + toVariant = variant' "q" + fromVariant = cast' +\end{code} + +\begin{code} +instance Variable Word32 where + defaultSignature _ = sig' "u" + toVariant = variant' "u" + fromVariant = cast' +\end{code} + +\begin{code} +instance Variable Word64 where + defaultSignature _ = sig' "t" + toVariant = variant' "t" + fromVariant = cast' +\end{code} + +\begin{code} +instance Variable Int16 where + defaultSignature _ = sig' "n" + toVariant = variant' "n" + fromVariant = cast' +\end{code} + +\begin{code} +instance Variable Int32 where + defaultSignature _ = sig' "i" + toVariant = variant' "i" + fromVariant = cast' +\end{code} + +\begin{code} +instance Variable Int64 where + defaultSignature _ = sig' "x" + toVariant = variant' "x" + fromVariant = cast' +\end{code} + +\begin{code} +instance Variable Double where + defaultSignature _ = sig' "d" + toVariant = variant' "d" + fromVariant = cast' +\end{code} + +\begin{code} +instance Variable String where + defaultSignature _ = sig' "s" + toVariant = variant' "s" + fromVariant = cast' +\end{code} + +\begin{code} +instance Variable O.ObjectPath where + defaultSignature _ = sig' "o" + toVariant = variant' "o" + fromVariant = cast' +\end{code} + +\begin{code} +instance Variable S.Signature where + defaultSignature _ = sig' "g" + toVariant = variant' "g" + fromVariant = cast' +\end{code} + +\subsubsection{Arrays} + +Arrays are homogeneous sequences of any valid type. They may be +converted to and from standard Haskell lists, where the list contains elements with +a valid type. + +\begin{code} +data Array = Array S.Signature [Variant] + deriving (Show, Eq, Typeable) + +instance Variable Array where + defaultSignature _ = sig' "ay" + toVariant x = Variant (arraySignature x) x + fromVariant = cast' + +toArray :: Variable a => [a] -> Maybe Array +toArray vs@([]) = Just $ Array sig [] where + itemSig = defaultSignature . head $ undefined:vs + sig = sig' $ 'a' : S.strSignature itemSig + +toArray vs = arrayFromItems sig variants where + variants = map toVariant vs + sig = variantSignature . head $ variants + +fromArray :: Variable a => Array -> Maybe [a] +fromArray (Array _ vs) = mapM fromVariant vs + +arrayItems :: Array -> [Variant] +arrayItems (Array _ vs) = vs + +arrayFromItems :: S.Signature -> [Variant] -> Maybe Array +arrayFromItems itemSig vs = maybeArray where + maybeArray = if hasSignature itemSig vs + then Just (Array sig vs) + else Nothing + sig = sig' $ 'a' : S.strSignature itemSig + +arraySignature :: Array -> S.Signature +arraySignature (Array s _) = s +\end{code} + +\subsubsection{Dictionaries} + +Dictionaries are a key $\rightarrow$ value mapping, where the keys must be of an +{\tt Atomic} type, and the values may be of any valid DBus type. + +\begin{code} +data Dictionary = Dictionary S.Signature [(A.Atom, Variant)] + deriving (Show, Eq, Typeable) + +instance Variable Dictionary where + defaultSignature _ = sig' "a{yy}" + toVariant x = Variant (dictionarySignature x) x + fromVariant = cast' + +toDictionary :: (A.Atomic a, Variable b) => [(a, b)] -> Maybe Dictionary +toDictionary vs@([]) = Just $ Dictionary sig [] where + fake = head $ (undefined, undefined) : vs + kSig = S.strSignature . defaultSignature . fst $ fake + vSig = S.strSignature . defaultSignature . snd $ fake + sig = sig' $ "a{" ++ kSig ++ vSig ++ "}" + +toDictionary pairs = dictionaryFromItems kSig vSig pairs' where + pairs' = map (A.toAtom *** toVariant) pairs + kSig = A.atomSignature . fst . head $ pairs' + vSig = variantSignature . snd . head $ pairs' + +fromDictionary :: (A.Atomic a, Variable b) => Dictionary -> Maybe [(a, b)] +fromDictionary (Dictionary _ vs) = mapM fromVariant' vs where + fromVariant' (k, v) = do + k' <- A.fromAtom k + v' <- fromVariant v + return (k', v') + +dictionaryItems :: Dictionary -> [(A.Atom, Variant)] +dictionaryItems (Dictionary _ vs) = vs + +dictionaryFromItems :: S.Signature -> S.Signature -> [(A.Atom, Variant)] + -> Maybe Dictionary +dictionaryFromItems kSig vSig pairs = maybeDict where + maybeDict = if hasSignature kSig ks && hasSignature vSig vs + then Just (Dictionary sig pairs) + else Nothing + + ks = map (A.atomToVariant . fst) pairs + vs = map snd pairs + + kSig' = S.strSignature kSig + vSig' = S.strSignature vSig + sig = sig' $ "a{" ++ kSig' ++ vSig' ++ "}" + +dictionarySignature :: Dictionary -> S.Signature +dictionarySignature (Dictionary s _) = s +\end{code} + +\subsubsection{Structures} + +Structures contain a heterogenous list of DBus values. Any value may be +contained within a structure. + +\begin{code} +data Structure = Structure [Variant] + deriving (Show, Eq, Typeable) + +instance Variable Structure where + defaultSignature _ = sig' "()" + toVariant x = Variant (structureSignature x) x + fromVariant = cast' + +structureSignature :: Structure -> S.Signature +structureSignature (Structure vs) = sig where + sigs = [s | (Variant s _) <- vs] + sig = sig' $ "(" ++ concatMap S.strSignature sigs ++ ")" +\end{code} + +\subsubsection*{Helper functions} + +\begin{code} +sig' :: String -> S.Signature +sig' = fromJust . S.mkSignature + +variant' :: (Variable a, Typeable a, Show a) => String -> a -> Variant +variant' = Variant . sig' + +cast' :: Typeable a => Variant -> Maybe a +cast' (Variant _ x) = cast x + +hasSignature :: S.Signature -> [Variant] -> Bool +hasSignature _ [] = True +hasSignature sig vs = all (== sig) . map variantSignature $ vs +\end{code} diff --git a/DBus/Types/Endianness.lhs b/DBus/Types/Endianness.lhs new file mode 100644 --- /dev/null +++ b/DBus/Types/Endianness.lhs @@ -0,0 +1,49 @@ +% 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 . + +\ignore{ +\begin{code} +module DBus.Types.Endianness (Endianness (..)) where + +import Data.Word (Word8) +import Data.Maybe (fromJust) +import qualified DBus.Types.Containers as C +import DBus.Types.Signature (mkSignature) +\end{code} +} + +\subsubsection{Endianness} + +\begin{code} +data Endianness = LittleEndian | BigEndian + deriving (Show, Eq) +\end{code} + +Endianness is encoded in the header as a single ASCII character, either +{\tt 'l'} ({\tt 0x6C}) for little-endian or {\tt 'B'} ({\tt 0x42}) for +big-endian. + +\begin{code} +instance C.Variable Endianness where + defaultSignature _ = fromJust . mkSignature $ "y" + toVariant LittleEndian = C.toVariant (0x6C :: Word8) + toVariant BigEndian = C.toVariant (0x42 :: Word8) + fromVariant v = do + b <- C.fromVariant v :: Maybe Word8 + case b of + 0x6C -> Just LittleEndian + 0x42 -> Just BigEndian + _ -> Nothing +\end{code} diff --git a/DBus/Types/Names.lhs b/DBus/Types/Names.lhs new file mode 100644 --- /dev/null +++ b/DBus/Types/Names.lhs @@ -0,0 +1,175 @@ +% 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 . + +\ignore{ +\begin{code} +module DBus.Types.Names + ( InterfaceName + , mkInterfaceName + , strInterfaceName + + , BusName + , mkBusName + , strBusName + + , MemberName + , mkMemberName + , strMemberName + + , ErrorName + , mkErrorName + , strErrorName + ) where + +import Data.Maybe (fromJust) +import Text.Parsec ((<|>)) +import qualified Text.Parsec as P +import qualified DBus.Types.Atom as A +import qualified DBus.Types.Containers as C +import DBus.Types.Signature (mkSignature) +import DBus.Types.Util (checkLength, parseMaybe) +\end{code} +} + +\subsubsection{Names} + +All names have a length limit of 255 characters. + +\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. + +\begin{code} +newtype InterfaceName = InterfaceName String + deriving (Show, Eq, Ord) +\end{code} + +\begin{code} +instance C.Variable InterfaceName where + defaultSignature _ = fromJust . mkSignature $ "s" + toVariant = A.atomToVariant . A.toAtom + fromVariant = (mkInterfaceName =<<) . C.fromVariant +instance A.Atomic InterfaceName where + toAtom = A.toAtom . strInterfaceName +\end{code} + +\begin{code} +mkInterfaceName :: String -> Maybe InterfaceName +mkInterfaceName s = checkLength 255 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) +\end{code} + +\begin{code} +strInterfaceName :: InterfaceName -> String +strInterfaceName (InterfaceName x) = x +\end{code} + +\subsubsection{Error names} + +Error names have the same rules as interface names, so just re-use that +validation logic. + +\begin{code} +newtype ErrorName = ErrorName String + deriving (Show, Eq, Ord) +\end{code} + +\begin{code} +instance C.Variable ErrorName where + defaultSignature _ = fromJust . mkSignature $ "s" + toVariant = A.atomToVariant . A.toAtom + fromVariant = (mkErrorName =<<) . C.fromVariant +instance A.Atomic ErrorName where + toAtom = A.toAtom . strErrorName +\end{code} + +\begin{code} +mkErrorName :: String -> Maybe ErrorName +mkErrorName = fmap (ErrorName . strInterfaceName) . mkInterfaceName +\end{code} + +\begin{code} +strErrorName :: ErrorName -> String +strErrorName (ErrorName x) = x +\end{code} + +\subsubsection{Bus names} + +\begin{code} +newtype BusName = BusName String + deriving (Show, Eq, Ord) +\end{code} + +\begin{code} +instance C.Variable BusName where + defaultSignature _ = fromJust . mkSignature $ "s" + toVariant = A.atomToVariant . A.toAtom + fromVariant = (mkBusName =<<) . C.fromVariant +instance A.Atomic BusName where + toAtom = A.toAtom . strBusName +\end{code} + +\begin{code} +mkBusName :: String -> Maybe BusName +mkBusName s = checkLength 255 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') +\end{code} + +\begin{code} +strBusName :: BusName -> String +strBusName (BusName x) = x +\end{code} + +\subsubsection{Member names} + +\begin{code} +newtype MemberName = MemberName String + deriving (Show, Eq, Ord) +\end{code} + +\begin{code} +instance C.Variable MemberName where + defaultSignature _ = fromJust . mkSignature $ "s" + toVariant = A.atomToVariant . A.toAtom + fromVariant = (mkMemberName =<<) . C.fromVariant +instance A.Atomic MemberName where + toAtom = A.toAtom . strMemberName +\end{code} + +\begin{code} +mkMemberName :: String -> Maybe MemberName +mkMemberName s = checkLength 255 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) +\end{code} + +\begin{code} +strMemberName :: MemberName -> String +strMemberName (MemberName x) = x +\end{code} diff --git a/DBus/Types/ObjectPath.lhs b/DBus/Types/ObjectPath.lhs new file mode 100644 --- /dev/null +++ b/DBus/Types/ObjectPath.lhs @@ -0,0 +1,57 @@ +% 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 . + +\ignore{ +\begin{code} +{-# LANGUAGE DeriveDataTypeable #-} +module DBus.Types.ObjectPath + ( ObjectPath + , mkObjectPath + , strObjectPath + ) where + +import Data.Typeable (Typeable) +import qualified Text.Parsec as P +import DBus.Types.Util (parseMaybe) +\end{code} +} + +\subsubsection{Object paths} + +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. + +\begin{code} +newtype ObjectPath = ObjectPath String + deriving (Show, Eq, Ord, Typeable) + +mkObjectPath :: String -> Maybe ObjectPath +mkObjectPath s = parseMaybe path' 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) + +strObjectPath :: ObjectPath -> String +strObjectPath (ObjectPath x) = x +\end{code} diff --git a/DBus/Types/Serial.lhs b/DBus/Types/Serial.lhs new file mode 100644 --- /dev/null +++ b/DBus/Types/Serial.lhs @@ -0,0 +1,58 @@ +% 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 . + +\ignore{ +\begin{code} +module DBus.Types.Serial + ( Serial (..) + , nextSerial + , firstSerial + ) where + +import Data.Word (Word32) +import Data.Maybe (fromJust) +import qualified DBus.Types.Atom as A +import qualified DBus.Types.Containers as C +import DBus.Types.Signature (mkSignature) +\end{code} +} + +\subsubsection{Message Serials} + +\begin{code} +newtype Serial = Serial Word32 + deriving (Eq, Ord) + +instance Show Serial where + show (Serial x) = show x + +instance A.Atomic Serial where + toAtom (Serial x) = A.toAtom x + +instance C.Variable Serial where + defaultSignature _ = fromJust . mkSignature $ "u" + toVariant (Serial x) = C.toVariant x + fromVariant = fmap Serial . C.fromVariant +\end{code} + +\begin{code} +nextSerial :: Serial -> Serial +nextSerial (Serial x) = Serial (x + 1) +\end{code} + +\begin{code} +firstSerial :: Serial +firstSerial = Serial 1 +\end{code} diff --git a/DBus/Types/Signature.lhs b/DBus/Types/Signature.lhs new file mode 100644 --- /dev/null +++ b/DBus/Types/Signature.lhs @@ -0,0 +1,150 @@ +% 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 . + +\ignore{ +\begin{code} +{-# LANGUAGE DeriveDataTypeable #-} +module DBus.Types.Signature + ( Signature + , Type(..) + , signatureTypes + , mkSignature + , strSignature + , typeString + ) where + +import Data.Typeable (Typeable) +import Text.Parsec (char, (<|>), many, eof) +import DBus.Types.Util (checkLength, parseMaybe) +\end{code} +} + +\subsubsection{Signatures} + +Valid DBus type signatures must obey certain rules, such as "dict entries +may only appear in arrays". A signature is guaranteed to be valid according +to these rules. Creating them requires using the {\tt parseSignature} +function, which will convert a valid DBus signature string into a +{\tt Signature}. + +\begin{code} +data Signature = Signature { signatureTypes :: [Type] } + deriving (Eq, Typeable) +\end{code} + +Use a custom {\tt Show} instance to avoid displaying signature types directly. + +\begin{code} +instance Show Signature where + showsPrec d s = showParen (d > 10) $ + showString' ["Signature \"", strSignature s, "\""] where + showString' = foldr (.) id . map showString +\end{code} + +Parse a signature string such as {\tt "yya{is}"} to a signature. If the +string is invalid, {\tt Nothing} will be returned instead. + +\begin{code} +mkSignature :: String -> Maybe Signature +mkSignature = (parseMaybe sigParser =<<) . checkLength 255 where + sigParser = do + types <- many parseType + eof + return $ Signature types + parseType = parseAtom <|> parseContainer + parseContainer = + parseArray + <|> parseStruct + <|> (char 'v' >> return VariantT) + parseAtom = + (char 'b' >> return BooleanT) + <|> (char 'y' >> return ByteT) + <|> (char 'n' >> return Int16T) + <|> (char 'q' >> return UInt16T) + <|> (char 'i' >> return Int32T) + <|> (char 'u' >> return UInt32T) + <|> (char 'x' >> return Int64T) + <|> (char 't' >> return UInt64T) + <|> (char 'd' >> return DoubleT) + <|> (char 's' >> return StringT) + <|> (char 'o' >> return ObjectPathT) + <|> (char 'g' >> return SignatureT) + parseArray = do + char 'a' + parseDict <|> do + t <- parseType + return $ ArrayT t + parseDict = do + char '{' + keyType <- parseAtom + valueType <- parseType + char '}' + return $ DictT keyType valueType + parseStruct = do + char '(' + types <- many parseType + char ')' + return $ StructT types +\end{code} + +Convert a signature to a string, for marshaling over the bus or display. + +\begin{code} +strSignature :: Signature -> String +strSignature (Signature ts) = concatMap typeString ts +\end{code} + +Data types which may be contained in a signature. No checks are performed to +ensure correct nesting when using these, so all generation of signatures +must go through {\tt parseSignature}. + +\begin{code} +data Type = + BooleanT + | ByteT + | Int16T + | UInt16T + | Int32T + | UInt32T + | Int64T + | UInt64T + | DoubleT + | StringT + | ObjectPathT + | SignatureT + | ArrayT Type + | DictT Type Type + | StructT [Type] + | VariantT + deriving (Show, Eq) + +typeString :: Type -> String +typeString BooleanT = "b" +typeString ByteT = "y" +typeString Int16T = "n" +typeString UInt16T = "q" +typeString Int32T = "i" +typeString UInt32T = "u" +typeString Int64T = "x" +typeString UInt64T = "t" +typeString DoubleT = "d" +typeString StringT = "s" +typeString ObjectPathT = "o" +typeString SignatureT = "g" +typeString (ArrayT t) = 'a' : typeString t +typeString (DictT kt vt) = "a{" ++ typeString kt ++ typeString vt ++ "}" +typeString (StructT ts) = "(" ++ concatMap typeString ts ++ ")" +typeString VariantT = "v" +\end{code} 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/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/dbus-core.cabal b/dbus-core.cabal new file mode 100644 --- /dev/null +++ b/dbus-core.cabal @@ -0,0 +1,30 @@ +name: dbus-core +version: 0.1 +synopsis: DBus protocol +license: GPL +license-file: License.txt +author: John Millikin +maintainer: jmillikin@gmail.com +build-type: Simple +cabal-version: >=1.6 +category: Data +stability: experimental +bug-reports: mailto:jmillikin@gmail.com + +library + build-depends: base >=4 && < 5, parsec >= 3, bytestring, + data-binary-ieee754, binary, utf8-string, mtl, + containers, unix, network + exposed-modules: + DBus.Bus + DBus.Bus.Address + DBus.Bus.Connection + DBus.Message + DBus.Types + DBus.Types.Atom + DBus.Types.Containers + DBus.Types.Endianness + DBus.Types.Names + DBus.Types.ObjectPath + DBus.Types.Serial + DBus.Types.Signature