-
Notifications
You must be signed in to change notification settings - Fork 1
/
app-settings.cabal
138 lines (134 loc) · 4.83 KB
/
app-settings.cabal
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
-- Initial app-settings.cabal generated by cabal init. For further
-- documentation, see http://haskell.org/cabal/users-guide/
name: app-settings
version: 0.2.0.12
synopsis: A library to manage application settings (INI file-like)
description:
A library to deal with application settings.
.
This library deals with read-write application settings.
You will have to specify the settings that your application
uses, their name, types and default values.
.
Setting types must implement the 'Read' and 'Show' typeclasses.
.
The settings are saved in a file in an INI-like key-value format
(without sections).
.
Reading and updating settings is done in pure code, the IO
monad is only used to load settings and save them to disk.
It is advised for the user to create a module in your project
holding settings handling.
.
You can then declare settings:
.
> fontSize :: Setting Double
> fontSize = Setting "fontSize" 14
>
> dateFormat :: Setting String
> dateFormat = Setting "dateFormat" "%x"
>
> backgroundColor :: Setting (Int, Int, Int)
> backgroundColor = Setting "backcolor" (255, 0, 0)
.
Optionally you can declare the list of all your settings,
in that case the application will also save the default
values in the configuration file, but commented out:
.
> fontSize=16
> # dateFormat="%x"
> # backcolor=(255,0,0)
.
If you do not specify the list of settings, only the
first line would be present in the configuration file.
.
With an ordinary setting, one row in the configuration file
means one setting. That setting may of course be a list
for instance. This setup works very well for shorter lists
like [1,2,3], however if you have a list of more complex
items, you will get very long lines and a configuration
file very difficult to edit by hand.
.
For these special cases there is also the 'ListSetting'
constructor:
.
> testList :: Setting [String]
> testList = ListSetting "testList" ["list1", "list2", "list3"]
.
Now the configuration file looks like that:
.
> testList_1="list1"
> testList_2="list2"
> testList_3="list3"
.
Which is much more handy for big lists. An empty list is represented
like so:
.
> testList=
.
There is also another technique that you can use if you have too long
lines: you can put line breaks in the setting values if you start the
following lines with a leading space, like so:
.
> testList=["list1",
> "list2", "list3"]
.
In that case don't use the ListSetting option. Any character after the
the leading space in the next lines will go in the setting value. Note
that the library will automatically wrap setting values longer than 80
characters when saving.
.
Once we declared the settings, we can read the configuration
from disk (and your settings module should export your wrapper
around the function offered by this library):
.
> readResult <- try $ readSettings (AutoFromAppName "test")
> case readResult of
> Right (conf, GetSetting getSetting) -> do
> let textSize = getSetting fontSize
> saveSettings emptyDefaultConfig (AutoFromAppName "test") conf
> Left (x :: SomeException) -> error "Error reading the config file!"
.
'AutoFromAppName' specifies where to save the configuration file.
And we've already covered the getSetting in this snippet, see
the 'readSettings' documentation for further information.
.
You can also look at the tests of the library on the github project for sample use.
homepage: https://github.com/emmanueltouzery/app-settings
license: BSD3
license-file: LICENSE
author: Emmanuel Touzery
maintainer: etouzery@gmail.com
-- copyright:
category: Configuration
build-type: Simple
extra-source-files: tests/*.conf tests/*.config tests/*.txt
cabal-version: >=1.10
library
exposed-modules: Data.AppSettings
other-modules: Data.Serialization,
Data.AppSettingsInternal
-- other-extensions:
build-depends: base >=4.6 && <5,
mtl >= 2.1 && <2.3,
containers >= 0.5 && <0.7,
directory >= 1.2 && < 1.4,
text >= 0.10,
parsec == 3.1.*
-- hs-source-dirs:
default-language: Haskell2010
Ghc-Options: -Wall
test-suite tests
type: exitcode-stdio-1.0
hs-source-dirs: ., tests
main-is: Tests.hs
default-language: Haskell2010
build-depends: base,
hspec,
HUnit >= 1.2 && <1.7,
mtl >= 2.1 && <2.3,
containers >= 0.5 && <0.7,
directory >= 1.2 && < 1.4,
text >= 0.10,
parsec == 3.1.*
Ghc-Options: -Wall