AcediaFramework
/
Futility
1
0
Fork 0
Code Issues 3 Pull Requests Projects Releases Wiki Activity
Browse Source

Add working, but dirty "feature editconfig"

feature_improvement
Anton Tarasenko 2 years ago
parent
e01a257409
commit
6597c17c51
2 changed files with 372 additions and 7 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 284
      sources/Commands/ACommandFeature.uc
  2. 91
      sources/Commands/ACommandFeature_Announcer.uc

284
sources/Commands/ACommandFeature.uc
Unescape View File

@ -20,13 +20,25 @@
class ACommandFeature extends Command;
// TODO: autoconf, newconf, deleteconf, setconf
// TODO: when displaying features - display which one is enabled
struct EditedConfigs
{
var class<Feature> featureClass;
var HashTable pendingSaves;
};
var private array<EditedConfigs> configEdits;
var private ACommandFeature_Announcer announcer;
protected function Finalizer()
{
local int i;
_.memory.Free(announcer);
for (i = 0; i < configEdits.length; i ++) {
_.memory.Free(configEdits[i].pendingSaves);
}
configEdits.length = 0;
super.Finalizer();
}
@ -43,6 +55,14 @@ protected function BuildData(CommandDataBuilder builder)
builder.SubCommand(P("disable"))
.ParamText(P("feature"))
.Describe(P("Disables specified <feature>."));
builder.SubCommand(P("showconf"))
.ParamText(P("feature"))
.ParamText(P("config"));
builder.SubCommand(P("editconf"))
.ParamText(P("feature"))
.ParamText(P("config"))
.ParamText(P("variable path"))
.ParamRemainder(P("value"));
announcer = ACommandFeature_Announcer(
_.memory.Allocate(class'ACommandFeature_Announcer'));
}
@ -62,6 +82,20 @@ protected function Executed(CallData arguments, EPlayer instigator)
else if (arguments.subCommandName.Compare(P("disable"))) {
DisableFeature(arguments.parameters.GetText(P("feature")));
}
else if (arguments.subCommandName.Compare(P("showconf")))
{
ShowFeatureConfig(
arguments.parameters.GetText(P("feature")),
arguments.parameters.GetText(P("config")));
}
else if (arguments.subCommandName.Compare(P("editconf")))
{
EditFeatureConfig(
arguments.parameters.GetText(P("feature")),
arguments.parameters.GetText(P("config")),
arguments.parameters.GetText(P("variable path")),
arguments.parameters.GetText(P("value")));
}
}
protected function EnableFeature(BaseText featureName, BaseText configParameter)
@ -77,7 +111,7 @@ protected function EnableFeature(BaseText featureName, BaseText configParameter)
}
wasEnabled = featureClass.static.IsEnabled();
oldConfig = featureClass.static.GetCurrentConfig();
newConfig = GetConfigFromParameter(configParameter, featureClass);
newConfig = PickConfigBasedOnParameter(featureClass, configParameter);
// Already enabled with the same config!
if (oldConfig != none && oldConfig.Compare(newConfig, SCASE_INSENSITIVE))
{
@ -122,9 +156,45 @@ protected function DisableFeature(Text featureName)
}
}
protected function Text GetConfigFromParameter(
BaseText configParameter,
class<Feature> featureClass)
protected function ShowFeatureConfig(
BaseText featureName,
BaseText configParameter)
{
local MutableText dataAsJSON;
local HashTable currentData, pendingData;
local class<Feature> featureClass;
featureClass = LoadFeatureClass(featureName);
if (featureClass == none) return;
if (configParameter == none) return;
currentData = GetCurrentConfigData(featureClass, configParameter);
if (currentData == none)
{
announcer.AnnounceFailedNoDataForConfig(featureClass, configParameter);
return;
}
// Display current data
dataAsJSON = _.json.PrettyPrint(currentData);
announcer.AnnounceCurrentConfig(featureClass, configParameter);
callerConsole.Flush().WriteLine(dataAsJSON);
_.memory.Free(dataAsJSON);
// Display pending data
pendingData = GetPendingConfigData(featureClass, configParameter);
if (pendingData != none)
{
dataAsJSON = _.json.PrettyPrint(pendingData);
announcer.AnnouncePendingConfig(featureClass, configParameter);
callerConsole.Flush().WriteLine(dataAsJSON);
_.memory.Free(dataAsJSON);
}
_.memory.Free(pendingData);
_.memory.Free(currentData);
}
protected function Text PickConfigBasedOnParameter(
class<Feature> featureClass,
BaseText configParameter)
{
local Text resolvedConfig;
local class<FeatureConfig> configClass;
@ -240,6 +310,210 @@ protected function ShowFeature(class<Feature> feature)
_.memory.Free(autoConfig);
_.memory.Free(builder);
}
//TODO: find where `null` spam is from
//TODO add failure color to fail announcements and good color to good ones - add them too!
protected function EditFeatureConfig(
BaseText featureName,
BaseText configParameter,
BaseText pathToValue,
BaseText newValue)
{
local int arrayIndex;
local Text topValue;
local HashTable pendingData;
local JSONPointer pointer;
local Parser parser;
local AcediaObject jsonValue, container;
local class<Feature> featureClass;
featureClass = LoadFeatureClass(featureName);
if (featureClass == none) {
return;
}
pendingData = GetPendingConfigData(featureClass, configParameter, true);
if (pendingData == none)
{
announcer.AnnounceFailedConfigMissing(configParameter);
return;
}
// Get guaranteed not-`none` JSON value
parser = newValue.Parse();
jsonValue = _.json.ParseWith(parser);
parser.FreeSelf();
if (jsonValue == none) {
jsonValue = newValue.Copy();
}
//
pointer = _.json.Pointer(pathToValue);
if (pointer.IsEmpty())
{
if (jsonValue.class != class'HashTable') {
announcer.AnnounceFailedExpectedObject();
}
else {
ChangePendingConfigData(featureClass, configParameter, HashTable(jsonValue));
}
jsonValue.FreeSelf();
return;
}
topValue = pointer.Pop();
container = pendingData.GetItemByJSON(pointer);
if (container == none)
{
announcer.AnnounceFailedBadPointer(featureClass, configParameter, pathToValue);
pointer.FreeSelf();
topValue.FreeSelf();
return;
}
if (HashTable(container) != none) {
HashTable(container).SetItem(topValue, jsonValue);
}
if (ArrayList(container) != none)
{
parser = topValue.Parse();
if (parser.MInteger(arrayIndex, 10).Ok()) {
ArrayList(container).SetItem(arrayIndex, jsonValue);
}
else if (topValue.Compare(P("-"))) {
ArrayList(container).AddItem(jsonValue);
}
else {
announcer.AnnounceFailedBadPointer(featureClass, configParameter, pathToValue);
}
parser.FreeSelf();
}
pointer.FreeSelf();
topValue.FreeSelf();
}
/*// TODO: autoconf, newconf, deleteconf, setconf
struct EditedConfigs
{
var class<Feature> featureClass;
var HashTable pendingSaves;
};
var private array<EditedConfigs> configEdits;*/
private function HashTable GetConfigData(
class<Feature> featureClass,
BaseText configName)
{
local HashTable result;
if (featureClass == none) return none;
if (configName == none) return none;
result = GetPendingConfigData(featureClass, configName);
if (result != none) {
return result;
}
return GetCurrentConfigData(featureClass, configName);
}
private function HashTable GetCurrentConfigData(
class<Feature> featureClass,
BaseText configName)
{
local class<FeatureConfig> configClass;
if (featureClass == none) return none;
if (configName == none) return none;
configClass = featureClass.default.configClass;
if (configClass == none)
{
announcer.AnnounceFailedNoConfigClass(featureClass);
return none;
}
return configClass.static.LoadData(configName);
}
private function int GetPendingConfigDataIndex(
class<Feature> featureClass)
{
local int i;
for (i = 0; i < configEdits.length; i ++)
{
if (configEdits[i].featureClass == featureClass) {
return i;
}
}
return -1;
}
private function ChangePendingConfigData(
class<Feature> featureClass,
BaseText configName,
HashTable newData)
{
local int editsIndex;
local Text lowerCaseConfigName;
if (newData == none) return;
if (configName == none) return;
editsIndex = GetPendingConfigDataIndex(featureClass);
if (editsIndex < 0) return;
lowerCaseConfigName = configName.LowerCopy();
configEdits[editsIndex].pendingSaves.SetItem(configName, newData);
lowerCaseConfigName.FreeSelf();
}
private function HashTable GetPendingConfigData(
class<Feature> featureClass,
BaseText configName,
optional bool createIfMissing)
{
local int editsIndex;
local Text lowerCaseConfigName;
local HashTable result;
local EditedConfigs newRecord;
if (featureClass == none) return none;
if (configName == none) return none;
lowerCaseConfigName = configName.LowerCopy();
editsIndex = GetPendingConfigDataIndex(featureClass);
if (editsIndex >= 0)
{
result = configEdits[editsIndex]
.pendingSaves
.GetHashTable(lowerCaseConfigName);
if (result != none)
{
lowerCaseConfigName.FreeSelf();
return result;
}
}
if (createIfMissing)
{
if (editsIndex < 0)
{
editsIndex = configEdits.length;
newRecord.featureClass = featureClass;
newRecord.pendingSaves = _.collections.EmptyHashTable();
configEdits[editsIndex] = newRecord;
}
result = GetCurrentConfigData(featureClass, configName);
if (result != none)
{
configEdits[editsIndex]
.pendingSaves
.SetItem(lowerCaseConfigName, result);
}
}
lowerCaseConfigName.FreeSelf();
return result;
}
// 3. Add `editconf` subcommand
// 4. Add '*' for edited configs in feature display
// 5. Add `saveconf` and `--save` flag
// 6. Add `removeconf`
// 7. Add `newconf`
// 8. Add `autoconf` for setting auto config
defaultproperties
{

91
sources/Commands/ACommandFeature_Announcer.uc
Unescape View File

@ -21,17 +21,22 @@ class ACommandFeature_Announcer extends CommandAnnouncer;
var private AnnouncementVariations enabledFeature, disabledFeature;
var private AnnouncementVariations swappedConfig;
var private AnnouncementVariations showCurrentConfig, showPendingConfig;
var private AnnouncementVariations failedToLoadFeatureClass;
var private AnnouncementVariations failedNoConfigProvided, failedConfigMissing;
var private AnnouncementVariations failedCannotEnableFeature;
var private AnnouncementVariations failedNoConfigClass;
var private AnnouncementVariations failedAlreadyEnabled, failedAlreadyDisabled;
var private AnnouncementVariations failedNoDataForConfig, failedExpectedObject;
var private AnnouncementVariations failedBadPointer;
protected function Finalizer()
{
FreeVariations(enabledFeature);
FreeVariations(disabledFeature);
FreeVariations(swappedConfig);
FreeVariations(showCurrentConfig);
FreeVariations(showPendingConfig);
FreeVariations(failedToLoadFeatureClass);
FreeVariations(failedNoConfigProvided);
FreeVariations(failedConfigMissing);
@ -39,6 +44,9 @@ protected function Finalizer()
FreeVariations(failedNoConfigClass);
FreeVariations(failedAlreadyEnabled);
FreeVariations(failedAlreadyDisabled);
FreeVariations(failedNoDataForConfig);
FreeVariations(failedExpectedObject);
FreeVariations(failedBadPointer);
super.Finalizer();
}
@ -117,6 +125,40 @@ public final function AnnounceSwappedConfig(
MakeAnnouncement(swappedConfig);
}
public final function AnnounceCurrentConfig(
class<Feature> featureClass,
BaseText config)
{
if (!showCurrentConfig.initialized)
{
showCurrentConfig.initialized = true;
showCurrentConfig.toSelfReport = _.text.MakeTemplate_S(
"Current config \"%2\" for feature {$TextEmphasis `%1`}:");
}
showCurrentConfig.toSelfReport
.Reset()
.ArgClass(featureClass)
.Arg(config);
MakeAnnouncement(showCurrentConfig);
}
public final function AnnouncePendingConfig(
class<Feature> featureClass,
BaseText config)
{
if (!showPendingConfig.initialized)
{
showPendingConfig.initialized = true;
showPendingConfig.toSelfReport = _.text.MakeTemplate_S(
"Pending config \"%2\" for feature {$TextEmphasis `%1`}:");
}
showPendingConfig.toSelfReport
.Reset()
.ArgClass(featureClass)
.Arg(config);
MakeAnnouncement(showPendingConfig);
}
public final function AnnounceFailedToLoadFeatureClass(BaseText failedClassName)
{
if (!failedToLoadFeatureClass.initialized)
@ -219,6 +261,55 @@ public final function AnnounceFailedAlreadyEnabled(
MakeAnnouncement(failedAlreadyEnabled);
}
public final function AnnounceFailedNoDataForConfig(
class<Feature> featureClass,
BaseText config)
{
if (!failedNoDataForConfig.initialized)
{
failedNoDataForConfig.initialized = true;
failedNoDataForConfig.toSelfReport = _.text.MakeTemplate_S(
"Feature {$TextEmphasis `%1`} is missing data for config \"%2\"");
}
failedNoDataForConfig.toSelfReport
.Reset()
.ArgClass(featureClass)
.Arg(config);
MakeAnnouncement(failedNoDataForConfig);
}
public final function AnnounceFailedExpectedObject()
{
if (!failedExpectedObject.initialized)
{
failedExpectedObject.initialized = true;
failedExpectedObject.toSelfReport = _.text.MakeTemplate_S(
"When changing the value of the whole config, a JSON object must be"
@ "provided");
}
MakeAnnouncement(failedExpectedObject);
}
public final function AnnounceFailedBadPointer(
class<Feature> featureClass,
BaseText config,
BaseText pointer)
{
if (!failedBadPointer.initialized)
{
failedBadPointer.initialized = true;
failedBadPointer.toSelfReport = _.text.MakeTemplate_S(
"Provided JSON pointer \"%3\" is invalid for config \"%2\" of"
@ "feature {$TextEmphasis `%1`}");
}
failedBadPointer.toSelfReport
.Reset()
.ArgClass(featureClass)
.Arg(config)
.Arg(pointer);
MakeAnnouncement(failedBadPointer);
}
defaultproperties
{
}
Write Preview
Loading…
Cancel
Save