Skip to content

Commit

Permalink
Add formspec api versioning
Browse files Browse the repository at this point in the history
  • Loading branch information
sapier authored and sapier committed Jun 29, 2014
1 parent 1367895 commit ebf7ea5
Show file tree
Hide file tree
Showing 6 changed files with 130 additions and 34 deletions.
4 changes: 4 additions & 0 deletions src/clientserver.h
View file
Expand Up @@ -19,6 +19,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,

#ifndef CLIENTSERVER_HEADER
#define CLIENTSERVER_HEADER
#include "util/string.h"

/*
changes by PROTOCOL_VERSION:
Expand Down Expand Up @@ -122,6 +123,9 @@ with this program; if not, write to the Free Software Foundation, Inc.,
#define PASSWORD_SIZE 28 // Maximum password length. Allows for
// base64-encoded SHA-1 (27+\0).

#define FORMSPEC_API_VERSION 1
#define FORMSPEC_VERSION_STRING "formspec_version[" TOSTRING(FORMSPEC_API_VERSION) "]"

#define TEXTURENAME_ALLOWED_CHARS "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_.-"

enum ToClientCommand
Expand Down
5 changes: 3 additions & 2 deletions src/game.cpp
View file
Expand Up @@ -948,6 +948,7 @@ static void show_chat_menu(GUIFormSpecMenu** cur_formspec,
Client* client, std::string text)
{
std::string formspec =
FORMSPEC_VERSION_STRING
"size[11,5.5,true]"
"field[3,2.35;6,0.5;f_text;;" + text + "]"
"button_exit[4,3;3,0.5;btn_send;" + wide_to_narrow(wstrgettext("Proceed")) + "]"
Expand All @@ -967,7 +968,7 @@ static void show_deathscreen(GUIFormSpecMenu** cur_formspec,
IWritableTextureSource* tsrc, IrrlichtDevice * device, Client* client)
{
std::string formspec =
std::string("") +
std::string(FORMSPEC_VERSION_STRING) +
"size[11,5.5,true]"
"bgcolor[#320000b4;true]"
"label[4.85,1.35;You died.]"
Expand Down Expand Up @@ -1005,7 +1006,7 @@ static void show_pause_menu(GUIFormSpecMenu** cur_formspec,
float ypos = singleplayermode ? 1.0 : 0.5;
std::ostringstream os;

os << "size[11,5.5,true]"
os << FORMSPEC_VERSION_STRING << "size[11,5.5,true]"
<< "button_exit[4," << (ypos++) << ";3,0.5;btn_continue;"
<< wide_to_narrow(wstrgettext("Continue")) << "]";

Expand Down
131 changes: 102 additions & 29 deletions src/guiFormSpecMenu.cpp
View file
Expand Up @@ -86,7 +86,8 @@ GUIFormSpecMenu::GUIFormSpecMenu(irr::IrrlichtDevice* dev,
m_form_src(fsrc),
m_text_dst(tdst),
m_ext_ptr(ext_ptr),
m_font(dev->getGUIEnvironment()->getSkin()->getFont())
m_font(dev->getGUIEnvironment()->getSkin()->getFont()),
m_formspec_version(0)
{
current_keys_pending.key_down = false;
current_keys_pending.key_up = false;
Expand Down Expand Up @@ -265,7 +266,9 @@ void GUIFormSpecMenu::parseSize(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,',');

if ((parts.size() == 2) || parts.size() == 3) {
if (((parts.size() == 2) || parts.size() == 3) ||
((parts.size() > 3) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
v2f invsize;

if (parts[1].find(';') != std::string::npos)
Expand Down Expand Up @@ -359,7 +362,9 @@ void GUIFormSpecMenu::parseList(parserData* data,std::string element)

std::vector<std::string> parts = split(element,';');

if ((parts.size() == 4) || (parts.size() == 5)) {
if (((parts.size() == 4) || (parts.size() == 5)) ||
((parts.size() > 5) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::string location = parts[0];
std::string listname = parts[1];
std::vector<std::string> v_pos = split(parts[2],',');
Expand Down Expand Up @@ -407,7 +412,9 @@ void GUIFormSpecMenu::parseCheckbox(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if ((parts.size() >= 3) || (parts.size() <= 4)) {
if (((parts.size() >= 3) || (parts.size() <= 4)) ||
((parts.size() > 4) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::string name = parts[1];
std::string label = parts[2];
Expand Down Expand Up @@ -460,7 +467,9 @@ void GUIFormSpecMenu::parseImage(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if (parts.size() == 3) {
if ((parts.size() == 3) ||
((parts.size() > 3) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::vector<std::string> v_geom = split(parts[1],',');
std::string name = unescape_string(parts[2]);
Expand Down Expand Up @@ -504,7 +513,9 @@ void GUIFormSpecMenu::parseItemImage(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if (parts.size() == 3) {
if ((parts.size() == 3) ||
((parts.size() > 3) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::vector<std::string> v_geom = split(parts[1],',');
std::string name = parts[2];
Expand Down Expand Up @@ -533,7 +544,9 @@ void GUIFormSpecMenu::parseButton(parserData* data,std::string element,
{
std::vector<std::string> parts = split(element,';');

if (parts.size() == 4) {
if ((parts.size() == 4) ||
((parts.size() > 4) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::vector<std::string> v_geom = split(parts[1],',');
std::string name = parts[2];
Expand Down Expand Up @@ -587,7 +600,9 @@ void GUIFormSpecMenu::parseBackground(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if ((parts.size() == 3) || (parts.size() == 4)) {
if (((parts.size() == 3) || (parts.size() == 4)) ||
((parts.size() > 4) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::vector<std::string> v_geom = split(parts[1],',');
std::string name = unescape_string(parts[2]);
Expand Down Expand Up @@ -655,7 +670,9 @@ void GUIFormSpecMenu::parseTable(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if ((parts.size() == 4) || (parts.size() == 5)) {
if (((parts.size() == 4) || (parts.size() == 5)) ||
((parts.size() > 5) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::vector<std::string> v_geom = split(parts[1],',');
std::string name = parts[2];
Expand Down Expand Up @@ -724,7 +741,9 @@ void GUIFormSpecMenu::parseTextList(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if ((parts.size() == 4) || (parts.size() == 5) || (parts.size() == 6)) {
if (((parts.size() == 4) || (parts.size() == 5) || (parts.size() == 6)) ||
((parts.size() > 6) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::vector<std::string> v_geom = split(parts[1],',');
std::string name = parts[2];
Expand Down Expand Up @@ -797,7 +816,9 @@ void GUIFormSpecMenu::parseDropDown(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if (parts.size() == 5) {
if ((parts.size() == 5) ||
((parts.size() > 5) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::string name = parts[2];
std::vector<std::string> items = split(parts[3],',');
Expand Down Expand Up @@ -852,7 +873,9 @@ void GUIFormSpecMenu::parsePwdField(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if (parts.size() == 4) {
if ((parts.size() == 4) ||
((parts.size() > 4) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::vector<std::string> v_geom = split(parts[1],',');
std::string name = parts[2];
Expand Down Expand Up @@ -1103,7 +1126,9 @@ void GUIFormSpecMenu::parseField(parserData* data,std::string element,
return;
}

if (parts.size() == 5) {
if ((parts.size() == 5) ||
((parts.size() > 5) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
parseTextArea(data,parts,type);
return;
}
Expand All @@ -1114,7 +1139,9 @@ void GUIFormSpecMenu::parseLabel(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if (parts.size() == 2) {
if ((parts.size() == 2) ||
((parts.size() > 2) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::string text = parts[1];

Expand Down Expand Up @@ -1153,7 +1180,9 @@ void GUIFormSpecMenu::parseVertLabel(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if (parts.size() == 2) {
if ((parts.size() == 2) ||
((parts.size() > 2) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::wstring text = narrow_to_wide(unescape_string(parts[1]));

Expand Down Expand Up @@ -1201,7 +1230,9 @@ void GUIFormSpecMenu::parseImageButton(parserData* data,std::string element,
{
std::vector<std::string> parts = split(element,';');

if (((parts.size() >= 5) && (parts.size() <= 8)) && (parts.size() != 6)) {
if ((((parts.size() >= 5) && (parts.size() <= 8)) && (parts.size() != 6)) ||
((parts.size() > 8) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::vector<std::string> v_geom = split(parts[1],',');
std::string image_name = parts[2];
Expand Down Expand Up @@ -1286,7 +1317,9 @@ void GUIFormSpecMenu::parseTabHeader(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if ((parts.size() == 4) || (parts.size() == 6)) {
if (((parts.size() == 4) || (parts.size() == 6)) ||
((parts.size() > 6) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::string name = parts[1];
std::vector<std::string> buttons = split(parts[2],',');
Expand Down Expand Up @@ -1363,7 +1396,9 @@ void GUIFormSpecMenu::parseItemImageButton(parserData* data,std::string element)

std::vector<std::string> parts = split(element,';');

if (parts.size() == 5) {
if ((parts.size() == 5) ||
((parts.size() > 5) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::vector<std::string> v_geom = split(parts[1],',');
std::string item_name = parts[2];
Expand Down Expand Up @@ -1426,7 +1461,9 @@ void GUIFormSpecMenu::parseBox(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if (parts.size() == 3) {
if ((parts.size() == 3) ||
((parts.size() > 3) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
std::vector<std::string> v_pos = split(parts[0],',');
std::vector<std::string> v_geom = split(parts[1],',');

Expand Down Expand Up @@ -1460,7 +1497,9 @@ void GUIFormSpecMenu::parseBackgroundColor(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if ((parts.size() == 1) || (parts.size() == 2)) {
if (((parts.size() == 1) || (parts.size() == 2)) ||
((parts.size() > 2) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
parseColor(parts[0],m_bgcolor,false);

if (parts.size() == 2) {
Expand All @@ -1476,7 +1515,9 @@ void GUIFormSpecMenu::parseListColors(parserData* data,std::string element)
{
std::vector<std::string> parts = split(element,';');

if ((parts.size() == 2) || (parts.size() == 3) || (parts.size() == 5)) {
if (((parts.size() == 2) || (parts.size() == 3) || (parts.size() == 5)) ||
((parts.size() > 5) && (m_formspec_version > FORMSPEC_API_VERSION)))
{
parseColor(parts[0], m_slotbg_n, false);
parseColor(parts[1], m_slotbg_h, false);

Expand All @@ -1503,20 +1544,44 @@ void GUIFormSpecMenu::parseTooltip(parserData* data, std::string element)
std::vector<std::string> parts = split(element,';');
if (parts.size() == 2) {
std::string name = parts[0];
m_tooltips[narrow_to_wide(name.c_str())] = TooltipSpec (parts[1], m_default_tooltip_bgcolor, m_default_tooltip_color);
m_tooltips[narrow_to_wide(name.c_str())] = TooltipSpec (parts[1], m_default_tooltip_bgcolor, m_default_tooltip_color);
return;
} else if (parts.size() == 4) {
std::string name = parts[0];
video::SColor tmp_color1, tmp_color2;
if ( parseColor(parts[2], tmp_color1, false) && parseColor(parts[3], tmp_color2, false) ) {
if ( parseColor(parts[2], tmp_color1, false) && parseColor(parts[3], tmp_color2, false) ) {
m_tooltips[narrow_to_wide(name.c_str())] = TooltipSpec (parts[1], tmp_color1, tmp_color2);
return;
}
}
errorstream<< "Invalid tooltip element(" << parts.size() << "): '" << element << "'" << std::endl;
}

void GUIFormSpecMenu::parseElement(parserData* data,std::string element)
bool GUIFormSpecMenu::parseVersionDirect(std::string data)
{
//some prechecks
if (data == "")
return false;

std::vector<std::string> parts = split(data,'[');

if (parts.size() < 2) {
return false;
}

if (parts[0] != "formspec_version") {
return false;
}

if (is_number(parts[1])) {
m_formspec_version = mystoi(parts[1]);
return true;
}

return false;
}

void GUIFormSpecMenu::parseElement(parserData* data, std::string element)
{
//some prechecks
if (element == "")
Expand Down Expand Up @@ -1763,10 +1828,18 @@ void GUIFormSpecMenu::regenerateGui(v2u32 screensize)
m_tooltip_element->grab();
}


std::vector<std::string> elements = split(m_formspec_string,']');
for (unsigned int i=0; i< elements.size(); i++) {
parseElement(&mydata,elements[i]);
unsigned int i = 0;

/* try to read version from first element only */
if (elements.size() >= 1) {
if ( parseVersionDirect(elements[0]) ) {
i++;
}
}

