--- gigedit/trunk/src/gigedit/scripteditor.cpp 2016/04/22 15:55:08 2886 +++ gigedit/trunk/src/gigedit/scripteditor.cpp 2016/07/01 14:09:25 2928 @@ -7,9 +7,6 @@ #include "scripteditor.h" #include "global.h" -#if USE_LS_SCRIPTVM -# include -#endif #if !USE_LS_SCRIPTVM @@ -38,50 +35,134 @@ #endif // !USE_LS_SCRIPTVM +static Glib::RefPtr createIcon(std::string name, const Glib::RefPtr& screen) { + const int targetH = 16; + Glib::RefPtr theme = Gtk::IconTheme::get_for_screen(screen); + int w = 0; + int h = 0; // ignored + Gtk::IconSize::lookup(Gtk::ICON_SIZE_SMALL_TOOLBAR, w, h); + if (!theme->has_icon(name)) + return Glib::RefPtr(); + Glib::RefPtr pixbuf = theme->load_icon(name, w, Gtk::ICON_LOOKUP_GENERIC_FALLBACK); + if (pixbuf->get_height() != targetH) { + pixbuf = pixbuf->scale_simple(targetH, targetH, Gdk::INTERP_BILINEAR); + } + return pixbuf; +} + +static Glib::RefPtr createIcon(std::vector alternativeNames, const Glib::RefPtr& screen) { + for (int i = 0; i < alternativeNames.size(); ++i) { + Glib::RefPtr buf = createIcon(alternativeNames[i], screen); + if (buf) return buf; + } + return Glib::RefPtr(); +} + ScriptEditor::ScriptEditor() : + m_statusLabel("", Gtk::ALIGN_START), m_applyButton(_("_Apply"), true), m_cancelButton(_("_Cancel"), true) { m_script = NULL; +#if USE_LS_SCRIPTVM m_vm = NULL; +#endif + + // depending on GTK version and installed themes, there may be different + // icons, and different names for them, so for each type of icon we use, + // we provide a list of possible icon names, the first one found to be + // installed on the local system from the list will be used and loaded for + // the respective purpose (so order matters in those lists) + // + // (see https://developer.gnome.org/gtkmm/stable/namespaceGtk_1_1Stock.html for + // available icon names) + std::vector errorIconNames; + errorIconNames.push_back("dialog-error"); + errorIconNames.push_back("media-record"); + errorIconNames.push_back("process-stop"); + + std::vector warningIconNames; + warningIconNames.push_back("dialog-warning-symbolic"); + warningIconNames.push_back("dialog-warning"); + + std::vector successIconNames; + successIconNames.push_back("emblem-default"); + successIconNames.push_back("tools-check-spelling"); + + m_errorIcon = createIcon(errorIconNames, get_screen()); + m_warningIcon = createIcon(warningIconNames, get_screen()); + m_successIcon = createIcon(successIconNames, get_screen()); add(m_vbox); m_tagTable = Gtk::TextBuffer::TagTable::create(); m_keywordTag = Gtk::TextBuffer::Tag::create(); + m_keywordTag->property_foreground() = "#000000"; // black m_keywordTag->property_weight() = PANGO_WEIGHT_BOLD; m_tagTable->add(m_keywordTag); m_eventTag = Gtk::TextBuffer::Tag::create(); - m_eventTag->property_foreground() = "blue"; + m_eventTag->property_foreground() = "#07c0cf"; // cyan 1 m_eventTag->property_weight() = PANGO_WEIGHT_BOLD; m_tagTable->add(m_eventTag); m_variableTag = Gtk::TextBuffer::Tag::create(); - m_variableTag->property_foreground() = "magenta"; + m_variableTag->property_foreground() = "#790cc4"; // magenta m_tagTable->add(m_variableTag); m_functionTag = Gtk::TextBuffer::Tag::create(); - m_functionTag->property_foreground() = "cyan"; + m_functionTag->property_foreground() = "#1ba1dd"; // cyan 2 m_tagTable->add(m_functionTag); m_numberTag = Gtk::TextBuffer::Tag::create(); - m_numberTag->property_foreground() = "yellow"; + m_numberTag->property_foreground() = "#c4950c"; // yellow m_tagTable->add(m_numberTag); m_stringTag = Gtk::TextBuffer::Tag::create(); - m_stringTag->property_foreground() = "red"; + m_stringTag->property_foreground() = "#c40c0c"; // red m_tagTable->add(m_stringTag); m_commentTag = Gtk::TextBuffer::Tag::create(); - m_commentTag->property_foreground() = "gray"; + m_commentTag->property_foreground() = "#9c9c9c"; // gray m_tagTable->add(m_commentTag); m_preprocTag = Gtk::TextBuffer::Tag::create(); - m_preprocTag->property_foreground() = "green"; + m_preprocTag->property_foreground() = "#2f8a33"; // green m_tagTable->add(m_preprocTag); + m_errorTag = Gtk::TextBuffer::Tag::create(); + m_errorTag->property_background() = "#ff9393"; // red + m_tagTable->add(m_errorTag); + + m_warningTag = Gtk::TextBuffer::Tag::create(); + m_warningTag->property_background() = "#fffd7c"; // yellow + m_tagTable->add(m_warningTag); + + // create menu + m_actionGroup = Gtk::ActionGroup::create(); + m_actionGroup->add(Gtk::Action::create("MenuScript", _("_Script"))); + m_actionGroup->add(Gtk::Action::create("Apply", _("_Apply")), + Gtk::AccelKey("s"), + sigc::mem_fun(*this, &ScriptEditor::onButtonApply)); + m_actionGroup->add(Gtk::Action::create("Close", _("_Close")), + Gtk::AccelKey("q"), + sigc::mem_fun(*this, &ScriptEditor::onButtonCancel)); + m_uiManager = Gtk::UIManager::create(); + m_uiManager->insert_action_group(m_actionGroup); + add_accel_group(m_uiManager->get_accel_group()); + m_uiManager->add_ui_from_string( + "" + " " + " " + " " + " " + " " + " " + " " + "" + ); + m_textBuffer = Gtk::TextBuffer::create(m_tagTable); m_textView.set_buffer(m_textBuffer); { @@ -100,6 +181,9 @@ } m_scrolledWindow.add(m_textView); m_scrolledWindow.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC); + + Gtk::Widget* menuBar = m_uiManager->get_widget("/MenuBar"); + m_vbox.pack_start(*menuBar, Gtk::PACK_SHRINK); m_vbox.pack_start(m_scrolledWindow); m_buttonBox.set_layout(Gtk::BUTTONBOX_END); @@ -108,7 +192,22 @@ m_applyButton.set_can_default(); m_applyButton.set_sensitive(false); m_applyButton.grab_focus(); - m_vbox.pack_start(m_buttonBox, Gtk::PACK_SHRINK); + +#if GTKMM_MAJOR_VERSION >= 3 + m_statusImage.set_margin_left(6); + m_statusImage.set_margin_right(6); +#else + m_statusHBox.set_spacing(6); +#endif + + m_statusHBox.pack_start(m_statusImage, Gtk::PACK_SHRINK); + m_statusHBox.pack_start(m_statusLabel); + m_statusHBox.show_all_children(); + + m_footerHBox.pack_start(m_statusHBox); + m_footerHBox.pack_start(m_buttonBox, Gtk::PACK_SHRINK); + + m_vbox.pack_start(m_footerHBox, Gtk::PACK_SHRINK); m_applyButton.signal_clicked().connect( sigc::mem_fun(*this, &ScriptEditor::onButtonApply) @@ -134,14 +233,18 @@ sigc::mem_fun(*this, &ScriptEditor::onWindowHide) ); - show_all_children(); + signal_delete_event().connect( + sigc::mem_fun(*this, &ScriptEditor::onWindowDelete) + ); - resize(460,300); + show_all_children(); } ScriptEditor::~ScriptEditor() { printf("ScriptEditor destruct\n"); +#if USE_LS_SCRIPTVM if (m_vm) delete m_vm; +#endif } void ScriptEditor::setScript(gig::Script* script) { @@ -160,8 +263,12 @@ } void ScriptEditor::onTextInserted(const Gtk::TextBuffer::iterator& itEnd, const Glib::ustring& txt, int length) { + //printf("onTextInserted()\n"); #if USE_LS_SCRIPTVM + m_textBuffer->remove_all_tags(m_textBuffer->begin(), m_textBuffer->end()); updateSyntaxHighlightingByVM(); + updateParserIssuesByVM(); + updateStatusBar(); #else //printf("inserted %d\n", length); Gtk::TextBuffer::iterator itStart = itEnd; @@ -209,6 +316,22 @@ #if USE_LS_SCRIPTVM +LinuxSampler::ScriptVM* ScriptEditor::GetScriptVM() { + if (!m_vm) m_vm = LinuxSampler::ScriptVMFactory::Create("gig"); + return m_vm; +} + +static void getIteratorsForIssue(Glib::RefPtr& txtbuf, const LinuxSampler::ParserIssue& issue, Gtk::TextBuffer::iterator& start, Gtk::TextBuffer::iterator& end) { + start = txtbuf->get_iter_at_line_index(issue.firstLine - 1, issue.firstColumn - 1); + end = start; + end.forward_lines(issue.lastLine - issue.firstLine); + end.forward_chars( + (issue.lastLine != issue.firstLine) + ? issue.lastColumn - 1 + : issue.lastColumn - issue.firstColumn + 1 + ); +} + static void applyCodeTag(Glib::RefPtr& txtbuf, const LinuxSampler::VMSourceToken& token, Glib::RefPtr& tag) { Gtk::TextBuffer::iterator itStart = txtbuf->get_iter_at_line_index(token.firstLine(), token.firstColumn()); @@ -218,13 +341,17 @@ txtbuf->apply_tag(tag, itStart, itEnd); } +static void applyCodeTag(Glib::RefPtr& txtbuf, const LinuxSampler::ParserIssue& issue, Glib::RefPtr& tag) { + Gtk::TextBuffer::iterator itStart, itEnd; + getIteratorsForIssue(txtbuf, issue, itStart, itEnd); + txtbuf->apply_tag(tag, itStart, itEnd); +} + void ScriptEditor::updateSyntaxHighlightingByVM() { - if (!m_vm) m_vm = new LinuxSampler::ScriptVM(); + GetScriptVM(); const std::string s = m_textBuffer->get_text(); std::vector tokens = m_vm->syntaxHighlighting(s); - m_textBuffer->remove_all_tags(m_textBuffer->begin(), m_textBuffer->end()); - for (int i = 0; i < tokens.size(); ++i) { const LinuxSampler::VMSourceToken& token = tokens[i]; @@ -251,12 +378,109 @@ } } +void ScriptEditor::updateParserIssuesByVM() { + GetScriptVM(); + const std::string s = m_textBuffer->get_text(); + LinuxSampler::VMParserContext* parserContext = m_vm->loadScript(s); + m_issues = parserContext->issues(); + m_errors = parserContext->errors(); + m_warnings = parserContext->warnings(); + + for (int i = 0; i < m_issues.size(); ++i) { + const LinuxSampler::ParserIssue& issue = m_issues[i]; + + if (issue.isErr()) { + applyCodeTag(m_textBuffer, issue, m_errorTag); + } else if (issue.isWrn()) { + applyCodeTag(m_textBuffer, issue, m_warningTag); + } + } + + delete parserContext; +} + +void ScriptEditor::updateIssueTooltip(GdkEventMotion* e) { + int x, y; + m_textView.window_to_buffer_coords(Gtk::TEXT_WINDOW_TEXT, int(e->x), int(e->y), x, y); + + Gtk::TextBuffer::iterator it; + m_textView.get_iter_at_location(it, x, y); + + const int line = it.get_line(); + const int column = it.get_line_offset(); + + //printf("mouse at l%d c%d\n", line, column); + + for (int i = 0; i < m_issues.size(); ++i) { + const LinuxSampler::ParserIssue& issue = m_issues[i]; + const int firstLine = issue.firstLine - 1; + const int firstColumn = issue.firstColumn - 1; + const int lastLine = issue.lastLine - 1; + const int lastColumn = issue.lastColumn - 1; + if (firstLine <= line && line <= lastLine && + (firstLine != line || firstColumn <= column) && + (lastLine != line || lastColumn >= column)) + { + m_textView.set_tooltip_markup( + (issue.isErr() ? "ERROR: " : "Warning: ") + + issue.txt + ); + return; + } + } + + m_textView.set_tooltip_markup(""); +} + +static std::string warningsCountTxt(const std::vector warnings) { + std::string txt = "" + ToString(warnings.size()); + txt += (warnings.size() == 1) ? " Warning" : " Warnings"; + txt += ""; + return txt; +} + +static std::string errorsCountTxt(const std::vector errors) { + std::string txt = "" + ToString(errors.size()); + txt += (errors.size() == 1) ? " Error" : " Errors"; + txt += ""; + return txt; +} + +void ScriptEditor::updateStatusBar() { + // update status text + std::string txt; + if (m_issues.empty()) { + txt = "No issues with this script."; + } else { + const char* txtWontLoad = ". Sampler won't load instruments using this script!"; + txt = "There "; + txt += (m_errors.size() <= 1 && m_warnings.size() <= 1) ? "is " : "are "; + if (m_errors.empty()) { + txt += warningsCountTxt(m_warnings) + ". Script will load, but might not behave as expected!"; + } else if (m_warnings.empty()) { + txt += errorsCountTxt(m_errors) + txtWontLoad; + } else { + txt += errorsCountTxt(m_errors) + " and " + + warningsCountTxt(m_warnings) + txtWontLoad; + } + } + m_statusLabel.set_markup(txt); + + // update status icon + m_statusImage.set( + m_issues.empty() ? m_successIcon : !m_errors.empty() ? m_errorIcon : m_warningIcon + ); +} + #endif // USE_LS_SCRIPTVM void ScriptEditor::onTextErased(const Gtk::TextBuffer::iterator& itStart, const Gtk::TextBuffer::iterator& itEnd) { //printf("erased\n"); #if USE_LS_SCRIPTVM + m_textBuffer->remove_all_tags(m_textBuffer->begin(), m_textBuffer->end()); updateSyntaxHighlightingByVM(); + updateParserIssuesByVM(); + updateStatusBar(); #else Gtk::TextBuffer::iterator itStart2 = itStart; if (itStart2.inside_word() || itStart2.ends_word()) @@ -269,16 +493,72 @@ #endif // USE_LS_SCRIPTVM } +bool ScriptEditor::on_motion_notify_event(GdkEventMotion* e) { +#if USE_LS_SCRIPTVM + //TODO: event throttling would be a good idea here + updateIssueTooltip(e); +#endif + return ManagedWindow::on_motion_notify_event(e); +} + +bool ScriptEditor::onWindowDelete(GdkEventAny* e) { + //printf("onWindowDelete\n"); + + if (!isModified()) return false; // propagate event further (which will close this window) + + gchar* msg = g_strdup_printf(_("Apply changes to instrument script \"%s\" before closing?"), + m_script->Name.c_str()); + Gtk::MessageDialog dialog(*this, msg, false, Gtk::MESSAGE_WARNING, Gtk::BUTTONS_NONE); + g_free(msg); + dialog.set_secondary_text(_("If you close without applying, your changes will be lost.")); + dialog.add_button(_("Close _Without Applying"), Gtk::RESPONSE_NO); + dialog.add_button(_("_Cancel"), Gtk::RESPONSE_CANCEL); + dialog.add_button(_("_Apply"), Gtk::RESPONSE_YES); + dialog.set_default_response(Gtk::RESPONSE_YES); + int response = dialog.run(); + dialog.hide(); + + // user decided to close script editor without saving + if (response == Gtk::RESPONSE_NO) + return false; // propagate event further (which will close this window) + + // user cancelled dialog, thus don't close script editor + if (response == Gtk::RESPONSE_CANCEL) { + show(); + return true; // drop event (prevents closing this window) + } + + // user wants to apply the changes, afterwards close window + if (response == Gtk::RESPONSE_YES) { + onButtonApply(); + return false; // propagate event further (which will close this window) + } + + // should never ever make it to this point actually + return false; +} + +bool ScriptEditor::isModified() const { + return m_textBuffer->get_modified(); +} + void ScriptEditor::onModifiedChanged() { - m_applyButton.set_sensitive( m_textBuffer->get_modified() ); + m_applyButton.set_sensitive(isModified()); +#if USE_LS_SCRIPTVM + updateStatusBar(); +#endif } void ScriptEditor::onButtonCancel() { + bool dropEvent = onWindowDelete(NULL); + if (dropEvent) return; hide(); } void ScriptEditor::onButtonApply() { + signal_script_to_be_changed.emit(m_script); m_script->SetScriptAsText(m_textBuffer->get_text()); + signal_script_changed.emit(m_script); m_textBuffer->set_modified(false); }