8 | Homepage: https://github.com/fxfactorial/ocaml-plist
9 | License: BSD-3-clause
10 | OCamlVersion: >= 4.04.0
11 | AlphaFeatures: ocamlbuild_more_args
12 | Plugins: META (0.4), DevFiles (0.4)
13 | BuildTools: ocamlbuild, ocamldoc
14 | Description: Plist
15 |
16 | Library plist
17 | Path: lib
18 | Modules: Plist
19 | install: true
20 | if system(macosx)
21 | CCOpt:
22 | -g -ObjC -fno-objc-arc
23 | CClib: -framework Foundation
24 | else
25 | CCOpt:
26 | -x objective-c $(OBJC_FLAGS)
27 | -fconstant-string-class=NSConstantString
28 | CClib:
29 | -lgnustep-base -lobjc
30 | NativeOpt:
31 | -g -w +a-4-40..42-44-45-48
32 | ByteOpt: -g -w +a-4-40..42-44-45-48
33 | CSources: plist_ml_stubs.c
34 | BuildDepends: yojson
35 |
36 | Executable object_test
37 | Path: examples
38 | BuildTools:ocamlbuild
39 | install: false
40 | MainIs: e1.ml
41 | CompiledObject: native
42 | NativeOpt: -g -w +a-4-40..42-44-45-48
43 | ByteOpt: -g -w +a-4-40..42-44-45-48
44 | BuildDepends: plist
45 |
46 | SourceRepository master
47 | Type: git
48 | Location: https://github.com/fxfactorial/ocaml-plist.git
49 | Browser: https://github.com/fxfactorial/ocaml-plist
50 |
51 | Document api
52 | Title: Documentation and API reference for Plist
53 | Type: ocamlbuild (0.4)
54 | BuildTools+: ocamldoc
55 | InstallDir: $htmldir/plist
56 | PostCommand: cp docs/style.css api.docdir && cp api.docdir/* docs
57 | XOCamlbuildPath: docs
58 | XOCamlbuildModules: lib/Plist
59 | Install: true
60 | XOCamlbuildExtraArgs:
61 | "-docflags '-colorize-code -charset utf-8 -hide Plist -hide Pervasives'"
62 |
--------------------------------------------------------------------------------
/docs/index_values.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | Index of values
11 |
12 |
13 |
15 | Index of values
16 |
17 | from_file [Plist ]
20 | Raises Invalid_argument if file does not exist
21 |
22 | from_string [Plist ]
25 | Create a plist from a JSON formatted string, raises
26 | Invalid_argument if input string isn't in a Plist readable
27 | format
28 |
29 | from_yojson [Plist ]
32 | Simple helpers
33 |
34 | to_bytes [Plist ]
38 | Returns the plist as raw binary bytes, raises Invalid_argument if
39 | plist can't be turned into raw bytes
40 |
41 | to_file [Plist ]
44 | Writing a plist to file, second argument is whether to write as
45 | binary; raises Invalid_argument if trying to convert plist to
46 | binary fails, raises Failure if writing to a file location
47 | fails.
48 |
49 | to_string [Plist ]
52 | Convert a Plist into a pretty formated JSON string, raises
53 | Invalid_argument when plist can't be turned into a string
54 |
55 | to_yojson [Plist ]
59 |
60 |
--------------------------------------------------------------------------------
/setup.ml:
--------------------------------------------------------------------------------
1 | (* setup.ml generated for the first time by OASIS v0.4.8 *)
2 |
3 | (* OASIS_START *)
4 | (* DO NOT EDIT (digest: a426e2d026defb34183b787d31fbdcff) *)
5 | (******************************************************************************)
6 | (* OASIS: architecture for building OCaml libraries and applications *)
7 | (* *)
8 | (* Copyright (C) 2011-2016, Sylvain Le Gall *)
9 | (* Copyright (C) 2008-2011, OCamlCore SARL *)
10 | (* *)
11 | (* This library is free software; you can redistribute it and/or modify it *)
12 | (* under the terms of the GNU Lesser General Public License as published by *)
13 | (* the Free Software Foundation; either version 2.1 of the License, or (at *)
14 | (* your option) any later version, with the OCaml static compilation *)
15 | (* exception. *)
16 | (* *)
17 | (* This library is distributed in the hope that it will be useful, but *)
18 | (* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY *)
19 | (* or FITNESS FOR A PARTICULAR PURPOSE. See the file COPYING for more *)
20 | (* details. *)
21 | (* *)
22 | (* You should have received a copy of the GNU Lesser General Public License *)
23 | (* along with this library; if not, write to the Free Software Foundation, *)
24 | (* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *)
25 | (******************************************************************************)
26 |
27 | let () =
28 | try
29 | Topdirs.dir_directory (Sys.getenv "OCAML_TOPLEVEL_PATH")
30 | with Not_found -> ()
31 | ;;
32 | #use "topfind";;
33 | #require "oasis.dynrun";;
34 | open OASISDynRun;;
35 |
36 | let setup_t = BaseCompat.Compat_0_4.adapt_setup_t setup_t
37 | open BaseCompat.Compat_0_4
38 | (* OASIS_STOP *)
39 |
40 | let _ =
41 | BaseEnv.var_define
42 | "OBJC_FLAGS"
43 | (fun () ->
44 | let os_name =
45 | OASISExec.run_read_one_line
46 | ~ctxt:!OASISContext.default
47 | "uname"
48 | []
49 | in
50 | if os_name = "Darwin" then ""
51 | else
52 | OASISExec.run_read_one_line
53 | ~ctxt:!OASISContext.default
54 | "gnustep-config"
55 | ["--objc-flags"]
56 | )
57 | ()
58 |
59 | let () = setup ();;
60 |
--------------------------------------------------------------------------------
/docs/Plist.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Plist
13 |
14 |
15 |
17 |
18 |
19 | module Plist: sig .. end
20 | OCaml bindings to native Objective-C handling of plists; works on
21 | Linux and OS X
23 | type val from_stringstring -> plist
29 | Create a plist from a JSON formatted string, raises
30 | Invalid_argument if input string isn't in a Plist readable
31 | format
33 |
34 | val to_stringplist -> string
35 | Convert a Plist into a pretty formated JSON string, raises
36 | Invalid_argument when plist can't be turned into a string
38 |
39 | val to_filestring -> bool -> plist -> unit
40 | Writing a plist to file, second argument is whether to write as
41 | binary; raises Invalid_argument if trying to convert plist to
42 | binary fails, raises Failure if writing to a file location
43 | fails.
45 |
46 | val from_filestring -> plist
47 | Raises Invalid_argument if file does not exist
49 |
50 | val to_bytesplist -> bytes
51 | Returns the plist as raw binary bytes, raises Invalid_argument if
52 | plist can't be turned into raw bytes
54 |
55 | val from_yojsonYojson.Basic.json -> plist
56 | Simple helpers
58 |
59 | val to_yojsonplist -> Yojson.Basic.json
6 |
7 | #import
8 | #import
9 | #import
10 | #import
11 | #import
12 | #import
13 |
14 | #define NSDict(v) (*(NSMutableDictionary**)Data_custom_val(v))
15 |
16 | void release_nsdict(value this_dict)
17 | {
18 | [NSDict(this_dict) release];
19 | }
20 |
21 | long nsdict_hash(value this_dict)
22 | {
23 | return [NSDict(this_dict) hash];
24 | }
25 |
26 | static struct custom_operations nsdict_custom_ops = {
27 | .identifier = "com.hyegar.plist",
28 | .finalize = release_nsdict,
29 | .compare = NULL,
30 | .hash = nsdict_hash,
31 | .serialize = NULL,
32 | .deserialize = NULL
33 | };
34 |
35 | CAMLprim value
36 | plist_ml_from_string(value str)
37 | {
38 | CAMLparam1(str);
39 | CAMLlocal1(wrapper);
40 | NSAutoreleasePool *myPool = [[NSAutoreleasePool alloc] init];
41 |
42 | NSError *error = nil;
43 | NSData *s1 = [NSData dataWithBytes:String_val(str) length:caml_string_length(str)];
44 | NSMutableDictionary *dict =
45 | [NSJSONSerialization JSONObjectWithData:s1
46 | options:NSJSONReadingMutableContainers
47 | error:&error];
48 | if (error) {
49 | const char *e_message = [[error localizedDescription] UTF8String];
50 | [myPool drain];
51 | caml_invalid_argument(e_message);
52 | }
53 | wrapper = caml_alloc_custom(&nsdict_custom_ops, sizeof(id), 0, 1);
54 | // We need to hold onto the NSMutableDictionary
55 | [dict retain];
56 | memcpy(Data_custom_val(wrapper), &dict, sizeof(id));
57 | [myPool drain];
58 | CAMLreturn(wrapper);
59 | }
60 |
61 | CAMLprim value
62 | plist_ml_to_file(value filename, value as_binary, value plist_dict)
63 | {
64 | CAMLparam3(filename, as_binary, plist_dict);
65 | NSAutoreleasePool *myPool = [[NSAutoreleasePool alloc] init];
66 |
67 | NSError *error = nil;
68 | BOOL write_success = YES;
69 |
70 | id d = NSDict(plist_dict);
71 | NSString *filepath =
72 | [[NSString alloc] initWithBytes:String_val(filename)
73 | length:caml_string_length(filename)
74 | encoding:NSUTF8StringEncoding];
75 |
76 | if (Bool_val(as_binary)) {
77 | d = [NSPropertyListSerialization
78 | dataWithPropertyList:d
79 | format:NSPropertyListBinaryFormat_v1_0
80 | options:0
81 | error:&error];
82 | if (error) {
83 | const char *e_message = [[error localizedDescription] UTF8String];
84 | [myPool drain];
85 | caml_invalid_argument(e_message);
86 | }
87 |
88 | }
89 |
90 | caml_release_runtime_system();
91 | write_success = [d writeToFile:filepath atomically:YES];
92 | caml_acquire_runtime_system();
93 |
94 | [myPool drain];
95 |
96 | if (write_success == NO) caml_failwith("Couldn't write to file");
97 |
98 | CAMLreturn(Val_unit);
99 | }
100 |
101 | CAMLprim value
102 | plist_ml_to_string(value plist_dict)
103 | {
104 | CAMLparam1(plist_dict);
105 | CAMLlocal1(ml_string);
106 | NSAutoreleasePool *myPool = [[NSAutoreleasePool alloc] init];
107 |
108 | NSMutableDictionary *d = NSDict(plist_dict);
109 | NSError *error = nil;
110 | NSData *dump =
111 | [NSJSONSerialization dataWithJSONObject:d
112 | options:NSJSONWritingPrettyPrinted
113 | error:&error];
114 | if (error) {
115 | const char *e_message = [[error localizedDescription] UTF8String];
116 | [myPool drain];
117 | caml_invalid_argument(e_message);
118 | }
119 |
120 | NSString *s = [[NSString alloc] initWithData:dump encoding:NSUTF8StringEncoding];
121 | const size_t length = [s lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
122 |
123 | ml_string = caml_alloc_string(length);
124 | memmove(String_val(ml_string), [s UTF8String], length);
125 | [myPool drain];
126 | CAMLreturn(ml_string);
127 | }
128 |
129 | CAMLprim value
130 | plist_ml_from_file(value filename)
131 | {
132 | CAMLparam1(filename);
133 | CAMLlocal1(plist);
134 | NSAutoreleasePool *myPool = [[NSAutoreleasePool alloc] init];
135 |
136 | NSString *file_path =
137 | [[NSString alloc] initWithBytes:String_val(filename)
138 | length:caml_string_length(filename)
139 | encoding:NSUTF8StringEncoding];
140 | BOOL file_exists = [[NSFileManager defaultManager] fileExistsAtPath:file_path];
141 | if (file_exists == NO) caml_invalid_argument("File does not exist");
142 |
143 | caml_release_runtime_system();
144 | id p = [[NSDictionary alloc] initWithContentsOfFile:file_path];
145 | caml_acquire_runtime_system();
146 |
147 | plist = caml_alloc_custom(&nsdict_custom_ops, sizeof(id), 0, 1);
148 | memcpy(Data_custom_val(plist), &p, sizeof(id));
149 | // Hold onto the Dict
150 | [p retain];
151 | [myPool drain];
152 | CAMLreturn(plist);
153 | }
154 |
155 | CAMLprim value
156 | plist_ml_to_bytes(value plist)
157 | {
158 | CAMLparam1(plist);
159 | CAMLlocal1(raw_bytes);
160 | NSAutoreleasePool *myPool = [[NSAutoreleasePool alloc] init];
161 | NSError *error = nil;
162 |
163 | NSData *d = [NSPropertyListSerialization
164 | dataWithPropertyList:NSDict(plist)
165 | format:NSPropertyListBinaryFormat_v1_0
166 | options:0
167 | error:&error];
168 | if (error) {
169 | const char *e_message = [[error localizedDescription] UTF8String];
170 | [myPool drain];
171 | caml_invalid_argument(e_message);
172 | }
173 |
174 | raw_bytes = caml_alloc_string([d length]);
175 | memcpy(String_val(raw_bytes), [d bytes], [d length]);
176 | [myPool drain];
177 | CAMLreturn(raw_bytes);
178 | }
179 |
--------------------------------------------------------------------------------