for (; i< elements.size(); i++) {
parseElement(&mydata, elements[i]);
}

// If there's fields, add a Proceed button
Expand Down Expand Up @@ -2167,12 +2240,12 @@ void GUIFormSpecMenu::drawMenu()
m_tooltip_element->setVisible(true);
this->bringToFront(m_tooltip_element);
break;
}
}
}
}
}

skip_tooltip:
skip_tooltip:
/*
Draw dragged item stack
*/
Expand Down
5 changes: 4 additions & 1 deletion src/guiFormSpecMenu.h
View file
Expand Up @@ -28,6 +28,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
#include "inventorymanager.h"
#include "modalMenu.h"
#include "guiTable.h"
#include "clientserver.h"

class IGameDef;
class InventoryManager;
Expand Down Expand Up @@ -339,6 +340,7 @@ class GUIFormSpecMenu : public GUIModalMenu
TextDest *m_text_dst;
GUIFormSpecMenu **m_ext_ptr;
gui::IGUIFont *m_font;
unsigned int m_formspec_version;

typedef struct {
v2s32 size;
Expand Down Expand Up @@ -390,6 +392,7 @@ class GUIFormSpecMenu : public GUIModalMenu
void parseBackgroundColor(parserData* data,std::string element);
void parseListColors(parserData* data,std::string element);
void parseTooltip(parserData* data,std::string element);
bool parseVersionDirect(std::string data);

/**
* check if event is part of a double click
Expand Down Expand Up @@ -420,7 +423,7 @@ class FormspecFormSource: public IFormSource
{}

void setForm(std::string formspec) {
m_formspec = formspec;
m_formspec = FORMSPEC_VERSION_STRING + formspec;
}

std::string getForm()
Expand Down

0 comments on commit ebf7ea5

Please sign in to comment.