Database.PlistBuddy

Remote Monad

data PlistBuddy a

The Remote Monad

Instances

Monad PlistBuddy

Functor PlistBuddy

Applicative PlistBuddy

MonadIO PlistBuddy

MonadReader Plist PlistBuddy

openPlist :: FilePath -> IO Plist

Open a specific Plist, returning a Plist handle.

data Plist

The Remote Plist

Instances

MonadReader Plist PlistBuddy

send :: Plist -> PlistBuddy a -> IO a

Send the (remote) PlistBuddy monad to given Plist.

throwPlistError :: PlistError -> PlistBuddy a

Throw a PlistError. Uncaught PlistError exceptions will be thrown by send as IO Exceptions.

catchPlistError :: PlistBuddy a -> (PlistError -> PlistBuddy a) -> PlistBuddy a

A version of catchError with the type specialized to PlistBuddy. Using this will cause a static error if used on a non-PlistBuddy monad.

The Remote Monad operators

help :: PlistBuddy Text

Returns Help Text

exit :: PlistBuddy ()

Exits the program, changes are not saved to the file

save :: PlistBuddy ()

Saves the current changes to the file

revert :: PlistBuddy ()

Reloads the last saved version of the file

clear :: Value -> PlistBuddy ()

Clear Type - Clears out all existing entries, and creates root of a value, where the value is an empty Dict or Array.

get :: [Text] -> PlistBuddy Value

Print Entry - Gets value of Entry.

set :: [Text] -> Value -> PlistBuddy ()

Set Entry Value - Sets the value at Entry to Value You can not set dictionaries or arrays.

add :: [Text] -> Value -> PlistBuddy ()

Add Entry Type [Value] - Adds Entry to the plist, with value Value You can add *empty* dictionaries or arrays.

delete :: [Text] -> PlistBuddy ()

Delete Entry - Deletes Entry from the plist

Other types

data Value

Constructors

String Text

Array [Value]

Dict [(Text, Value)]

Bool Bool

Real Double

Integer Integer

Date UTCTime

Data ByteString

Instances

Read Value

Show Value

Generic Value

type Rep Value

valueType :: Value -> ByteString

Debugging

debugOn :: Plist -> Plist

Generate a version of Plist that outputs debuging information.

Exception

data PlistBuddyException

PlistBuddyException is for fatal things, like the sub-process blocks, for some reason.

Constructors

PlistBuddyException String

Instances

Show PlistBuddyException

Generic PlistBuddyException

Exception PlistBuddyException

type Rep PlistBuddyException

Audit

data Trail

Constructors

Save ByteString

hash code of saved file

Revert

Exit

Clear Value

Set [Text] Value

Add [Text] Value

Delete [Text]

Start ByteString

hash code at start of audit capture

Instances

Read Trail

Show Trail

Generic Trail

type Rep Trail

data AuditTrail

Constructors

AuditTrail ByteString [Trail] (Maybe ByteString)

Instances

Read AuditTrail

Show AuditTrail

Generic AuditTrail

type Rep AuditTrail

auditOn :: FilePath -> Plist -> IO Plist

auditOff :: Plist -> IO ()

Turn off audit.

replay :: Trail -> PlistBuddy ()

replay invokes the respective PlistBuddy function. It is uses when replying an audit replay.

recover :: FilePath -> IO [AuditTrail]

Find the list of PlistBuddy commands to recover the plist. Be careful when running recover with the audit capability turned on; it can duplicate the audit trail, because recovery is also write. (This should not break anything)

hashcode :: FilePath -> IO ByteString

findTrail :: ByteString -> [AuditTrail] -> [Trail]

Background version of Plist

data BackgroundPlist

This is a version of Plist that saves the database on regular occasions, and suspends itself when not used.

backgroundPlist :: Int -> IO Plist -> IO BackgroundPlist

This creates a background Plist. The Int argument is the number of seconds to wait before saveing and sleeping the Plist. The 'IO Plist' may be called many times.

bgSend :: BackgroundPlist -> PlistBuddy a -> IO a

Send a command to a background Plist. The semantics of bgSend is the same as saving after every command, provided you wait long enough.

bgAutoSave :: BackgroundPlist -> IO ()

Save (if needed) and exit. The BackgroundPlist goes to sleep.