Aegisub/src/auto4_lua_dialog.cpp

561 lines
16 KiB
C++
Raw Permalink Normal View History

// Copyright (c) 2006, 2007, Niels Martin Hansen
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither the name of the Aegisub Group nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Aegisub Project http://www.aegisub.org/
/// @file auto4_lua_dialog.cpp
/// @brief Lua 5.1-based scripting engine (configuration-dialogue interface)
/// @ingroup scripting
///
#include "auto4_lua.h"
#include "colour_button.h"
#include "compat.h"
#include "string_codec.h"
#include "validators.h"
#include <libaegisub/log.h>
#include <libaegisub/lua/utils.h>
#include <libaegisub/make_unique.h>
#include <libaegisub/split.h>
2013-06-10 15:58:13 +02:00
#include <boost/algorithm/string/case_conv.hpp>
2014-05-23 00:40:16 +02:00
#include <boost/range/adaptor/map.hpp>
#include <boost/range/algorithm.hpp>
#include <cfloat>
#include <unordered_map>
#include <wx/button.h>
#include <wx/checkbox.h>
#include <wx/combobox.h>
2014-05-23 00:40:16 +02:00
#include <wx/dialog.h>
#include <wx/gbsizer.h>
#include <wx/panel.h>
#include <wx/spinctrl.h>
#include <wx/stattext.h>
#include <wx/valgen.h>
using namespace agi::lua;
namespace {
inline void get_if_right_type(lua_State *L, std::string &def) {
if (lua_isstring(L, -1))
def = lua_tostring(L, -1);
}
inline void get_if_right_type(lua_State *L, double &def) {
if (lua_isnumber(L, -1))
def = lua_tonumber(L, -1);
}
inline void get_if_right_type(lua_State *L, int &def) {
if (lua_isnumber(L, -1))
def = lua_tointeger(L, -1);
}
inline void get_if_right_type(lua_State *L, bool &def) {
if (lua_isboolean(L, -1))
def = !!lua_toboolean(L, -1);
}
template<class T>
T get_field(lua_State *L, const char *name, T def) {
lua_getfield(L, -1, name);
get_if_right_type(L, def);
lua_pop(L, 1);
return def;
}
inline std::string get_field(lua_State *L, const char *name) {
return get_field(L, name, std::string());
}
template<class T>
void read_string_array(lua_State *L, T &cont) {
lua_for_each(L, [&] {
if (lua_isstring(L, -1))
cont.push_back(lua_tostring(L, -1));
});
}
int string_to_wx_id(std::string const& str) {
static std::unordered_map<std::string, int> ids;
if (ids.empty()) {
ids["ok"] = wxID_OK;
ids["yes"] = wxID_YES;
ids["save"] = wxID_SAVE;
ids["apply"] = wxID_APPLY;
ids["close"] = wxID_CLOSE;
ids["no"] = wxID_NO;
ids["cancel"] = wxID_CANCEL;
ids["help"] = wxID_HELP;
ids["context_help"] = wxID_CONTEXT_HELP;
}
auto it = ids.find(str);
return it == end(ids) ? -1 : it->second;
}
}
namespace Automation4 {
// LuaDialogControl
LuaDialogControl::LuaDialogControl(lua_State *L)
// Assume top of stack is a control table (don't do checking)
: name(get_field(L, "name"))
, hint(get_field(L, "hint"))
, x(get_field(L, "x", 0))
, y(get_field(L, "y", 0))
, width(get_field(L, "width", 1))
, height(get_field(L, "height", 1))
{
LOG_D("automation/lua/dialog") << "created control: '" << name << "', (" << x << "," << y << ")(" << width << "," << height << "), " << hint;
}
namespace LuaControl {
/// A static text label
class Label final : public LuaDialogControl {
std::string label;
public:
Label(lua_State *L) : LuaDialogControl(L), label(get_field(L, "label")) { }
2013-11-21 18:13:36 +01:00
wxControl *Create(wxWindow *parent) override {
return new wxStaticText(parent, -1, to_wx(label));
}
2013-11-21 18:13:36 +01:00
int GetSizerFlags() const override { return wxALIGN_CENTRE_VERTICAL | wxALIGN_LEFT; }
2013-11-21 18:13:36 +01:00
void LuaReadBack(lua_State *L) override {
// Label doesn't produce output, so let it be nil
lua_pushnil(L);
}
};
/// A single-line text edit control
class Edit : public LuaDialogControl {
protected:
std::string text;
wxTextCtrl *cw = nullptr;
public:
Edit(lua_State *L)
: LuaDialogControl(L)
, text(get_field(L, "value"))
{
// Undocumented behaviour, 'value' is also accepted as key for text,
// mostly so a text control can stand in for other things.
// This shouldn't be exploited and might change later.
text = get_field(L, "text", text);
}
2013-11-21 18:13:36 +01:00
bool CanSerialiseValue() const override { return true; }
std::string SerialiseValue() const override { return inline_string_encode(text); }
void UnserialiseValue(const std::string &serialised) override { text = inline_string_decode(serialised); }
2013-11-21 18:13:36 +01:00
wxControl *Create(wxWindow *parent) override {
cw = new wxTextCtrl(parent, -1, to_wx(text));
cw->SetMaxLength(0);
cw->SetValidator(StringBinder(&text));
cw->SetToolTip(to_wx(hint));
return cw;
}
2013-11-21 18:13:36 +01:00
void LuaReadBack(lua_State *L) override {
lua_pushstring(L, text.c_str());
}
};
/// A color-picker button
class Color final : public LuaDialogControl {
agi::Color color;
bool alpha;
public:
Color(lua_State *L, bool alpha)
: LuaDialogControl(L)
, color(get_field(L, "value"))
, alpha(alpha)
{
}
2013-11-21 18:13:36 +01:00
bool CanSerialiseValue() const override { return true; }
std::string SerialiseValue() const override { return inline_string_encode(color.GetHexFormatted(alpha)); }
2013-11-21 18:13:36 +01:00
void UnserialiseValue(const std::string &serialised) override { color = inline_string_decode(serialised); }
2013-11-21 18:13:36 +01:00
wxControl *Create(wxWindow *parent) override {
wxControl *cw = new ColourButton(parent, wxSize(50*width,10*height), alpha, color, ColorValidator(&color));
cw->SetToolTip(to_wx(hint));
return cw;
}
2013-11-21 18:13:36 +01:00
void LuaReadBack(lua_State *L) override {
lua_pushstring(L, color.GetHexFormatted(alpha).c_str());
}
};
/// A multiline text edit control
class Textbox final : public Edit {
public:
Textbox(lua_State *L) : Edit(L) { }
// Same serialisation interface as single-line edit
2013-11-21 18:13:36 +01:00
wxControl *Create(wxWindow *parent) override {
cw = new wxTextCtrl(parent, -1, "", wxDefaultPosition, wxDefaultSize, wxTE_MULTILINE, StringBinder(&text));
cw->SetMinSize(wxSize(0, 30));
cw->SetToolTip(to_wx(hint));
return cw;
}
};
/// Integer only edit
class IntEdit final : public Edit {
wxSpinCtrl *cw = nullptr;
int value;
int min, max;
public:
IntEdit(lua_State *L)
: Edit(L)
, value(get_field(L, "value", 0))
, min(get_field(L, "min", INT_MIN))
, max(get_field(L, "max", INT_MAX))
{
if (min >= max) {
max = INT_MAX;
min = INT_MIN;
}
}
2013-11-21 18:13:36 +01:00
bool CanSerialiseValue() const override { return true; }
std::string SerialiseValue() const override { return std::to_string(value); }
void UnserialiseValue(const std::string &serialised) override { value = atoi(serialised.c_str()); }
2013-11-21 18:13:36 +01:00
wxControl *Create(wxWindow *parent) override {
cw = new wxSpinCtrl(parent, -1, "", wxDefaultPosition, wxDefaultSize, wxSP_ARROW_KEYS, min, max, value);
cw->SetValidator(wxGenericValidator(&value));
cw->SetToolTip(to_wx(hint));
return cw;
}
2013-11-21 18:13:36 +01:00
void LuaReadBack(lua_State *L) override {
lua_pushinteger(L, value);
}
};
// Float only edit
class FloatEdit final : public Edit {
double value;
double min;
double max;
double step;
wxSpinCtrlDouble *scd = nullptr;
public:
FloatEdit(lua_State *L)
: Edit(L)
, value(get_field(L, "value", 0.0))
, min(get_field(L, "min", -DBL_MAX))
, max(get_field(L, "max", DBL_MAX))
, step(get_field(L, "step", 0.0))
{
if (min >= max) {
max = DBL_MAX;
min = -DBL_MAX;
}
if (step != 0.0) {
min = min == -DBL_MAX ? 0.0 : min;
max = max == DBL_MAX ? 100.0 : max;
}
}
2013-11-21 18:13:36 +01:00
bool CanSerialiseValue() const override { return true; }
std::string SerialiseValue() const override { return std::to_string(value); }
void UnserialiseValue(const std::string &serialised) override { value = atof(serialised.c_str()); }
2013-11-21 18:13:36 +01:00
wxControl *Create(wxWindow *parent) override {
if (step > 0) {
scd = new wxSpinCtrlDouble(parent, -1, "", wxDefaultPosition, wxDefaultSize, wxSP_ARROW_KEYS, min, max, value, step);
scd->SetValidator(DoubleSpinValidator(&value));
scd->SetToolTip(to_wx(hint));
return scd;
}
DoubleValidator val(&value, min, max);
cw = new wxTextCtrl(parent, -1, "", wxDefaultPosition, wxDefaultSize, 0, val);
cw->SetToolTip(to_wx(hint));
return cw;
}
2013-11-21 18:13:36 +01:00
void LuaReadBack(lua_State *L) override {
lua_pushnumber(L, value);
}
};
/// A dropdown list
class Dropdown final : public LuaDialogControl {
std::vector<std::string> items;
std::string value;
wxComboBox *cw = nullptr;
public:
Dropdown(lua_State *L)
: LuaDialogControl(L)
, value(get_field(L, "value"))
{
lua_getfield(L, -1, "items");
read_string_array(L, items);
#ifdef __WXMAC__
if (std::find(items.begin(), items.end(), value) == items.end()) {
items.insert(items.begin(), value);
}
#endif
}
2013-11-21 18:13:36 +01:00
bool CanSerialiseValue() const override { return true; }
std::string SerialiseValue() const override { return inline_string_encode(value); }
void UnserialiseValue(const std::string &serialised) override { value = inline_string_decode(serialised); }
2013-11-21 18:13:36 +01:00
wxControl *Create(wxWindow *parent) override {
cw = new wxComboBox(parent, -1, to_wx(value), wxDefaultPosition, wxDefaultSize, to_wx(items), wxCB_READONLY, StringBinder(&value));
cw->SetToolTip(to_wx(hint));
return cw;
}
2013-11-21 18:13:36 +01:00
void LuaReadBack(lua_State *L) override {
lua_pushstring(L, value.c_str());
}
};
class Checkbox final : public LuaDialogControl {
std::string label;
bool value;
wxCheckBox *cw = nullptr;
public:
Checkbox(lua_State *L)
: LuaDialogControl(L)
, label(get_field(L, "label"))
, value(get_field(L, "value", false))
{
}
2013-11-21 18:13:36 +01:00
bool CanSerialiseValue() const override { return true; }
std::string SerialiseValue() const override { return value ? "1" : "0"; }
void UnserialiseValue(const std::string &serialised) override { value = serialised != "0"; }
2013-11-21 18:13:36 +01:00
wxControl *Create(wxWindow *parent) override {
cw = new wxCheckBox(parent, -1, to_wx(label));
cw->SetValidator(wxGenericValidator(&value));
cw->SetToolTip(to_wx(hint));
cw->SetValue(value);
return cw;
}
2013-11-21 18:13:36 +01:00
void LuaReadBack(lua_State *L) override {
lua_pushboolean(L, value);
}
};
}
// LuaDialog
LuaDialog::LuaDialog(lua_State *L, bool include_buttons)
: use_buttons(include_buttons)
{
LOG_D("automation/lua/dialog") << "creating LuaDialoug, addr: " << this;
// assume top of stack now contains a dialog table
if (!lua_istable(L, 1))
error(L, "Cannot create config dialog from something non-table");
// Ok, so there is a table with controls
lua_pushvalue(L, 1);
2013-05-26 01:31:48 +02:00
lua_for_each(L, [&] {
if (!lua_istable(L, -1))
error(L, "bad control table entry");
std::string controlclass = get_field(L, "class");
boost::to_lower(controlclass);
2013-06-10 15:58:13 +02:00
std::unique_ptr<LuaDialogControl> ctl;
// Check control class and create relevant control
if (controlclass == "label")
ctl = agi::make_unique<LuaControl::Label>(L);
else if (controlclass == "edit")
ctl = agi::make_unique<LuaControl::Edit>(L);
else if (controlclass == "intedit")
ctl = agi::make_unique<LuaControl::IntEdit>(L);
else if (controlclass == "floatedit")
ctl = agi::make_unique<LuaControl::FloatEdit>(L);
else if (controlclass == "textbox")
ctl = agi::make_unique<LuaControl::Textbox>(L);
else if (controlclass == "dropdown")
ctl = agi::make_unique<LuaControl::Dropdown>(L);
else if (controlclass == "checkbox")
ctl = agi::make_unique<LuaControl::Checkbox>(L);
else if (controlclass == "color")
ctl = agi::make_unique<LuaControl::Color>(L, false);
else if (controlclass == "coloralpha")
ctl = agi::make_unique<LuaControl::Color>(L, true);
else if (controlclass == "alpha")
// FIXME
ctl = agi::make_unique<LuaControl::Edit>(L);
else
error(L, "bad control table entry");
2013-06-10 15:58:13 +02:00
controls.emplace_back(std::move(ctl));
2013-05-26 01:31:48 +02:00
});
if (include_buttons && lua_istable(L, 2)) {
lua_pushvalue(L, 2);
lua_for_each(L, [&]{
buttons.emplace_back(-1, check_string(L, -1));
});
}
if (include_buttons && lua_istable(L, 3)) {
lua_pushvalue(L, 3);
lua_for_each(L, [&]{
int id = string_to_wx_id(check_string(L, -2));
std::string label = check_string(L, -1);
auto btn = boost::find_if(buttons,
[&](std::pair<int, std::string>& btn) { return btn.second == label; });
if (btn == end(buttons))
error(L, "Invalid button for id %s", lua_tostring(L, -2));
btn->first = id;
});
}
}
wxWindow* LuaDialog::CreateWindow(wxWindow *parent) {
window = new wxPanel(parent);
auto s = new wxGridBagSizer(4, 4);
2013-06-10 15:58:13 +02:00
for (auto& c : controls)
s->Add(c->Create(window), wxGBPosition(c->y, c->x),
wxGBSpan(c->height, c->width), c->GetSizerFlags());
if (!use_buttons) {
window->SetSizerAndFit(s);
return window;
}
if (buttons.size() == 0) {
buttons.emplace_back(wxID_OK, "");
buttons.emplace_back(wxID_CANCEL, "");
}
auto dialog = static_cast<wxDialog *>(parent);
auto bs = new wxStdDialogButtonSizer;
auto make_button = [&](wxWindowID id, int button_pushed, std::string const& text) -> wxButton *{
auto button = new wxButton(window, id, to_wx(text));
2013-12-12 03:25:13 +01:00
button->Bind(wxEVT_BUTTON, [=](wxCommandEvent &evt) {
this->button_pushed = button_pushed;
dialog->TransferDataFromWindow();
dialog->EndModal(0);
});
if (id == wxID_OK || id == wxID_YES || id == wxID_SAVE) {
button->SetDefault();
dialog->SetAffirmativeId(id);
}
if (id == wxID_CLOSE || id == wxID_NO)
dialog->SetEscapeId(id);
return button;
};
if (boost::count(buttons | boost::adaptors::map_keys, -1) == 0) {
for (size_t i = 0; i < buttons.size(); ++i)
bs->AddButton(make_button(buttons[i].first, i, buttons[i].second));
bs->Realize();
}
else {
for (size_t i = 0; i < buttons.size(); ++i)
bs->Add(make_button(buttons[i].first, i, buttons[i].second));
}
auto ms = new wxBoxSizer(wxVERTICAL);
ms->Add(s, 0, wxBOTTOM, 5);
ms->Add(bs);
window->SetSizerAndFit(ms);
return window;
}
int LuaDialog::LuaReadBack(lua_State *L) {
// First read back which button was pressed, if any
if (use_buttons) {
if (button_pushed == -1 || buttons[button_pushed].first == wxID_CANCEL)
lua_pushboolean(L, false);
else
lua_pushstring(L, buttons[button_pushed].second.c_str());
}