Initial release
This commit is contained in:
civ
@@ -0,0 +1,423 @@
|
||||
//-----------------------------------------------------------------------------
|
||||
// Project : VST SDK
|
||||
//
|
||||
// Category : Helpers
|
||||
// Filename : public.sdk/source/vst/vstrepresentation.cpp
|
||||
// Created by : Steinberg, 08/2010
|
||||
// Description : VST Representation Helper
|
||||
//
|
||||
//-----------------------------------------------------------------------------
|
||||
// This file is part of a Steinberg SDK. It is subject to the license terms
|
||||
// in the LICENSE file found in the top-level directory of this distribution
|
||||
// and at www.steinberg.net/sdklicenses.
|
||||
// No part of the SDK, including this file, may be copied, modified, propagated,
|
||||
// or distributed except according to the terms contained in the LICENSE file.
|
||||
//-----------------------------------------------------------------------------
|
||||
|
||||
#include "vstrepresentation.h"
|
||||
|
||||
#include "base/source/fstring.h"
|
||||
#include "pluginterfaces/base/ibstream.h"
|
||||
|
||||
namespace Steinberg {
|
||||
namespace Vst {
|
||||
|
||||
#define START_TAG_STRING(string) "<" string ">"
|
||||
#define END_TAG_STRING(string) "</" string ">"
|
||||
#define MEDIUM_TITLE_LIMIT 8
|
||||
#define SHORT_TITLE_LIMIT 4
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
struct StringWriter
|
||||
{
|
||||
StringWriter (IBStream* stream) : stream (stream) {}
|
||||
|
||||
void write (const ConstString& str)
|
||||
{
|
||||
stream->write (const_cast<char8*> (str.text8 ()), str.length (), nullptr);
|
||||
}
|
||||
|
||||
IBStream* stream;
|
||||
};
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
// XmlRepresentationHelper Implementation
|
||||
//------------------------------------------------------------------------
|
||||
XmlRepresentationHelper::XmlRepresentationHelper (const Vst::RepresentationInfo& info,
|
||||
const FIDString companyName,
|
||||
const FIDString pluginName, const TUID& pluginUID,
|
||||
IBStream* stream)
|
||||
: stream (stream)
|
||||
{
|
||||
StringWriter writer (stream);
|
||||
String string;
|
||||
writer.write (R"(<?xml version="1.0" encoding="UTF-8"?>)");
|
||||
writer.write (ENDLINE_A);
|
||||
string.printf (
|
||||
R"(<!DOCTYPE %s PUBLIC "-//Steinberg//DTD VST Remote 1.1//EN" "http://dtd.steinberg.net/VST-Remote-1.1.dtd">)",
|
||||
ROOTXML_TAG);
|
||||
writer.write (string.text8 ());
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
string.printf ("<%s %s=\"1.0\">", ROOTXML_TAG, ATTR_VERSION);
|
||||
writer.write (string.text8 ());
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
//---Plug-in Tag----------------
|
||||
FUID uid (pluginUID);
|
||||
char uidText[33];
|
||||
uid.toString (uidText);
|
||||
|
||||
string.printf (R"(<%s %s="%s" %s="%s" %s="%s"/>)", PLUGIN_TAG, ATTR_CLASSID, uidText,
|
||||
ATTR_NAME, pluginName, ATTR_VENDOR, companyName);
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
//---Representation Tag----------------
|
||||
string.printf ("\t<%s", REPRESENTATION_TAG);
|
||||
writer.write (string);
|
||||
string.printf (" %s=\"%s\"", ATTR_NAME, info.name);
|
||||
writer.write (string);
|
||||
string.printf (" %s=\"%s\"", ATTR_VENDOR, info.vendor);
|
||||
writer.write (string);
|
||||
string.printf (" %s=\"%s\"", ATTR_VERSION, info.version);
|
||||
writer.write (string);
|
||||
if (strcmp ((char*)info.host, "") != 0)
|
||||
{
|
||||
string.printf (" %s=\"%s\"", ATTR_HOST, info.host);
|
||||
writer.write (string);
|
||||
}
|
||||
writer.write (">");
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
state = kInRepresentation;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
XmlRepresentationHelper::~XmlRepresentationHelper ()
|
||||
{
|
||||
if (state == kInLayer)
|
||||
endLayer ();
|
||||
if (state == kInCell)
|
||||
endCell ();
|
||||
if (state == kInPage)
|
||||
endPage ();
|
||||
|
||||
StringWriter writer (stream);
|
||||
String string;
|
||||
|
||||
// end representation
|
||||
string.printf ("\t%s", END_TAG_STRING (REPRESENTATION_TAG));
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
// end piper
|
||||
writer.write (END_TAG_STRING (ROOTXML_TAG));
|
||||
writer.write (ENDLINE_A);
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::checkState (int32 newState)
|
||||
{
|
||||
if (newState - state == 1 || state - newState == 1) // we go down or up
|
||||
{
|
||||
state = newState;
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::startPage (FIDString name, int32 unitID)
|
||||
{
|
||||
if (!checkState (kInPage))
|
||||
return false;
|
||||
|
||||
StringWriter writer (stream);
|
||||
String string;
|
||||
if (unitID != -1)
|
||||
string.printf (R"(<%s %s="%s" %s="%d">)", PAGE_TAG, ATTR_NAME, name, ATTR_UNITID, unitID);
|
||||
else
|
||||
string.printf ("<%s %s=\"%s\">", PAGE_TAG, ATTR_NAME, name);
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::endPage ()
|
||||
{
|
||||
if (!checkState (kInRepresentation))
|
||||
return false;
|
||||
|
||||
StringWriter writer (stream);
|
||||
String string;
|
||||
string.printf ("%s", END_TAG_STRING (PAGE_TAG));
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::startCell ()
|
||||
{
|
||||
if (!checkState (kInCell))
|
||||
return false;
|
||||
|
||||
StringWriter writer (stream);
|
||||
String string;
|
||||
string.printf ("%s", START_TAG_STRING (CELL_TAG));
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::endCell ()
|
||||
{
|
||||
if (!checkState (kInPage))
|
||||
return false;
|
||||
|
||||
StringWriter writer (stream);
|
||||
String string;
|
||||
string.printf ("%s", END_TAG_STRING (CELL_TAG));
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::startEndCell ()
|
||||
{
|
||||
if (!checkState (kInCell))
|
||||
return false;
|
||||
|
||||
StringWriter writer (stream);
|
||||
String string;
|
||||
string.printf ("<%s/>", CELL_TAG);
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
if (!checkState (kInPage))
|
||||
return false;
|
||||
return true;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::startLayer (int32 type, int32 id, FIDString _function,
|
||||
FIDString style)
|
||||
{
|
||||
return startLayer (type, id, _function, style, false);
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::endLayer ()
|
||||
{
|
||||
if (!checkState (kInCell))
|
||||
return false;
|
||||
|
||||
StringWriter writer (stream);
|
||||
String string;
|
||||
string.printf ("%s", END_TAG_STRING (LAYER_TAG));
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::startEndLayer (int32 type, int32 id, FIDString _function,
|
||||
FIDString style)
|
||||
{
|
||||
return startLayer (type, id, _function, style, true);
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::startLayer (int32 type, int32 id, FIDString _function,
|
||||
FIDString style, bool ended)
|
||||
{
|
||||
if (!checkState (kInLayer))
|
||||
return false;
|
||||
|
||||
StringWriter writer (stream);
|
||||
String string;
|
||||
|
||||
string.printf (R"(<%s %s="%s" %s="%d")", LAYER_TAG, ATTR_TYPE,
|
||||
Vst::LayerType::layerTypeFIDString[type], ATTR_PARAMID, id);
|
||||
writer.write (string);
|
||||
|
||||
if (_function)
|
||||
{
|
||||
string.printf (" %s=\"%s\"", Vst::Attributes::kFunction, _function);
|
||||
writer.write (string);
|
||||
}
|
||||
if (style)
|
||||
{
|
||||
string = Vst::LayerType::layerTypeFIDString[type];
|
||||
if (type == Vst::LayerType::kSwitch)
|
||||
string.printf (" %s=\"%s\"", Vst::Attributes::kSwitchStyle, style);
|
||||
else if (type == Vst::LayerType::kLED)
|
||||
string.printf (" %s=\"%s\"", Vst::Attributes::kLEDStyle, style);
|
||||
else
|
||||
string.printf (" %s=\"%s\"", Vst::Attributes::kStyle, style);
|
||||
writer.write (string);
|
||||
}
|
||||
|
||||
if (ended)
|
||||
{
|
||||
writer.write ("/>");
|
||||
if (!checkState (kInCell))
|
||||
return false;
|
||||
}
|
||||
else
|
||||
writer.write (">");
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::startEndCellOneLayer (int32 type, int32 id, FIDString _function,
|
||||
FIDString style)
|
||||
{
|
||||
if (!startCell ())
|
||||
return false;
|
||||
startEndLayer (type, id, _function, style);
|
||||
endCell ();
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::startLayer (Vst::ParameterInfo& info, FIDString _function)
|
||||
{
|
||||
return startLayer (info, _function, false);
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::startLayer (Vst::ParameterInfo& info, FIDString _function, bool ended)
|
||||
{
|
||||
FIDString style = nullptr;
|
||||
int32 type = Vst::LayerType::kKnob;
|
||||
if (info.flags & Vst::ParameterInfo::kIsReadOnly)
|
||||
type = Vst::LayerType::kLED;
|
||||
else if (info.stepCount == 1)
|
||||
{
|
||||
type = Vst::LayerType::kSwitch;
|
||||
style = Vst::AttributesStyle::kSwitchPushIncLoopedStyle;
|
||||
}
|
||||
|
||||
return startLayer (type, static_cast<int32> (info.id), _function, style, ended);
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::startEndLayer (Vst::ParameterInfo& info, FIDString _function)
|
||||
{
|
||||
return startLayer (info, _function, true);
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::startEndCellOneLayer (Vst::ParameterInfo& info, FIDString _function)
|
||||
{
|
||||
if (!startCell ())
|
||||
return false;
|
||||
startEndLayer (info, _function);
|
||||
endCell ();
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::startEndCellOneLayerWithParamName (Vst::ParameterInfo& info,
|
||||
FIDString _function /*= 0*/)
|
||||
{
|
||||
if (!startCell ())
|
||||
return false;
|
||||
startLayer (info, _function, false);
|
||||
startEndTitleDisplay (info);
|
||||
endLayer ();
|
||||
endCell ();
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
bool XmlRepresentationHelper::startEndTitleDisplay (Vst::ParameterInfo& info)
|
||||
{
|
||||
String nameString (info.title);
|
||||
|
||||
if (nameString.isEmpty ())
|
||||
return false;
|
||||
|
||||
if (!checkState (kInTitleDisplay))
|
||||
return false;
|
||||
|
||||
StringWriter writer (stream);
|
||||
String string;
|
||||
|
||||
string.printf ("<%s>", TITLEDISPLAY_TAG);
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
// start of name scope
|
||||
|
||||
if (!checkState (kInName))
|
||||
{
|
||||
string.printf ("%s", END_TAG_STRING (TITLEDISPLAY_TAG));
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
return false;
|
||||
}
|
||||
|
||||
string.printf ("<%s>%s</%s>", NAME_TAG, nameString.text8 (), NAME_TAG);
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
if (nameString.length () > MEDIUM_TITLE_LIMIT)
|
||||
{
|
||||
nameString.assign (info.shortTitle);
|
||||
|
||||
if (!nameString.isEmpty ())
|
||||
{
|
||||
nameString.removeChars (); // remove space
|
||||
|
||||
if (nameString.length () > MEDIUM_TITLE_LIMIT)
|
||||
nameString.remove (MEDIUM_TITLE_LIMIT); // Trimming the rest to get a short string
|
||||
|
||||
string.printf ("<%s>%s</%s>", NAME_TAG, nameString.text8 (), NAME_TAG);
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
}
|
||||
}
|
||||
|
||||
if (nameString.length () > SHORT_TITLE_LIMIT)
|
||||
{
|
||||
nameString.remove (SHORT_TITLE_LIMIT); // Trimming the rest to get a short string
|
||||
|
||||
string.printf ("<%s>%s</%s>", NAME_TAG, nameString.text8 (), NAME_TAG);
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
}
|
||||
|
||||
if (!checkState (kInTitleDisplay))
|
||||
return false;
|
||||
|
||||
// end of name scope
|
||||
|
||||
string.printf ("%s", END_TAG_STRING (TITLEDISPLAY_TAG));
|
||||
writer.write (string);
|
||||
writer.write (ENDLINE_A);
|
||||
|
||||
if (!checkState (kInLayer))
|
||||
return false;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
//------------------------------------------------------------------------
|
||||
} // namespace Vst
|
||||
} // namespace Steinberg
|
||||
Reference in New Issue
Block a user