File: template.cc

package info (click to toggle)
subtitleeditor 0.56.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 8,880 kB
  • sloc: cpp: 26,446; makefile: 1,713; perl: 434; sh: 259; xml: 149
file content (281 lines) | stat: -rw-r--r-- 8,950 bytes parent folder | download
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
// subtitleeditor -- a tool to create or edit subtitle
//
// https://subtitleeditor.github.io/subtitleeditor/
// https://github.com/subtitleeditor/subtitleeditor/
//
// Copyright @ 2005-2018, kitone
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

#include <documents.h>
#include <extension/action.h>
#include <gtkmm_utility.h>
#include <gui/comboboxencoding.h>
#include <gui/comboboxnewline.h>
#include <gui/comboboxsubtitleformat.h>
#include <utility.h>

#include <memory>

class DialogTemplate : public Gtk::Dialog {
  public:
   DialogTemplate(BaseObjectType* cobj, const Glib::RefPtr<Gtk::Builder>& xml) : Gtk::Dialog(cobj) {
      utility::set_transient_parent(*this);

      xml->get_widget("entry-name", m_entryName);
      xml->get_widget_derived("combo-format", m_comboFormat);
      xml->get_widget_derived("combo-encoding", m_comboEncoding);
      xml->get_widget_derived("combo-newline", m_comboNewLine);

      m_comboEncoding->show_auto_detected(false);

      add_button(Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
      add_button(Gtk::Stock::SAVE_AS, Gtk::RESPONSE_OK);

      set_default_response(Gtk::RESPONSE_OK);
   }

   void set_name(const Glib::ustring& name) {
      m_entryName->set_text(name);
   }

   Glib::ustring get_name() {
      return m_entryName->get_text();
   }

   void set_charset(const Glib::ustring& charset) {
      m_comboEncoding->set_value(charset);
   }

   Glib::ustring get_charset() {
      return m_comboEncoding->get_value();
   }

   void set_format(const Glib::ustring& format) {
      m_comboFormat->set_value(format);
   }

   Glib::ustring get_format() {
      return m_comboFormat->get_value();
   }

   void set_newline(const Glib::ustring& newline) {
      m_comboNewLine->set_value(newline);
   }

   Glib::ustring get_newline() {
      return m_comboNewLine->get_value();
   }

  public:
   Gtk::Entry* m_entryName;
   ComboBoxEncoding* m_comboEncoding;
   ComboBoxSubtitleFormat* m_comboFormat;
   ComboBoxNewLine* m_comboNewLine;
};

class TemplatePlugin : public Action {
  public:
   TemplatePlugin() {
      activate();
      update_ui();
   }

   ~TemplatePlugin() {
      deactivate();
   }

   void activate() {
      se_dbg(SE_DBG_PLUGINS);

      // actions
      action_group = Gtk::ActionGroup::create("TemplatePlugin");

      action_group->add(Gtk::Action::create("template", _("_Template"), _("Save a template or use a template")));

      action_group->add(
         Gtk::Action::create("save-as-template", Gtk::Stock::SAVE_AS, _("_Save As Template"), _("Save the current document as template")),
         sigc::mem_fun(*this, &TemplatePlugin::on_save_as_template));

      // ui
      Glib::RefPtr<Gtk::UIManager> ui = get_ui_manager();

      ui->insert_action_group(action_group);

      Glib::ustring submenu = R"(
      <ui>
        <menubar name='menubar'>
          <menu name='menu-extensions' action='menu-extensions'>
            <placeholder name='placeholder'>
              <menu name='template' action='template'>
                <menuitem action='save-as-template'/>
                <separator/>
                <placeholder name='template-files'/>
              </menu>
            </placeholder>
          </menu>
        </menubar>
      </ui>
    )";

      ui_id = ui->add_ui_from_string(submenu);

      rebuild_templates_menu();
   }

   void deactivate() {
      se_dbg(SE_DBG_PLUGINS);

      Glib::RefPtr<Gtk::UIManager> ui = get_ui_manager();

      if (action_group_templates) {
         ui->remove_ui(ui_id_templates);
         ui->remove_action_group(action_group_templates);
      }
      ui->remove_ui(ui_id);
      ui->remove_action_group(action_group);
   }

   void update_ui() {
      se_dbg(SE_DBG_PLUGINS);

      bool visible = (get_current_document() != NULL);

      action_group->get_action("save-as-template")->set_sensitive(visible);
   }

