gtk2_ardour/luawindow.cc

   1 /*
   2     Copyright (C) 2016 Robin Gareus <robin@gareus.org>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifdef PLATFORM_WINDOWS
  21 #define random() rand()
  22 #endif
  23
  24 #ifdef WAF_BUILD
  25 #include "gtk2ardour-config.h"
  26 #endif
  27
  28 #include "pbd/gstdio_compat.h"
  29 #include <glibmm/fileutils.h>
  30 #include <gtkmm/messagedialog.h>
  31
  32 #include "pbd/basename.h"
  33 #include "pbd/file_utils.h"
  34 #include "pbd/md5.h"
  35
  36 #include "gtkmm2ext/gtk_ui.h"
  37 #include "gtkmm2ext/pane.h"
  38 #include "gtkmm2ext/utils.h"
  39 #include "gtkmm2ext/window_title.h"
  40
  41 #include "ardour/filesystem_paths.h"
  42 #include "ardour/luabindings.h"
  43 #include "LuaBridge/LuaBridge.h"
  44
  45 #include "ardour_ui.h"
  46 #include "gui_thread.h"
  47 #include "luainstance.h"
  48 #include "luawindow.h"
  49 #include "public_editor.h"
  50 #include "tooltips.h"
  51 #include "utils.h"
  52 #include "utils_videotl.h"
  53
  54 #include "pbd/i18n.h"
  55
  56 using namespace ARDOUR;
  57 using namespace ARDOUR_UI_UTILS;
  58 using namespace PBD;
  59 using namespace Gtk;
  60 using namespace Glib;
  61 using namespace Gtkmm2ext;
  62 using namespace std;
  63
  64
  65 inline LuaWindow::BufferFlags operator| (const LuaWindow::BufferFlags& a, const LuaWindow::BufferFlags& b) {
  66         return static_cast<LuaWindow::BufferFlags> (static_cast <int>(a) | static_cast<int> (b));
  67 }
  68
  69 inline LuaWindow::BufferFlags operator|= (LuaWindow::BufferFlags& a, const LuaWindow::BufferFlags& b) {
  70         return a = static_cast<LuaWindow::BufferFlags> (static_cast <int>(a) | static_cast<int> (b));
  71 }
  72
  73 inline LuaWindow::BufferFlags operator&= (LuaWindow::BufferFlags& a, const LuaWindow::BufferFlags& b) {
  74         return a = static_cast<LuaWindow::BufferFlags> (static_cast <int>(a) & static_cast<int> (b));
  75 }
  76
  77 LuaWindow* LuaWindow::_instance = 0;
  78
  79 LuaWindow*
  80 LuaWindow::instance ()
  81 {
  82         if (!_instance) {
  83                 _instance  = new LuaWindow;
  84         }
  85
  86         return _instance;
  87 }
  88
  89 LuaWindow::LuaWindow ()
  90         : Window (Gtk::WINDOW_TOPLEVEL)
  91         , VisibilityTracker (*((Gtk::Window*) this))
  92         , lua (0)
  93         , _visible (false)
  94         , _menu_scratch (0)
  95         , _menu_snippet (0)
  96         , _menu_actions (0)
  97         , _btn_run (_("Run"))
  98         , _btn_clear (_("Clear Output"))
  99         , _btn_open (_("Import"))
 100         , _btn_save (_("Save"))
 101         , _btn_delete (_("Delete"))
 102         , _btn_revert (_("Revert"))
 103         , _current_buffer ()
 104 {
 105         set_name ("Lua");
 106
 107         reinit_lua ();
 108         update_title ();
 109         set_wmclass (X_("ardour_mixer"), PROGRAM_NAME);
 110
 111         script_select.disable_scrolling ();
 112
 113         set_border_width (0);
 114
 115         outtext.set_editable (false);
 116         outtext.set_wrap_mode (Gtk::WRAP_WORD);
 117         outtext.set_cursor_visible (false);
 118
 119         signal_delete_event().connect (sigc::mem_fun (*this, &LuaWindow::hide_window));
 120         signal_configure_event().connect (sigc::mem_fun (*ARDOUR_UI::instance(), &ARDOUR_UI::configure_handler));
 121
 122         _btn_run.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::run_script));
 123         _btn_clear.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::clear_output));
 124         _btn_open.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::import_script));
 125         _btn_save.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::save_script));
 126         _btn_delete.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::delete_script));
 127         _btn_revert.signal_clicked.connect (sigc::mem_fun(*this, &LuaWindow::revert_script));
 128
 129         _btn_open.set_sensitive (false); // TODO
 130         _btn_save.set_sensitive (false);
 131         _btn_delete.set_sensitive (false);
 132         _btn_revert.set_sensitive (false);
 133
 134         // layout
 135
 136         Gtk::ScrolledWindow *scrollin = manage (new Gtk::ScrolledWindow);
 137         scrollin->set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
 138         scrollin->add (entry);
 139         scrollout.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_ALWAYS);
 140         scrollout.add (outtext);
 141
 142         entry.set_name ("ArdourLuaEntry");
 143         outtext.set_name ("ArdourLuaEntry");
 144
 145         Gtk::HBox *hbox = manage (new HBox());
 146
 147         hbox->pack_start (_btn_run, false, false, 2);
 148         hbox->pack_start (_btn_clear, false, false, 2);
 149         hbox->pack_start (_btn_open, false, false, 2);
 150         hbox->pack_start (_btn_save, false, false, 2);
 151         hbox->pack_start (_btn_delete, false, false, 2);
 152         hbox->pack_start (_btn_revert, false, false, 2);
 153         hbox->pack_start (script_select, false, false, 2);
 154
 155         Gtk::VBox *vbox = manage (new VBox());
 156         vbox->pack_start (*scrollin, true, true, 0);
 157         vbox->pack_start (*hbox, false, false, 2);
 158
 159         Gtkmm2ext::VPane *vpane = manage (new Gtkmm2ext::VPane ());
 160         vpane->add (*vbox);
 161         vpane->add (scrollout);
 162         vpane->set_divider (0, 0.75);
 163
 164         vpane->show_all ();
 165         add (*vpane);
 166         set_size_request (640, 480); // XXX
 167         ARDOUR_UI_UTILS::set_tooltip (script_select, _("Select Editor Buffer"));
 168
 169         setup_buffers ();
 170         LuaScripting::instance().scripts_changed.connect (*this, invalidator (*this), boost::bind (&LuaWindow::refresh_scriptlist, this), gui_context());
 171
 172         Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
 173         _script_changed_connection = tb->signal_changed().connect (sigc::mem_fun(*this, &LuaWindow::script_changed));
 174 }
 175
 176 LuaWindow::~LuaWindow ()
 177 {
 178         delete lua;
 179 }
 180
 181 void
 182 LuaWindow::show_window ()
 183 {
 184         present();
 185         _visible = true;
 186 }
 187
 188 bool
 189 LuaWindow::hide_window (GdkEventAny *ev)
 190 {
 191         if (!_visible) return 0;
 192         _visible = false;
 193         return just_hide_it (ev, static_cast<Gtk::Window *>(this));
 194 }
 195
 196 void LuaWindow::reinit_lua ()
 197 {
 198         ENSURE_GUI_THREAD (*this, &LuaWindow::session_going_away);
 199         delete lua;
 200         lua = new LuaState();
 201         lua->Print.connect (sigc::mem_fun (*this, &LuaWindow::append_text));
 202
 203         lua_State* L = lua->getState();
 204         LuaInstance::register_classes (L);
 205         luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
 206         lua_setglobal (L, "Editor");
 207 }
 208
 209 void LuaWindow::set_session (Session* s)
 210 {
 211         SessionHandlePtr::set_session (s);
 212         if (!_session) {
 213                 return;
 214         }
 215
 216         update_title ();
 217         _session->DirtyChanged.connect (_session_connections, invalidator (*this), boost::bind (&LuaWindow::update_title, this), gui_context());
 218
 219         lua_State* L = lua->getState();
 220         LuaBindings::set_session (L, _session);
 221 }
 222
 223 void
 224 LuaWindow::session_going_away ()
 225 {
 226         ENSURE_GUI_THREAD (*this, &LuaWindow::session_going_away);
 227         reinit_lua (); // drop state (all variables, session references)
 228
 229         SessionHandlePtr::session_going_away ();
 230         _session = 0;
 231         update_title ();
 232
 233         lua_State* L = lua->getState();
 234         LuaBindings::set_session (L, _session);
 235 }
 236
 237 void
 238 LuaWindow::update_title ()
 239 {
 240         if (_session) {
 241                 string n;
 242
 243                 if (_session->snap_name() != _session->name()) {
 244                         n = _session->snap_name ();
 245                 } else {
 246                         n = _session->name ();
 247                 }
 248
 249                 if (_session->dirty ()) {
 250                         n = "*" + n;
 251                 }
 252
 253                 WindowTitle title (n);
 254                 title += S_("Window|Lua");
 255                 title += Glib::get_application_name ();
 256                 set_title (title.get_string());
 257
 258         } else {
 259                 WindowTitle title (S_("Window|Lua"));
 260                 title += Glib::get_application_name ();
 261                 set_title (title.get_string());
 262         }
 263 }
 264
 265 void
 266 LuaWindow::scroll_to_bottom ()
 267 {
 268         Gtk::Adjustment *adj;
 269         adj = scrollout.get_vadjustment();
 270         adj->set_value (MAX(0,(adj->get_upper() - adj->get_page_size())));
 271 }
 272
 273 void
 274 LuaWindow::run_script ()
 275 {
 276         Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
 277         std::string script = tb->get_text();
 278         const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
 279         if (bytecode.empty()) {
 280                 // plain script or faulty script -- run directly
 281                 try {
 282                         lua->do_command ("function ardour () end");
 283                         if (0 == lua->do_command (script)) {
 284                                 append_text ("> OK");
 285                         }
 286                 } catch (luabridge::LuaException const& e) {
 287                         append_text (string_compose (_("LuaException: %1"), e.what()));
 288                 }
 289         } else {
 290                 // script with factory method
 291                 try {
 292                         lua_State* L = lua->getState();
 293                         lua->do_command ("function ardour () end");
 294
 295                         LuaScriptParamList args = LuaScriptParams::script_params (script, "action_param", false);
 296                         luabridge::LuaRef tbl_arg (luabridge::newTable(L));
 297                         LuaScriptParams::params_to_ref (&tbl_arg, args);
 298                         lua->do_command (script); // register "factory"
 299                         luabridge::LuaRef lua_factory = luabridge::getGlobal (L, "factory");
 300                         if (lua_factory.isFunction()) {
 301                                 lua_factory(tbl_arg)();
 302                         }
 303                         lua->do_command ("factory = nil;");
 304                 } catch (luabridge::LuaException const& e) {
 305                         append_text (string_compose (_("LuaException: %1"), e.what()));
 306                 }
 307         }
 308 }
 309
 310 void
 311 LuaWindow::append_text (std::string s)
 312 {
 313         Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
 314         tb->insert (tb->end(), s + "\n");
 315         scroll_to_bottom ();
 316         Gtkmm2ext::UI::instance()->flush_pending (0.05);
 317 }
 318
 319 void
 320 LuaWindow::clear_output ()
 321 {
 322         Glib::RefPtr<Gtk::TextBuffer> tb (outtext.get_buffer());
 323         tb->set_text ("");
 324 }
 325
 326 void
 327 LuaWindow::edit_script (const std::string& name, const std::string& script)
 328 {
 329         ScriptBuffer* sb = new LuaWindow::ScriptBuffer (name);
 330         sb->script = script;
 331         script_buffers.push_back (ScriptBufferPtr (sb));
 332         script_selection_changed (script_buffers.back ());
 333         refresh_scriptlist ();
 334         show_window ();
 335 }
 336
 337 void
 338 LuaWindow::new_script ()
 339 {
 340         char buf[32];
 341         snprintf (buf, sizeof (buf), "#%d", count_scratch_buffers () + 1);
 342         script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer (buf)));
 343         script_selection_changed (script_buffers.back ());
 344         refresh_scriptlist ();
 345 }
 346
 347 void
 348 LuaWindow::delete_script ()
 349 {
 350         assert ((_current_buffer->flags & Buffer_Scratch) || !(_current_buffer->flags & Buffer_ReadOnly));
 351         bool refresh = false;
 352         bool neednew = true;
 353         if (_current_buffer->flags & Buffer_HasFile) {
 354                 if (0 == ::g_unlink (_current_buffer->path.c_str())) {
 355                         append_text (X_("> ") + string_compose (_("Deleted %1"), _current_buffer->path));
 356                         refresh = true;
 357                 } else {
 358                         append_text (X_("> ") + string_compose (_("Failed to delete %1"), _current_buffer->path));
 359                 }
 360         }
 361         for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
 362                 if ((*i) == _current_buffer) {
 363                         script_buffers.erase (i);
 364                         break;
 365                 }
 366         }
 367
 368         for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
 369                 if ((*i)->flags & Buffer_Scratch) {
 370                         script_selection_changed (*i);
 371                         neednew = false;
 372                 }
 373         }
 374         if (neednew) {
 375                 new_script ();
 376         }
 377         if (refresh) {
 378                 LuaScripting::instance ().refresh (true);
 379         }
 380 }
 381
 382 void
 383 LuaWindow::revert_script ()
 384 {
 385         _current_buffer->flags &= BufferFlags(~Buffer_Valid);
 386         script_selection_changed (_current_buffer, true);
 387 }
 388
 389 void
 390 LuaWindow::import_script ()
 391 {
 392         // TODO: dialog to select file or enter URL
 393         // TODO convert a few URL (eg. pastebin) to raw.
 394 #if 0
 395         char *url = "http://pastebin.com/raw/3UMkZ6nV";
 396         char *rv = ArdourCurl::http_get (url, 0);
 397         if (rv) {
 398                 new_script ();
 399                 Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
 400                 tb->set_text (rv);
 401                 _current_buffer->flags &= BufferFlags(~Buffer_Dirty);
 402                 update_gui_state ();
 403         }
 404         free (rv);
 405 #endif
 406 }
 407
 408 void
 409 LuaWindow::save_script ()
 410 {
 411         Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
 412         std::string script = tb->get_text();
 413         std::string msg = "Unknown error";
 414
 415         std::string path;
 416         LuaScriptInfoPtr lsi = LuaScripting::script_info (script);
 417         ScriptBuffer & sb (*_current_buffer);
 418
 419         assert (sb.flags & Buffer_Dirty);
 420
 421         // 1) check if it has a valid header and factory
 422         const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
 423         if (bytecode.empty()) {
 424                 msg = _("Missing script header.\nThe script requires an '{ardour}' info table and a 'factory' function.");
 425                 goto errorout;
 426         }
 427
 428         if (!LuaScripting::try_compile (script, LuaScriptParams::script_params (script, "action_param", false))) {
 429                 msg = _("Script fails to compile.");
 430                 goto errorout;
 431         }
 432
 433         // 2) check script name & type
 434         lsi = LuaScripting::script_info (script);
 435         if (!lsi) {
 436                 msg = _("Invalid or missing script-name or script-type.");
 437                 goto errorout;
 438         }
 439
 440         if (lsi->type != LuaScriptInfo::Snippet && lsi->type != LuaScriptInfo::EditorAction) {
 441                 msg = _("Invalid script-type.\nValid types are 'EditorAction' and 'Snippet'.");
 442                 goto errorout;
 443         }
 444
 445         // 3) if there's already a writable file,...
 446         if ((sb.flags & Buffer_HasFile) && !(sb.flags & Buffer_ReadOnly)) {
 447                 try {
 448                         Glib::file_set_contents (sb.path, script);
 449                         sb.name = lsi->name;
 450                         sb.flags &= BufferFlags(~Buffer_Dirty);
 451                         update_gui_state (); // XXX here?
 452                         append_text (X_("> ") + string_compose (_("Saved as %1"), sb.path));
 453                         return; // OK
 454                 } catch (Glib::FileError e) {
 455                         msg = string_compose (_("Error saving file: %1"), e.what());
 456                         goto errorout;
 457                 }
 458         }
 459
 460         // 4) check if the name is unique for the given type; locally at least
 461         if (true /*sb.flags & Buffer_HasFile*/) {
 462                 LuaScriptList& lsl (LuaScripting::instance ().scripts (lsi->type));
 463                 for (LuaScriptList::const_iterator s = lsl.begin(); s != lsl.end(); ++s) {
 464                         if ((*s)->name == lsi->name) {
 465                                 msg = string_compose (_("Script with given name '%1' already exists.\nUse a different name in the descriptor."), lsi->name);
 466                                 goto errorout;
 467                         }
 468                 }
 469         }
 470
 471         // 5) construct filename -- TODO ask user for name, ask to replace file.
 472         do {
 473                 char buf[80];
 474                 time_t t = time(0);
 475                 struct tm * timeinfo = localtime (&t);
 476                 strftime (buf, sizeof(buf), "%s%d", timeinfo);
 477                 sprintf (buf, "%s%ld", buf, random ()); // is this valid?
 478                 MD5 md5;
 479                 std::string fn = md5.digestString (buf);
 480
 481                 switch (lsi->type) {
 482                         case LuaScriptInfo::EditorAction:
 483                                 fn = "a_" + fn;
 484                                 break;
 485                         case LuaScriptInfo::Snippet:
 486                                 fn = "s_" + fn;
 487                                 break;
 488                         default:
 489                                 break;
 490                 }
 491                 path = Glib::build_filename (LuaScripting::user_script_dir (), fn.substr(0, 11) + ".lua");
 492         } while (Glib::file_test (path, Glib::FILE_TEST_EXISTS));
 493
 494         try {
 495                 Glib::file_set_contents (path, script);
 496                 sb.path = path;
 497                 sb.name = lsi->name;
 498                 sb.flags |= Buffer_HasFile;
 499                 sb.flags &= BufferFlags(~Buffer_Dirty);
 500                 sb.flags &= BufferFlags(~Buffer_ReadOnly);
 501                 update_gui_state (); // XXX here? .refresh (true) may trigger this, too
 502                 LuaScripting::instance().refresh (true);
 503                 append_text (X_("> ") + string_compose (_("Saved as %1"), path));
 504                 return; // OK
 505         } catch (Glib::FileError e) {
 506                 msg = string_compose (_("Error saving file: %1"), e.what());
 507                 goto errorout;
 508         }
 509
 510 errorout:
 511                 MessageDialog am (msg);
 512                 am.run ();
 513 }
 514
 515 void
 516 LuaWindow::setup_buffers ()
 517 {
 518         if (script_buffers.size() > 0) {
 519                 return;
 520         }
 521         script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer("#1")));
 522         _current_buffer = script_buffers.front();
 523
 524         Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
 525         tb->set_text (_current_buffer->script);
 526
 527         refresh_scriptlist ();
 528         update_gui_state ();
 529 }
 530
 531 uint32_t
 532 LuaWindow::count_scratch_buffers () const
 533 {
 534         uint32_t n = 0;
 535         for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
 536                 if ((*i)->flags & Buffer_Scratch) {
 537                         ++n;
 538                 }
 539         }
 540         return n;
 541 }
 542
 543 void
 544 LuaWindow::refresh_scriptlist ()
 545 {
 546         for (ScriptBufferList::iterator i = script_buffers.begin (); i != script_buffers.end ();) {
 547                 if ((*i)->flags & Buffer_Scratch) {
 548                         ++i;
 549                         continue;
 550                 }
 551                 i = script_buffers.erase (i);
 552         }
 553         LuaScriptList& lsa (LuaScripting::instance ().scripts (LuaScriptInfo::EditorAction));
 554         for (LuaScriptList::const_iterator s = lsa.begin(); s != lsa.end(); ++s) {
 555                 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer(*s)));
 556         }
 557
 558         LuaScriptList& lss (LuaScripting::instance ().scripts (LuaScriptInfo::Snippet));
 559         for (LuaScriptList::const_iterator s = lss.begin(); s != lss.end(); ++s) {
 560                 script_buffers.push_back (ScriptBufferPtr (new LuaWindow::ScriptBuffer(*s)));
 561         }
 562         rebuild_menu ();
 563 }
 564
 565 void
 566 LuaWindow::rebuild_menu ()
 567 {
 568         using namespace Menu_Helpers;
 569
 570         _menu_scratch = manage (new Menu);
 571         _menu_snippet = manage (new Menu);
 572         _menu_actions = manage (new Menu);
 573
 574         MenuList& items_scratch (_menu_scratch->items());
 575         MenuList& items_snippet (_menu_snippet->items());
 576         MenuList& items_actions (_menu_actions->items());
 577
 578         {
 579                 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem(_("New"),
 580                                 sigc::mem_fun(*this, &LuaWindow::new_script));
 581                 items_scratch.push_back(elem);
 582         }
 583
 584         items_scratch.push_back(SeparatorElem());
 585
 586         for (ScriptBufferList::const_iterator i = script_buffers.begin (); i != script_buffers.end (); ++i) {
 587                 std::string name;
 588                 if ((*i)->flags & Buffer_ReadOnly) {
 589                         name = "[R] " + (*i)->name;
 590                 } else {
 591                         name = (*i)->name;
 592                 }
 593                 Menu_Helpers::MenuElem elem = Gtk::Menu_Helpers::MenuElem(name,
 594                                 sigc::bind(sigc::mem_fun(*this, &LuaWindow::script_selection_changed), (*i), false));
 595
 596                 if ((*i)->flags & Buffer_Scratch) {
 597                         items_scratch.push_back(elem);
 598                 }
 599                 else if ((*i)->type == LuaScriptInfo::EditorAction) {
 600                                 items_actions.push_back(elem);
 601                 }
 602                 else if ((*i)->type == LuaScriptInfo::Snippet) {
 603                                 items_snippet.push_back(elem);
 604                 }
 605         }
 606
 607         script_select.clear_items ();
 608         script_select.AddMenuElem (Menu_Helpers::MenuElem ("Scratch", *_menu_scratch));
 609         script_select.AddMenuElem (Menu_Helpers::MenuElem ("Snippets", *_menu_snippet));
 610         script_select.AddMenuElem (Menu_Helpers::MenuElem ("Actions", *_menu_actions));
 611 }
 612
 613 void
 614 LuaWindow::script_selection_changed (ScriptBufferPtr n, bool force)
 615 {
 616         if (n == _current_buffer && !force) {
 617                 return;
 618         }
 619
 620         Glib::RefPtr<Gtk::TextBuffer> tb (entry.get_buffer());
 621
 622         if (_current_buffer->flags & Buffer_Valid) {
 623                 _current_buffer->script = tb->get_text();
 624         }
 625
 626         if (!(n->flags & Buffer_Valid)) {
 627                 if (!n->load()) {
 628                         append_text ("! Failed to load buffer.");
 629                 }
 630         }
 631
 632         if (n->flags & Buffer_Valid) {
 633                 _current_buffer = n;
 634                 _script_changed_connection.block ();
 635                 tb->set_text (n->script);
 636                 _script_changed_connection.unblock ();
 637         } else {
 638                 append_text ("! Failed to switch buffer.");
 639         }
 640         update_gui_state ();
 641 }
 642
 643 void
 644 LuaWindow::update_gui_state ()
 645 {
 646         const ScriptBuffer & sb (*_current_buffer);
 647         std::string name;
 648         if (sb.flags & Buffer_Scratch) {
 649                 name = string_compose (_("Scratch Buffer %1"), sb.name);
 650         } else if (sb.type == LuaScriptInfo::EditorAction) {
 651                 name = string_compose (_("Action: '%1'"), sb.name);
 652         } else if (sb.type == LuaScriptInfo::Snippet) {
 653                 name = string_compose (_("Snippet: %1"), sb.name);
 654         } else {
 655                 cerr << "Invalid Script type\n";
 656                 assert (0);
 657                 return;
 658         }
 659         if (sb.flags & Buffer_Dirty) {
 660                 name += " *";
 661         }
 662         script_select.set_text(name);
 663
 664         if (sb.flags & Buffer_ReadOnly) {
 665                 _btn_save.set_text (_("Save as"));
 666         } else {
 667                 _btn_save.set_text (_("Save"));
 668         }
 669         _btn_save.set_sensitive (sb.flags & Buffer_Dirty);
 670         _btn_delete.set_sensitive (sb.flags & Buffer_Scratch || ((sb.flags & (Buffer_ReadOnly | Buffer_HasFile)) == Buffer_HasFile));
 671         _btn_revert.set_sensitive ((sb.flags & Buffer_Dirty) && (sb.flags & Buffer_HasFile));
 672 }
 673
 674 void
 675 LuaWindow::script_changed () {
 676         if (_current_buffer->flags & Buffer_Dirty) {
 677                 return;
 678         }
 679         _current_buffer->flags |= Buffer_Dirty;
 680         update_gui_state ();
 681 }
 682
 683 LuaWindow::ScriptBuffer::ScriptBuffer (const std::string& n)
 684         : name (n)
 685         , flags (Buffer_Scratch | Buffer_Valid)
 686 {
 687         script =
 688                 "---- this header is (only) required to save the script\n"
 689                 "-- ardour { [\"type\"] = \"Snippet\", name = \"\" }\n"
 690                 "-- function factory () return function () -- -- end end\n";
 691 }
 692
 693 LuaWindow::ScriptBuffer::ScriptBuffer (LuaScriptInfoPtr p)
 694         : name (p->name)
 695         , path (p->path)
 696         , flags (Buffer_HasFile)
 697         , type (p->type)
 698 {
 699         if (!PBD::exists_and_writable (path)) {
 700                 flags |= Buffer_ReadOnly;
 701         }
 702         if (path.find (user_config_directory ()) != 0) {
 703                 // mark non-user scripts as read-only
 704                 flags |= Buffer_ReadOnly;
 705         }
 706 }
 707
 708 #if 0
 709 LuaWindow::ScriptBuffer::ScriptBuffer (const ScriptBuffer& other)
 710         : script (other.script)
 711         , name (other.name)
 712         , path (other.path)
 713         , flags (other.flags)
 714         , type (other.type)
 715 {
 716 }
 717 #endif
 718
 719 LuaWindow::ScriptBuffer::~ScriptBuffer ()
 720 {
 721 }
 722
 723 bool
 724 LuaWindow::ScriptBuffer::load ()
 725 {
 726         assert (!(flags & Buffer_Valid));
 727         if (!(flags & Buffer_HasFile)) return false;
 728         try {
 729                 script = Glib::file_get_contents (path);
 730                 flags |= Buffer_Valid;
 731                 flags &= BufferFlags(~Buffer_Dirty);
 732         } catch (Glib::FileError e) {
 733                 return false;
 734         }
 735         return true;
 736 }