inkview-application.cpp

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Authors:
 *   Tavmjong Bah
 *
 * Copyright (C) 2018 Authors
 *
 * The contents of this file may be used under the GNU General Public License Version 2 or later.
 * Read the file 'COPYING' for more information.
 *
 */
 
#ifdef HAVE_CONFIG_H
# include "config.h"      // Defines ENABLE_NLS
#endif
 
#include <iostream>
#include <glibmm/i18n.h>  // Internationalization
#include <glibmm/variantdict.h>
#include <gtkmm/filechooserdialog.h>
 
#include "inkview-application.h"
#include "inkscape.h"             // Inkscape::Application
#include "inkscape-version.h"     // Inkscape version
#include "include/glibmm_version.h"
#include "inkgc/gc-core.h"        // Garbage Collecting init
#include "inkview-window.h"
#include "ui/dialog-run.h"
 
#ifdef ENABLE_NLS
// Native Language Support - shouldn't this always be used?
#include "helper/gettext.h"   // gettext init
#endif // ENABLE_NLS
 
// This is a bit confusing as there are two ways to handle command line arguments and files
// depending on if the Gio::Application::Flags::HANDLES_OPEN and/or Gio::Application::Flags::HANDLES_COMMAND_LINE
// flags are set. If the open flag is set and the command line not, the all the remainng arguments
// after calling on_handle_local_options() are assumed to be filenames.
 
InkviewApplication::InkviewApplication()
    : Gtk::Application("org.inkscape.Inkview",
                       Gio::Application::Flags::HANDLES_OPEN | // Use default file opening.
                       Gio::Application::Flags::NON_UNIQUE   ) // Allows different instances of Inkview to run at same time.
    , fullscreen(false)
    , recursive(false)
    , timer(0)
    , scale(1.0)
    , preload(false)
{
    // ==================== Initializations =====================
    // Garbage Collector
    Inkscape::GC::init();
 
#ifdef ENABLE_NLS
    // Native Language Support (shouldn't this always be used?).
    Inkscape::initialize_gettext();
#endif
 
    Glib::set_application_name(N_("Inkview - An SVG File Viewer"));  // After gettext() init.
 
#if GLIBMM_CHECK_VERSION(2,56,0)
    // Additional informational strings for --help output
    // TODO: Claims to be translated automatically, but seems broken, so pass already translated strings
    set_option_context_parameter_string(_("path1 [path2 [pathN]]"));
    set_option_context_summary(_("Open one or more SVG files (or folders containing SVG files) for viewing."));
#endif
 
    // Will automatically handle character conversions.
    // Note: OptionType::FILENAME => std::string, OptionType::STRING => Glib::ustring.
 
    // clang-format off
    add_main_option_entry(OptionType::BOOL,   "version",    'V', N_("Print Inkview version"),                       "");
    add_main_option_entry(OptionType::BOOL,   "fullscreen", 'f', N_("Launch in fullscreen mode"),                   "");
    add_main_option_entry(OptionType::BOOL,   "recursive",  'r', N_("Search folders recursively"),                  "");
    add_main_option_entry(OptionType::INT,    "timer",      't', N_("Change image every NUMBER seconds"), N_("NUMBER"));
    add_main_option_entry(OptionType::DOUBLE, "scale",      's', N_("Scale image by factor NUMBER"),      N_("NUMBER"));
    add_main_option_entry(OptionType::BOOL,   "preload",    'p', N_("Preload files"),                               "");
    // clang-format on
 
    signal_handle_local_options().connect(sigc::mem_fun(*this, &InkviewApplication::on_handle_local_options), true);
 
    // This is normally called for us... but after the "handle_local_options" signal is emitted. If
    // we want to rely on actions for handling options, we need to call it here. This appears to
    // have no unwanted side-effect. It will also trigger the call to on_startup().
    register_application();
}
 
InkviewApplication::~InkviewApplication() = default;
 
void
InkviewApplication::on_startup()
{
    Gtk::Application::on_startup();
 
    // Inkscape::Application should disappear!
    Inkscape::Application::create(true);
}
 
 
// Open document window with default document. Either this or on_open() is called.
void
InkviewApplication::on_activate()
{
    // show file chooser dialog if no files/folders are given on the command line
    // TODO: A FileChooserNative would be preferential, but offers no easy way to allow files AND folders
    Glib::ustring title = _("Select Files or Folders to view");
    Gtk::FileChooserDialog file_chooser(title + "…", Gtk::FileChooser::Action::OPEN);
    file_chooser.add_button(_("Select"), 42); // use custom response ID that is not intercepted by the file chooser
                                              // (allows to pick files AND folders)
    file_chooser.set_select_multiple();
 
    Glib::RefPtr<Gtk::FileFilter> file_filter = Gtk::FileFilter::create();
    file_filter->add_pattern("*.svg");
    file_filter->set_name(_("Scalable Vector Graphics"));
    file_chooser.add_filter(file_filter);
 
    int res = Inkscape::UI::dialog_run(file_chooser);
    if (res == 42) {
        auto files = file_chooser.get_files2();
        if (!files.empty()) {
            on_open(files, "");
        }
    }
}
 
// Open document window for each file. Either this or on_activate() is called.
void InkviewApplication::on_open(Gio::Application::type_vec_files const &files, Glib::ustring const &hint)
{
    try {
        window = new InkviewWindow(files, fullscreen, recursive, timer, scale, preload);
    } catch (InkviewWindow::NoValidFilesException const &) {
        std::cerr << _("Error") << ": " << _("No (valid) files to open.") << std::endl;
        return; // Fixme: Exit with code 1 - see https://gitlab.com/inkscape/inkscape/-/issues/270.
    }
 
    window->set_visible(true);
    add_window(*window);
}
 
// ========================= Callbacks ==========================
 
/*
 * Handle command line options callback.
 */
int
InkviewApplication::on_handle_local_options(const Glib::RefPtr<Glib::VariantDict>& options)
{
    if (!options) {
        std::cerr << "InkviewApplication::on_handle_local_options: options is null!" << std::endl;
        return -1; // Keep going
    }
 
    if (options->contains("version")) {
        std::cout << "Inkscape " << Inkscape::version_string << std::endl;
        return EXIT_SUCCESS;
    }
 
    if (options->contains("fullscreen")) {
        fullscreen = true;
    }
 
    if (options->contains("recursive")) {
        recursive = true;
    }
 
    if (options->contains("timer")) {
        options->lookup_value("timer", timer);
    }
 
    if (options->contains("scale")) {
        options->lookup_value("scale", scale);
    }
 
    if (options->contains("preload")) {
        options->lookup_value("preload", preload);
    }
 
    return -1; // Keep going
}
 
/*
  Local Variables:
  mode:c++
  c-file-style:"stroustrup"
  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  indent-tabs-mode:nil
  fill-column:99
  End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :