{-# LINE 2 "./Graphics/UI/Gtk/SourceView/SourceLanguage.chs" #-}
-- -*-haskell-*-
-- GIMP Toolkit (GTK) Widget SourceView
--
-- Author : Peter Gavin, Andy Stewart
-- derived from sourceview bindings by Axel Simon and Duncan Coutts
--
-- Created: 18 December 2008
--
-- Copyright (C) 2004-2008 Peter Gavin, Duncan Coutts, Axel Simon
-- Copyright (C) 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 2.1 of the License, or (at your option) any later version.
--
-- This library is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-- Lesser General Public License for more details.
--
-- |
-- Maintainer : gtk2hs-users@lists.sourceforge.net
-- Stability : provisional
-- Portability : portable (depends on GHC)
--
module Graphics.UI.Gtk.SourceView.SourceLanguage (
-- * Description
-- | 'SourceLanguage' encapsulates syntax and highlighting styles for a particular language. Use
-- 'SourceLanguageManager' to obtain a 'SourceLanguage' instance, and
-- 'sourceBufferSetLanguage' to apply it to a 'SourceBuffer'.

-- * Types
  SourceLanguage,
  SourceLanguageClass,

-- * Methods
  castToSourceLanguage,
  gTypeSourceLanguage,
  toSourceLanguage,
  sourceLanguageGetId,
  sourceLanguageGetName,
  sourceLanguageGetSection,
  sourceLanguageGetHidden,
  sourceLanguageGetMetadata,
  sourceLanguageGetMimeTypes,
  sourceLanguageGetGlobs,
  sourceLanguageGetStyleName,
  sourceLanguageGetStyleIds,

-- * Attributes
  sourceLanguageHidden,
  sourceLanguageId,
  sourceLanguageName,
  sourceLanguageSection
  ) where

import Control.Monad (liftM)
import Data.Maybe (fromMaybe)

import System.Glib.Attributes
import System.Glib.FFI
import System.Glib.UTFString

import Graphics.UI.Gtk.SourceView.SourceStyleScheme
{-# LINE 67 "./Graphics/UI/Gtk/SourceView/SourceLanguage.chs" #-}
import Graphics.UI.Gtk.SourceView.Types
{-# LINE 68 "./Graphics/UI/Gtk/SourceView/SourceLanguage.chs" #-}
import System.Glib.Properties
{-# LINE 69 "./Graphics/UI/Gtk/SourceView/SourceLanguage.chs" #-}


{-# LINE 71 "./Graphics/UI/Gtk/SourceView/SourceLanguage.chs" #-}

-- methods

-- | Returns the ID of the language. The ID is not locale-dependent.
--
sourceLanguageGetId :: (SourceLanguageClass sl, GlibString string) => sl
                    -> IO string -- ^ returns the ID of language. The returned string is owned by language and should not be freed or modified.
sourceLanguageGetId sl =
  (\(SourceLanguage arg1) -> withForeignPtr arg1 $ \argPtr1 ->gtk_source_language_get_id argPtr1) (toSourceLanguage sl) >>= peekUTFString

-- | Returns the localized name of the language.
--
sourceLanguageGetName :: (SourceLanguageClass sl, GlibString string) => sl
                      -> IO string -- ^ returns the name of language. The returned string is owned by language and should not be freed or modified.
sourceLanguageGetName sl =
  (\(SourceLanguage arg1) -> withForeignPtr arg1 $ \argPtr1 ->gtk_source_language_get_name argPtr1) (toSourceLanguage sl) >>= peekUTFString

-- | Returns the localized section of the language. Each language belong to a section (ex. HTML belogs to
-- the Markup section).
--
sourceLanguageGetSection :: (SourceLanguageClass sl, GlibString string) => sl
                         -> IO string -- ^ returns the section of language. The returned string is owned by language and should not be freed or modified.
sourceLanguageGetSection sl =
  (\(SourceLanguage arg1) -> withForeignPtr arg1 $ \argPtr1 ->gtk_source_language_get_section argPtr1) (toSourceLanguage sl) >>= peekUTFString

-- | Returns whether the language should be hidden from the user.
--
sourceLanguageGetHidden :: SourceLanguageClass sl => sl
                        -> IO Bool -- ^ returns 'True' if the language should be hidden, 'False' otherwise.
sourceLanguageGetHidden sl = liftM toBool $
  (\(SourceLanguage arg1) -> withForeignPtr arg1 $ \argPtr1 ->gtk_source_language_get_hidden argPtr1) (toSourceLanguage sl)

-- |
--
sourceLanguageGetMetadata :: (SourceLanguageClass sl, GlibString string) => sl
                          -> string -- ^ @name@ metadata property name.
                          -> IO string -- ^ returns value of property name stored in the metadata of language or empty if language doesn't contain that metadata
sourceLanguageGetMetadata sl name = do
  withUTFString name ((\(SourceLanguage arg1) arg2 -> withForeignPtr arg1 $ \argPtr1 ->gtk_source_language_get_metadata argPtr1 arg2) (toSourceLanguage sl)) >>= peekUTFString

-- | Returns the mime types associated to this language. This is just an utility wrapper around
-- 'sourceLanguageGetMetadata ' to retrieve the "mimetypes" metadata property and split it into
-- an array.
--
sourceLanguageGetMimeTypes :: (SourceLanguageClass sl, GlibString string) => sl
                           -> IO [string] -- ^ returns an array containing the mime types or empty if no mime types are found. The
sourceLanguageGetMimeTypes sl = do
  mimeTypesArray <- (\(SourceLanguage arg1) -> withForeignPtr arg1 $ \argPtr1 ->gtk_source_language_get_mime_types argPtr1) (toSourceLanguage sl)
  mimeTypes <- liftM (fromMaybe []) $ maybePeek peekUTFStringArray0 mimeTypesArray
  g_strfreev mimeTypesArray
  return mimeTypes

-- | Returns the globs associated to this language. This is just an utility wrapper around
-- 'sourceLanguageGetMetadata' to retrieve the "globs" metadata property and split it into an
-- array.
--
sourceLanguageGetGlobs :: (SourceLanguageClass sl, GlibString string) => sl
                       -> IO [string] -- ^ returns an array containing the globs or empty if no globs are found.
sourceLanguageGetGlobs sl = do
  globsArray <- (\(SourceLanguage arg1) -> withForeignPtr arg1 $ \argPtr1 ->gtk_source_language_get_globs argPtr1) (toSourceLanguage sl)
  globs <- liftM (fromMaybe []) $ maybePeek peekUTFStringArray0 globsArray
  g_strfreev globsArray
  return globs

-- | Returns the name of the style with ID @styleId@ defined by this language.
sourceLanguageGetStyleName :: (SourceLanguageClass sl, GlibString string) => sl
                           -> string -- ^ @styleId@ a style ID
                           -> IO string -- ^ returns the name of the style with ID @styleId@ defined by this language or empty if the style has no name or there is no style with ID @styleId@ defined by this language. The returned string is owned by the language and must not be modified.
sourceLanguageGetStyleName sl styleId =
    withUTFString styleId $ \styleIdPtr ->
    (\(SourceLanguage arg1) arg2 -> withForeignPtr arg1 $ \argPtr1 ->gtk_source_language_get_style_name argPtr1 arg2)
{-# LINE 142 "./Graphics/UI/Gtk/SourceView/SourceLanguage.chs" #-}
       (toSourceLanguage sl)
       styleIdPtr
    >>= peekUTFString

-- | Returns the ids of the styles defined by this language.
sourceLanguageGetStyleIds :: (SourceLanguageClass sl, GlibString string) => sl
                          -> IO [string] -- ^ returns an array containing ids of the styles defined by this language or empty if no style is defined.
sourceLanguageGetStyleIds sl = do
  globsArray <- (\(SourceLanguage arg1) -> withForeignPtr arg1 $ \argPtr1 ->gtk_source_language_get_style_ids argPtr1) (toSourceLanguage sl)
  globs <- liftM (fromMaybe []) $ maybePeek peekUTFStringArray0 globsArray
  g_strfreev globsArray
  return globs

-- | Whether the language should be hidden from the user.
--
-- Default value: 'False'
--
sourceLanguageHidden :: SourceLanguageClass sl => ReadAttr sl Bool
sourceLanguageHidden = readAttrFromBoolProperty "hidden"

-- | Language id.
--
-- Default value: \"\"
--
sourceLanguageId :: (SourceLanguageClass sl, GlibString string) => ReadAttr sl string
sourceLanguageId = readAttrFromStringProperty "id"

-- | Language name.
--
-- Default value: \"\"
--
sourceLanguageName :: (SourceLanguageClass sl, GlibString string) => ReadAttr sl string
sourceLanguageName = readAttrFromStringProperty "name"

-- | Language section.
--
-- Default value: \"\"
--
sourceLanguageSection :: (SourceLanguageClass sl, GlibString string) => ReadAttr sl string
sourceLanguageSection = readAttrFromStringProperty "section"

foreign import ccall unsafe "gtk_source_language_get_id"
  gtk_source_language_get_id :: ((Ptr SourceLanguage) -> (IO (Ptr CChar)))

foreign import ccall unsafe "gtk_source_language_get_name"
  gtk_source_language_get_name :: ((Ptr SourceLanguage) -> (IO (Ptr CChar)))

foreign import ccall unsafe "gtk_source_language_get_section"
  gtk_source_language_get_section :: ((Ptr SourceLanguage) -> (IO (Ptr CChar)))

foreign import ccall unsafe "gtk_source_language_get_hidden"
  gtk_source_language_get_hidden :: ((Ptr SourceLanguage) -> (IO CInt))

foreign import ccall unsafe "gtk_source_language_get_metadata"
  gtk_source_language_get_metadata :: ((Ptr SourceLanguage) -> ((Ptr CChar) -> (IO (Ptr CChar))))

foreign import ccall unsafe "gtk_source_language_get_mime_types"
  gtk_source_language_get_mime_types :: ((Ptr SourceLanguage) -> (IO (Ptr (Ptr CChar))))

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

foreign import ccall unsafe "gtk_source_language_get_globs"
  gtk_source_language_get_globs :: ((Ptr SourceLanguage) -> (IO (Ptr (Ptr CChar))))

foreign import ccall safe "gtk_source_language_get_style_name"
  gtk_source_language_get_style_name :: ((Ptr SourceLanguage) -> ((Ptr CChar) -> (IO (Ptr CChar))))

foreign import ccall safe "gtk_source_language_get_style_ids"
  gtk_source_language_get_style_ids :: ((Ptr SourceLanguage) -> (IO (Ptr (Ptr CChar))))