{-# LINE 2 "./System/GIO/Icons/Icon.chs" #-}
-- GIMP Toolkit (GTK) Binding for Haskell: binding to gio -*-haskell-*-
--
-- Author : Andy Stewart
-- Created: 30-Apirl-2010
--
-- Copyright (c) 2010 Andy Stewart
--
-- This library is free software: you can redistribute it and/or
-- modify it under the terms of the GNU Lesser General Public License
-- as published by the Free Software Foundation, either version 3 of
-- the License, or (at your option) any later version.
--
-- This library is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-- Lesser General Public License for more details.
--
-- You should have received a copy of the GNU Lesser General Public
-- License along with this program. If not, see
-- <http:
--
-- GIO, the C library which this Haskell library depends on, is
-- available under LGPL Version 2. The documentation included with
-- this library is based on the original GIO documentation.
--
-- | Maintainer : gtk2hs-devel@lists.sourceforge.net
-- Stability : alpha
-- Portability : portable (depends on GHC)
module System.GIO.Icons.Icon (
-- * Details
--
-- | 'Icon' is a very minimal interface for icons. It provides functions for checking the equality of two
-- icons, hashing of icons and serializing an icon to and from strings.
--
-- 'Icon' does not provide the actual pixmap for the icon as this is out of GIO's scope, however
-- implementations of 'Icon' may contain the name of an icon (see 'ThemedIcon'), or the path to an icon
-- (see GLoadableIcon).
--
-- To obtain a hash of a 'Icon', see 'iconHash'.
--
-- To check if two 'Icon's are equal, see 'iconEqual'.
--
-- For serializing a 'Icon', use 'iconToString'.
--
-- If your application or library provides one or more 'Icon' implementations you need to ensure that
-- each GType is registered with the type system prior to calling 'iconNewForString'.

-- * Types
    Icon(..),
    IconClass,

-- * Methods
    iconEqual,

    iconToString,
    iconNewForString,

    ) where

import Control.Monad
import Data.ByteString (ByteString)
import Data.ByteString (useAsCString)
import Data.ByteString.Unsafe (unsafePackCStringFinalizer)
import System.GIO.Enums
import System.Glib.FFI
import System.Glib.Flags
import System.Glib.GError
import System.Glib.GObject
import System.Glib.UTFString
import System.GIO.Types
{-# LINE 72 "./System/GIO/Icons/Icon.chs" #-}


{-# LINE 74 "./System/GIO/Icons/Icon.chs" #-}

-- | Checks if two icons are equal.
iconEqual :: (IconClass icon1, IconClass icon2) => icon1 -> icon2
 -> IO Bool -- ^ returns 'True' if icon1 is equal to icon2. 'False' otherwise.
iconEqual :: forall icon1 icon2.
(IconClass icon1, IconClass icon2) =>
icon1 -> icon2 -> IO Bool
iconEqual icon1
icon1 icon2
icon2 =
   (CInt -> Bool) -> IO CInt -> IO Bool
forall (m :: * -> *) a1 r. Monad m => (a1 -> r) -> m a1 -> m r
liftM CInt -> Bool
forall a. (Eq a, Num a) => a -> Bool
toBool (IO CInt -> IO Bool) -> IO CInt -> IO Bool
forall a b. (a -> b) -> a -> b
$
   (\(Icon ForeignPtr Icon
arg1) (Icon ForeignPtr Icon
arg2) -> ForeignPtr Icon -> (Ptr Icon -> IO CInt) -> IO CInt
forall a b. ForeignPtr a -> (Ptr a -> IO b) -> IO b
withForeignPtr ForeignPtr Icon
arg1 ((Ptr Icon -> IO CInt) -> IO CInt)
-> (Ptr Icon -> IO CInt) -> IO CInt
forall a b. (a -> b) -> a -> b
$ \Ptr Icon
argPtr1 ->ForeignPtr Icon -> (Ptr Icon -> IO CInt) -> IO CInt
forall a b. ForeignPtr a -> (Ptr a -> IO b) -> IO b
withForeignPtr ForeignPtr Icon
arg2 ((Ptr Icon -> IO CInt) -> IO CInt)
-> (Ptr Icon -> IO CInt) -> IO CInt
forall a b. (a -> b) -> a -> b
$ \Ptr Icon
argPtr2 ->Ptr Icon -> Ptr Icon -> IO CInt
g_icon_equal Ptr Icon
argPtr1 Ptr Icon
argPtr2) (icon1 -> Icon
forall o. IconClass o => o -> Icon
toIcon icon1
icon1) (icon2 -> Icon
forall o. IconClass o => o -> Icon
toIcon icon2
icon2)


-- | Generates a textual representation of icon that can be used for serialization such as when passing
-- icon to a different process or saving it to persistent storage. Use 'iconNewForString' to get
-- icon back from the returned string.
--
-- The encoding of the returned string is proprietary to 'Icon' except in the following two cases
--
-- * If icon is a 'FileIcon', the returned string is a native path (such as /path/to/my icon.png)
-- without escaping if the 'File' for icon is a native file. If the file is not native, the returned
-- string is the result of 'fileGetUri'.
--
-- * If icon is a 'ThemedIcon' with exactly one name, the encoding is simply the name (such as
-- network-server).
iconToString :: IconClass icon => icon
 -> IO ByteString
iconToString :: forall icon. IconClass icon => icon -> IO ByteString
iconToString icon
icon = do
   Ptr CChar
sPtr <- (\(Icon ForeignPtr Icon
arg1) -> ForeignPtr Icon -> (Ptr Icon -> IO (Ptr CChar)) -> IO (Ptr CChar)
forall a b. ForeignPtr a -> (Ptr a -> IO b) -> IO b
withForeignPtr ForeignPtr Icon
arg1 ((Ptr Icon -> IO (Ptr CChar)) -> IO (Ptr CChar))
-> (Ptr Icon -> IO (Ptr CChar)) -> IO (Ptr CChar)
forall a b. (a -> b) -> a -> b
$ \Ptr Icon
argPtr1 ->Ptr Icon -> IO (Ptr CChar)
g_icon_to_string Ptr Icon
argPtr1) (icon -> Icon
forall o. IconClass o => o -> Icon
toIcon icon
icon)
   Int
sLen <- CChar -> Ptr CChar -> IO Int
forall a. (Storable a, Eq a) => a -> Ptr a -> IO Int
lengthArray0 CChar
0 Ptr CChar
sPtr
   Ptr Word8 -> Int -> IO () -> IO ByteString
unsafePackCStringFinalizer (Ptr CChar -> Ptr Word8
forall a b. Ptr a -> Ptr b
castPtr Ptr CChar
sPtr) (Int -> Int
forall a b. (Integral a, Num b) => a -> b
fromIntegral Int
sLen)
        (Ptr () -> IO ()
g_free (Ptr CChar -> Ptr ()
forall a b. Ptr a -> Ptr b
castPtr Ptr CChar
sPtr))

-- | Generate a 'Icon' instance from str. This function can fail if str is not valid - see
-- 'iconToString' for discussion.
--
-- If your application or library provides one or more 'Icon' implementations you need to ensure that
-- each GType is registered with the type system prior to calling 'iconNewForString'.
iconNewForString :: ByteString -> IO Icon
iconNewForString :: ByteString -> IO Icon
iconNewForString ByteString
str =
    (ForeignPtr Icon -> Icon, FinalizerPtr Icon)
-> IO (Ptr Icon) -> IO Icon
forall obj.
GObjectClass obj =>
(ForeignPtr obj -> obj, FinalizerPtr obj) -> IO (Ptr obj) -> IO obj
wrapNewGObject (ForeignPtr Icon -> Icon, FinalizerPtr Icon)
forall {a}. (ForeignPtr Icon -> Icon, FinalizerPtr a)
mkIcon (IO (Ptr Icon) -> IO Icon) -> IO (Ptr Icon) -> IO Icon
forall a b. (a -> b) -> a -> b
$
    ByteString -> (Ptr CChar -> IO (Ptr Icon)) -> IO (Ptr Icon)
forall a. ByteString -> (Ptr CChar -> IO a) -> IO a
useAsCString ByteString
str ((Ptr CChar -> IO (Ptr Icon)) -> IO (Ptr Icon))
-> (Ptr CChar -> IO (Ptr Icon)) -> IO (Ptr Icon)
forall a b. (a -> b) -> a -> b
$ \ Ptr CChar
strPtr ->
    (Ptr (Ptr ()) -> IO (Ptr Icon)) -> IO (Ptr Icon)
forall a. (Ptr (Ptr ()) -> IO a) -> IO a
propagateGError (Ptr CChar -> Ptr (Ptr ()) -> IO (Ptr Icon)
g_icon_new_for_string Ptr CChar
strPtr)

foreign import ccall safe "g_icon_equal"
  g_icon_equal :: ((Ptr Icon) -> ((Ptr Icon) -> (IO CInt)))

foreign import ccall safe "g_icon_to_string"
  g_icon_to_string :: ((Ptr Icon) -> (IO (Ptr CChar)))

foreign import ccall unsafe "g_free"
  g_free :: ((Ptr ()) -> (IO ()))

foreign import ccall safe "g_icon_new_for_string"
  g_icon_new_for_string :: ((Ptr CChar) -> ((Ptr (Ptr ())) -> (IO (Ptr Icon))))