diff options
| -rw-r--r-- | Makefile-modules.am | 1 | ||||
| -rw-r--r-- | modules/modules.gresource.xml | 1 | ||||
| -rw-r--r-- | modules/package.js | 247 |
3 files changed, 249 insertions, 0 deletions
diff --git a/Makefile-modules.am b/Makefile-modules.am index 20bbd44d..4b6e356d 100644 --- a/Makefile-modules.am +++ b/Makefile-modules.am @@ -1,5 +1,6 @@ NATIVE_MODULES = libconsole.la libsystem.la libmodules_resources.la + if ENABLE_CAIRO NATIVE_MODULES += libcairoNative.la endif diff --git a/modules/modules.gresource.xml b/modules/modules.gresource.xml index 16a91c62..8d2849cd 100644 --- a/modules/modules.gresource.xml +++ b/modules/modules.gresource.xml @@ -18,5 +18,6 @@ <file>modules/jsUnit.js</file> <file>modules/signals.js</file> <file>modules/format.js</file> + <file>modules/package.js</file> </gresource> </gresources> diff --git a/modules/package.js b/modules/package.js new file mode 100644 index 00000000..fa1d5a82 --- /dev/null +++ b/modules/package.js @@ -0,0 +1,247 @@ +// Copyright 2012 Giovanni Campagna +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to +// deal in the Software without restriction, including without limitation the +// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +// sell copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in +// all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +// IN THE SOFTWARE. + +/** + * This module provides a set of convenience APIs for building packaged + * applications. + */ + +const GLib = imports.gi.GLib; +const GIRepository = imports.gi.GIRepository; +const Gio = imports.gi.Gio; +const System = imports.system; + +const Gettext = imports.gettext; + +/*< public >*/ +var name; +var version; +var prefix; +var datadir; +var libdir; +var pkgdatadir; +var pkglibdir; +var moduledir; +var localedir; + +/*< private >*/ +let _pkgname; +let _base; + +function _findEffectiveEntryPointName() { + let entryPoint = System.programInvocationName; + while (GLib.file_test(entryPoint, GLib.FileTest.IS_SYMLINK)) + entryPoint = GLib.file_read_link(entryPoint); + + return GLib.path_get_basename(entryPoint); +} + +function _runningFromSource() { + let binary = Gio.File.new_for_path(System.programInvocationName); + let sourceBinary = Gio.File.new_for_path('./src/' + name); + return binary.equal(sourceBinary); +} + +function _makeNamePath(name) { + return '/' + name.replace('.', '/', 'g'); +} + +/** + * init: + * @params: package parameters + * + * Initialize directories and global variables. Must be called + * before any of other API in Package is used. + * @params must be an object with at least the following keys: + * - name: the package name ($(PACKAGE_NAME) in autotools, + * eg. org.foo.Bar) + * - version: the package version + * - prefix: the installation prefix + * + * init() will take care to check if the program is running from + * the source directory or not, by looking for a 'src' directory. + * + * At the end, the global variable 'pkg' will contain the + * Package module (imports.package). Additionally, the following + * module variables will be available: + * - name: the base name of the entry point (eg. org.foo.Bar.App) + * - version: same as in @params + * - prefix: the installation prefix (as passed in @params) + * - datadir, libdir: the final datadir and libdir when installed; + * usually, these would be prefix + '/share' and + * and prefix + '/lib' (or '/lib64') + * - pkgdatadir: the directory to look for private data files, such as + * images, stylesheets and UI definitions; + * this will be datadir + name when installed and + * './data' when running from the source tree + * - pkglibdir: the directory to look for private typelibs and C + * libraries; + * this will be libdir + name when installed and + * './lib' when running from the source tree + * - moduledir: the directory to look for JS modules; + * this will be pkglibdir when installed and + * './src' when running from the source tree + * - localedir: the directory containing gettext translation files; + * this will be datadir + '/locale' when installed + * and './po' in the source tree + * + * All paths are absolute and will not end with '/'. + * + * As a side effect, init() calls GLib.set_prgname(). + */ +function init(params) { + window.pkg = imports.package; + _pkgname = params.name; + name = _findEffectiveEntryPointName(); + version = params.version; + + // Must call it first, because it can only be called + // once, and other library calls might have it as a + // side effect + GLib.set_prgname(name); + + prefix = params.prefix; + libdir = params.libdir; + datadir = GLib.build_filenamev([prefix, 'share']); + let libpath, girpath; + + if (_runningFromSource()) { + log('Running from source tree, using local files'); + // Running from source directory + _base = GLib.get_current_dir(); + pkglibdir = GLib.build_filenamev([_base, 'lib']); + libpath = GLib.build_filenamev([pkglibdir, '.libs']); + girpath = pkglibdir; + pkgdatadir = GLib.build_filenamev([_base, 'data']); + localedir = GLib.build_filenamev([_base, 'po']); + moduledir = GLib.build_filenamev([_base, 'src']); + } else { + _base = prefix; + pkglibdir = GLib.build_filenamev([libdir, _pkgname]); + libpath = pkglibdir; + girpath = GLib.build_filenamev([pkglibdir, 'girepository-1.0']); + pkgdatadir = GLib.build_filenamev([datadir, _pkgname]); + localedir = GLib.build_filenamev([datadir, 'locale']); + + try { + let resource = Gio.Resource.load(GLib.build_filenamev([pkgdatadir, + name + '.src.gresource'])); + resource._register(); + + moduledir = 'resource://' + _makeNamePath(name) + '/js'; + } catch(e) { + moduledir = pkgdatadir; + } + } + + imports.searchPath.unshift(moduledir); + GIRepository.Repository.prepend_search_path(girpath); + GIRepository.Repository.prepend_library_path(libpath); + + try { + let resource = Gio.Resource.load(GLib.build_filenamev([pkgdatadir, + name + '.data.gresource'])); + resource._register(); + } catch(e) { } +} + +/** + * start: + * @params: see init() + * + * This is a convenience function if your package has a + * single entry point. + * You must define a main(ARGV) function inside a main.js + * module in moduledir. + */ +function start(params) { + init(params); + run(imports.main); +} + +/** + * run: + * @module: the module to run + * + * This is the function to use if you want to have multiple + * entry points in one package. + * You must define a main(ARGV) function inside the passed + * in module, and then the launcher would be + * + * imports.package.init(...); + * imports.package.run(imports.entrypoint); + */ +function run(module) { + return module.main([System.programInvocationName].concat(ARGV)); +} + +/** + * require: + * @libs: the external dependencies to import + * + * Mark a dependency on a specific version of one or more + * external GI typelibs. + * @libs must be an object whose keys are a typelib name, + * and values are the respective version. The empty string + * indicates any version. + */ +function require(libs) { + for (let l in libs) { + let version = libs[l]; + + if (version != '') + imports.gi.versions[l] = version; + + try { + imports.gi[l]; + } catch(e) { + printerr('Unsatisfied dependency: ' + e.message); + System.exit(1); + } + } +} + +function initGettext() { + Gettext.bindtextdomain(_pkgname, localedir); + Gettext.textdomain(_pkgname); + + let gettext = imports.gettext; + window._ = gettext.gettext; + window.C_ = gettext.pgettext; + window.N_ = function(x) { return x; } +} + +function initFormat() { + let format = imports.format; + String.prototype.format = format.format; +} + +function initSubmodule(name) { + if (moduledir != pkgdatadir) { + // Running from source tree, add './name' to search paths + + let submoduledir = GLib.build_filenamev([_base, name]); + let libpath = GLib.build_filenamev([submoduledir, '.libs']); + GIRepository.Repository.prepend_search_path(submoduledir); + GIRepository.Repository.prepend_library_path(libpath); + } else { + // Running installed, submodule is in $(pkglibdir), nothing to do + } +} |