test live
[gnome.introspection-doc-generator] / File.js
1 // <script type ="text/Javascript">
2 GLib = imports.gi.GLib;
3 Gio = imports.gi.Gio;
4
5 imports['String.js'].load(String);
6
7 /**
8 * @namespace File
9
10 * Library to wrap GLib and Gio basic File related methods
11
12 * usage:
13
14 * File = import.File.File;
15
16 * var contents = File.read("/tmp/test.txt");
17 *
18
19
20 */
21 var File = {
22
23     SEPARATOR : '/',
24
25     join : function () {
26         var out = "";
27         for (var i = 0; i < arguments.length; i++) {
28             if (i == 0) {
29               out += arguments[i].rtrim(File.SEPARATOR);
30             }
31             else if (i == arguments.length - 1) {
32               out += File.SEPARATOR + arguments[i].ltrim(File.SEPARATOR);
33             }
34             else {
35               out += File.SEPARATOR + arguments[i].trim(File.SEPARATOR);
36             }
37         }
38         return out;
39     },
40
41     read : function (path) {
42         var out = {};
43         GLib.file_get_contents(path, out, null, null);
44         return out['value'];
45     },
46
47     isFile : function (path) {
48       return GLib.file_test(path, GLib.FileTest.IS_REGULAR);
49     },
50     exists : function (path) {
51       return GLib.file_test(path, GLib.FileTest.EXISTS);
52     },
53     isDirectory : function (path) {
54       return GLib.file_test(path, GLib.FileTest.IS_DIR);
55     },
56
57     list : function (path) {
58         var listing = [];
59
60         var f = Gio.file_new_for_path(String(path));
61         var file_enum = f.enumerate_children(Gio.FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME, Gio.FileQueryInfoFlags.NONE, null);
62
63         var next_file = null;
64
65         while ((next_file = file_enum.next_file(null)) != null) {
66           listing.push(next_file.get_display_name());
67         }
68
69         file_enum.close(null);
70
71         listing.sort();
72
73         return listing;
74     },
75
76     mtime : function (path) {
77         var f = Gio.file_new_for_path(String(path));
78         var mtime = new GLib.TimeVal();
79
80         var info = f.query_info(Gio.FILE_ATTRIBUTE_TIME_MODIFIED, Gio.FileQueryInfoFlags.NONE, null);
81         info.get_modification_time(mtime);
82
83         return new Date(mtime.tv_sec * 1000);
84     },
85
86     canonical : function (path) {
87         var f = Gio.file_new_for_path(String(path));
88         var can = f.resolve_relative_path('');
89         return can.get_path();
90     },
91
92     write : function (path, string) {
93         var f = Gio.file_new_for_path(String(path));
94         var data_out = new Gio.DataOutputStream({base_stream:f.replace(null, false, Gio.FileCreateFlags.NONE, null)});
95         data_out.put_string(string, null);
96         data_out.close(null);
97     },
98
99     // copy files recursively from fromDir, silently ignore them if they already exist in toDir
100     silentRecursiveCopy : function (fromDir, toDir) {
101         var filesToCopy = File.recursiveListing(fromDir);
102         var srcPath, destPath, src, dest;
103
104         for (var index in filesToCopy) {
105           srcPath = File.join(String(fromDir), filesToCopy[index]);
106           destPath = File.join(String(toDir), filesToCopy[index]);
107
108           if (File.isFile(srcPath) && !File.isFile(destPath)) {
109             File.copyFile(srcPath, destPath);
110           }
111           else if (File.isDirectory(srcPath) && !File.isDirectory(destPath)) {
112             File.mkdir(destPath);
113           }
114
115         }
116     },
117
118     mkdir : function (destPath) {
119         var dest = Gio.file_new_for_path(String(destPath));
120         return dest.make_directory(null, null);
121     },
122
123     copyFile : function (srcPath, destPath) {
124         var dest = Gio.file_new_for_path(String(destPath));
125         var src = Gio.file_new_for_path(String(srcPath));
126
127         // a bit of a hack for the fact that Gio.File.copy arguments
128         // can be nulled, but not according to the GIR file
129         return src.copy(dest, Gio.FileCopyFlags.NONE);
130     },
131
132     recursiveListing : function (dir) {
133
134         function recursiveListingInternal(prefix, listing, dir) {
135           var entries = File.list(dir);
136           var next, fullPath;
137
138           for (var index in entries) {
139             next = entries[index];
140             fullPath = File.join(prefix, dir, next);
141
142             if (File.isDirectory(fullPath)) {
143               listing.push(next);
144               listing = listing.concat(recursiveListingInternal(next, [], fullPath));
145             }
146             else {
147               if (prefix) {
148                 next = File.join(prefix, next);
149               }
150               listing.push(next);
151             }
152           }
153
154           return listing;
155         }
156
157         return recursiveListingInternal('', [], dir);
158     }
159
160 };