   void rebuild_templates_menu() {
      Glib::RefPtr<Gtk::UIManager> ui = get_ui_manager();
      // We clean the old ui and action_group
      if (action_group_templates) {
         ui->remove_ui(ui_id_templates);
         ui->remove_action_group(action_group_templates);
      }
      // Create new ui and action_group
      action_group_templates = Gtk::ActionGroup::create("TemplatePluginFiles");
      ui->insert_action_group(action_group_templates);

      ui_id_templates = ui->new_merge_id();

      // Read the template directory
      if (initialize_template_directory() == false)
         return;

      // For each files we create an entry
      Glib::Dir dir(get_config_dir("plugins/template"));
      std::vector<Glib::ustring> files(dir.begin(), dir.end());

      for (unsigned int i = 0; i < files.size(); ++i) {
         add_ui_from_file(i, files[i]);
      }
      // Update the ui
      ui->ensure_update();
   }

   void add_ui_from_file(const guint number, const Glib::ustring& filename) {
      // We extract from the filename the label and the charset
      Glib::RefPtr<Glib::Regex> re = Glib::Regex::create("^\\[(.*)\\]\\[(.*)\\]$");
      if (re->match(filename) == false) {
         // Something wrong...
         return;
      }
      std::vector<Glib::ustring> group = re->split(filename);

      Glib::ustring label = group[1];
      Glib::ustring charset = group[2];
      Glib::ustring fullname = Glib::build_filename(get_config_dir("plugins/template"), filename);

      Glib::ustring action_name = Glib::ustring::compose("template-file-%1", number);
      Glib::ustring action_accel = "";

      action_group_templates->add(Gtk::Action::create(action_name, label),
                                  Gtk::AccelKey(action_accel),
                                  sigc::bind(sigc::mem_fun(*this, &TemplatePlugin::on_template_activate), fullname, charset));

      get_ui_manager()->add_ui(
         ui_id_templates, "/menubar/menu-extensions/placeholder/template/template-files", action_name, action_name, Gtk::UI_MANAGER_MENUITEM, false);
   }

   void on_template_activate(const Glib::ustring& path, const Glib::ustring& charset) {
      Glib::ustring uri = Glib::filename_to_uri(path);

      Document* doc = Document::create_from_file(uri, charset);
      if (doc == NULL)
         return;

      doc->setFilename(se::documents::generate_untitled_name());
      doc->setCharset(charset);
      se::documents::append(doc);
   }

   void on_save_as_template() {
      Document* current = get_current_document();
      g_return_if_fail(current);

      // create dialog
      std::unique_ptr<DialogTemplate> dialog(gtkmm_utility::get_widget_derived<DialogTemplate>(
         SE_DEV_VALUE(SE_PLUGIN_PATH_UI, SE_PLUGIN_PATH_DEV), "dialog-template-save-as.ui", "dialog-template-save-as"));

      dialog->set_name(current->getName());
      dialog->set_format(current->getFormat());
      dialog->set_newline(current->getNewLine());
      dialog->set_charset(current->getCharset());

      if (dialog->run() != Gtk::RESPONSE_OK)
         return;

      std::unique_ptr<Document> newdoc(new Document(*current));
      newdoc->setName(dialog->get_name());
      newdoc->setFormat(dialog->get_format());
      newdoc->setNewLine(dialog->get_newline());
      newdoc->setCharset(dialog->get_charset());

      Glib::ustring uri = Glib::filename_to_uri(
         Glib::build_filename(get_config_dir("plugins/template"), Glib::ustring::compose("[%1][%2]", newdoc->getName(), newdoc->getCharset())));

      if (newdoc->save(uri) == false)
         return;

      rebuild_templates_menu();
   }

   // Check if the template directory exists
   // Create if needed
   bool initialize_template_directory() {
      se_dbg(SE_DBG_PLUGINS);

      // Read the template directory
      Glib::ustring path = get_config_dir("plugins/template");
      // Already there ?
      if (Glib::file_test(path, Glib::FILE_TEST_EXISTS | Glib::FILE_TEST_IS_DIR))
         return true;
      // Needs to be created
      try {
         Glib::RefPtr<Gio::File> file = Gio::File::create_for_path(path);
         if (file && file->make_directory_with_parents())
            return true;
      } catch (...) {
      }
      return false;
   }

  protected:
   Gtk::UIManager::ui_merge_id ui_id;
   Glib::RefPtr<Gtk::ActionGroup> action_group;

   Gtk::UIManager::ui_merge_id ui_id_templates;
   Glib::RefPtr<Gtk::ActionGroup> action_group_templates;
};

REGISTER_EXTENSION(TemplatePlugin)