shylie/llvm-project
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
llvm-project/lldb/source/Core/UserSettingsController.cpp
Greg Clayton b9556acc9e SBFrame is now threadsafe using some extra tricks. One issue is that stack 
frames might go away (the object itself, not the actual logical frame) when
we are single stepping due to the way we currently sometimes end up flushing
frames when stepping in/out/over. They later will come back to life 
represented by another object yet they have the same StackID. Now when you get
a lldb::SBFrame object, it will track the frame it is initialized with until 
the thread goes away or the StackID no longer exists in the stack for the 
thread it was created on. It uses a weak_ptr to both the frame and thread and
also stores the StackID. These three items allow us to determine when the
stack frame object has gone away (the weak_ptr will be NULL) and allows us to
find the correct frame again. In our test suite we had such cases where we
were just getting lucky when something like this happened:

1 - stop at breakpoint
2 - get first frame in thread where we stopped
3 - run an expression that causes the program to JIT and run code
4 - run more expressions on the frame from step 2 which was very very luckily
    still around inside a shared pointer, yet, not part of the current 
    thread (a new stack frame object had appeared with the same stack ID and
    depth). 
    
We now avoid all such issues and properly keep up to date, or we start 
returning errors when the frame doesn't exist and always responds with
invalid answers.

Also fixed the UserSettingsController  (not going to rewrite this just yet)
so that it doesn't crash on shutdown. Using weak_ptr's came in real handy to
track when the master controller has already gone away and this allowed me to
pull out the previous NotifyOwnerIsShuttingDown() patch as it is no longer 
needed.

llvm-svn: 149231
2012-01-30 07:41:31 +00:00

2502 lines
88 KiB
C++
Raw Blame History

//====-- UserSettingsController.cpp ------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include <string.h>
#include <algorithm>
#include "lldb/Core/UserSettingsController.h"
#include "lldb/Core/Error.h"
#include "lldb/Core/RegularExpression.h"
#include "lldb/Core/Stream.h"
#include "lldb/Core/StreamString.h"
#include "lldb/Interpreter/CommandInterpreter.h"
using namespace lldb;
using namespace lldb_private;
static void
DumpSettingEntry (CommandInterpreter &interpreter,
Stream &strm,
const uint32_t max_len,
const SettingEntry &entry)
{
StreamString description;
if (entry.description)
description.Printf ("%s", entry.description);
if (entry.default_value && entry.default_value[0])
description.Printf (" (default: %s)", entry.default_value);
interpreter.OutputFormattedHelpText (strm,
entry.var_name,
"--",
description.GetData(),
max_len);
if (entry.enum_values && entry.enum_values[0].string_value)
{
interpreter.OutputFormattedHelpText (strm,
"",
" ",
"Enumeration values:",
max_len);
for (uint32_t enum_idx=0; entry.enum_values[enum_idx].string_value != NULL; ++enum_idx)
{
description.Clear();
if (entry.enum_values[enum_idx].usage)
description.Printf ("%s = %s",
entry.enum_values[enum_idx].string_value,
entry.enum_values[enum_idx].usage);
else
description.Printf ("%s", entry.enum_values[enum_idx].string_value);
interpreter.OutputFormattedHelpText (strm,
"",
" ",
description.GetData(),
max_len);
}
}
}
UserSettingsController::UserSettingsController (const char *level_name,
const UserSettingsControllerSP &parent) :
m_default_settings (),
m_settings (),
m_children (),
m_pending_settings (),
m_live_settings (),
m_children_mutex (Mutex::eMutexTypeNormal),
m_pending_settings_mutex (Mutex::eMutexTypeRecursive),
m_live_settings_mutex (Mutex::eMutexTypeRecursive)
{
m_settings.parent = parent;
m_settings.level_name.SetCString (level_name);
}
UserSettingsController::~UserSettingsController ()
{
Mutex::Locker locker (m_live_settings_mutex);
m_live_settings.clear();
}
bool
UserSettingsController::SetGlobalVariable
(
const ConstString &var_name,
const char *index_value,
const char *value,
const SettingEntry &entry,
const VarSetOperationType op,
Error &err
)
{
err.SetErrorString ("UserSettingsController has no global settings");
return false;
}
bool
UserSettingsController::GetGlobalVariable
(
const ConstString &var_name,
StringList &value,
Error &err
)
{
return false;
}
bool
UserSettingsController::InitializeSettingsController (UserSettingsControllerSP &controller_sp,
SettingEntry *global_settings,
SettingEntry *instance_settings)
{
const UserSettingsControllerSP &parent = controller_sp->GetParent ();
if (parent)
parent->RegisterChild (controller_sp);
controller_sp->CreateSettingsVector (global_settings, true);
controller_sp->CreateSettingsVector (instance_settings, false);
controller_sp->InitializeGlobalVariables ();
controller_sp->CreateDefaultInstanceSettings ();
return true;
}
void
UserSettingsController::FinalizeSettingsController (UserSettingsControllerSP &controller_sp)
{
const UserSettingsControllerSP &parent = controller_sp->GetParent ();
if (parent)
parent->RemoveChild (controller_sp);
}
void
UserSettingsController::InitializeGlobalVariables ()
{
int num_entries;
const char *prefix = GetLevelName().GetCString();
num_entries = m_settings.global_settings.size();
for (int i = 0; i < num_entries; ++i)
{
const SettingEntry &entry = m_settings.global_settings[i];
if (entry.default_value != NULL)
{
StreamString full_name;
if (prefix[0] != '\0')
full_name.Printf ("%s.%s", prefix, entry.var_name);
else
full_name.Printf ("%s", entry.var_name);
SetVariable (full_name.GetData(), entry.default_value, eVarSetOperationAssign, false, "");
}
}
}
const UserSettingsControllerSP &
UserSettingsController::GetParent ()
{
return m_settings.parent;
}
void
UserSettingsController::RegisterChild (const UserSettingsControllerSP &child)
{
Mutex::Locker locker (m_children_mutex);
// Verify child is not already in m_children.
size_t num_children = m_children.size();
bool found = false;
for (size_t i = 0; i < num_children; ++i)
{
if (m_children[i].get() == child.get())
found = true;
}
// Add child to m_children.
if (! found)
m_children.push_back (child);
}
const ConstString &
UserSettingsController::GetLevelName ()
{
return m_settings.level_name;
}
size_t
UserSettingsController::GetNumChildren ()
{
return m_children.size();
}
const UserSettingsControllerSP
UserSettingsController::GetChildAtIndex (size_t index)
{
if (index < m_children.size())
return m_children[index];
UserSettingsControllerSP dummy_value;
return dummy_value;
}
const SettingEntry *
UserSettingsController::GetGlobalEntry (const ConstString &var_name)
{
for (int i = 0; i < m_settings.global_settings.size(); ++i)
{
const SettingEntry &entry = m_settings.global_settings[i];
ConstString entry_name (entry.var_name);
if (entry_name == var_name)
return &entry;
}
return NULL;
}
const SettingEntry *
UserSettingsController::GetInstanceEntry (const ConstString &const_var_name)
{
for (int i = 0; i < m_settings.instance_settings.size(); ++i)
{
SettingEntry &entry = m_settings.instance_settings[i];
ConstString entry_name (entry.var_name);
if (entry_name == const_var_name)
return &entry;
}
return NULL;
}
void
UserSettingsController::BuildParentPrefix (std::string &parent_prefix)
{
UserSettingsControllerSP parent = GetParent();
if (parent.get() != NULL)
{
parent->BuildParentPrefix (parent_prefix);
if (parent_prefix.length() > 0)
parent_prefix.append (".");
}
parent_prefix.append (GetLevelName().GetCString());
}
void
UserSettingsController::RemoveChild (const UserSettingsControllerSP &child)
{
Mutex::Locker locker (m_children_mutex);
std::vector<UserSettingsControllerSP>::iterator pos, end = m_children.end();
for (pos = m_children.begin(); pos != end; ++pos)
{
UserSettingsControllerSP entry = *pos;
if (entry == child)
{
m_children.erase (pos);
break;
}
}
}
Error
UserSettingsController::SetVariable (const char *full_dot_name,
const char *value,
const VarSetOperationType op,
const bool override,
const char *debugger_instance_name,
const char *index_value)
{
Error err;
ConstString const_var_name;
const ConstString &default_name = InstanceSettings::GetDefaultName();
Args names;
if (full_dot_name )
names = UserSettingsController::BreakNameIntoPieces (full_dot_name);
int num_pieces = names.GetArgumentCount();
if (num_pieces < 1)
{
err.SetErrorStringWithFormat ("'%s' is not a valid variable name; cannot assign value", full_dot_name);
return err;
}
ConstString prefix (names.GetArgumentAtIndex (0));
if ((prefix == m_settings.level_name)
|| (m_settings.level_name.GetLength() == 0))
{
if (prefix == m_settings.level_name)
{
names.Shift ();
num_pieces = names.GetArgumentCount();
}
if (num_pieces == 0)
{
err.SetErrorString ("no variable name specified, cannot assign value");
return err;
}
else if (num_pieces == 1)
{
// Must be one of the class-wide settings.
const_var_name.SetCString (names.GetArgumentAtIndex (0));
const SettingEntry *entry = GetGlobalEntry (const_var_name);
if (entry)
{
UserSettingsController::VerifyOperationForType (entry->var_type, op, const_var_name, err);
if (err.Fail())
return err;
if ((value == NULL || value[0] == '\0')
&& (op == eVarSetOperationAssign))
{
if (entry->var_type != eSetVarTypeEnum)
value = entry->default_value;
else
value = entry->enum_values[0].string_value;
}
SetGlobalVariable (const_var_name, index_value, value, *entry, op, err);
}
else
{
// MIGHT be instance variable, to be for ALL instances.
entry = GetInstanceEntry (const_var_name);
if (entry == NULL)
{
err.SetErrorStringWithFormat ("unable to find variable '%s.%s', cannot assign value",
prefix.GetCString(), const_var_name.GetCString());
return err;
}
else
{
UserSettingsController::VerifyOperationForType (entry->var_type, op, const_var_name, err);
if (err.Fail())
return err;
if ((value == NULL || value[0] == '\0')
&& (op == eVarSetOperationAssign))
{
if (entry->var_type != eSetVarTypeEnum)
value = entry->default_value;
else
value = entry->enum_values[0].string_value;
}
if ((m_settings.level_name.GetLength() > 0)
|| strlen (debugger_instance_name) == 0)
{
// Set the default settings
m_default_settings->UpdateInstanceSettingsVariable (const_var_name, index_value, value,
default_name, *entry, op, err, true);
}
else
{
// We're at the Debugger level; find the correct debugger instance and set those settings
StreamString tmp_name;
if (debugger_instance_name[0] != '[')
tmp_name.Printf ("[%s]", debugger_instance_name);
else
tmp_name.Printf ("%s", debugger_instance_name);
ConstString dbg_name (tmp_name.GetData());
InstanceSettings *dbg_settings = FindSettingsForInstance (dbg_name);
if (dbg_settings)
dbg_settings->UpdateInstanceSettingsVariable (const_var_name, index_value, value, dbg_name,
*entry, op, err, false);
}
if (override)
{
OverrideAllInstances (const_var_name, value, op, index_value, err);
// Update all pending records as well.
// std::map<std::string, InstanceSettingsSP>::iterator pos, end = m_pending_settings.end();
// for (pos = m_pending_settings.begin(); pos != end; end++)
// {
// const ConstString instance_name (pos->first.c_str());
// InstanceSettingsSP setting_sp = pos->second;
// setting_sp->UpdateInstanceSettingsVariable (const_var_name, index_value, value,
// instance_name, *entry, op, err, true);
// }
}
}
}
}
else
{
// Either a child's setting or an instance setting.
if (names.GetArgumentAtIndex(0)[0] == '[')
{
// An instance setting. Supposedly.
ConstString instance_name (names.GetArgumentAtIndex (0));
// First verify that there is only one more name.
names.Shift();
if (names.GetArgumentCount() != 1)
{
err.SetErrorStringWithFormat ("invalid variable name format '%s', cannot assign value",
full_dot_name);
return err;
}
// Next verify that it is a valid instance setting name.
const_var_name.SetCString (names.GetArgumentAtIndex (0));
const SettingEntry *entry = GetInstanceEntry (const_var_name);
if (entry == NULL)
{
err.SetErrorStringWithFormat ("unknown instance variable '%s', cannot assign value",
const_var_name.GetCString());
return err;
}
UserSettingsController::VerifyOperationForType (entry->var_type, op, const_var_name, err);
if (err.Fail())
return err;
if ((value == NULL || value[0] == '\0')
&& (op == eVarSetOperationAssign))
{
if (entry->var_type != eSetVarTypeEnum)
value = entry->default_value;
else
value = entry->enum_values[0].string_value;
}
// Now look for existing instance with given instance name; if not found, find or create pending
// setting for instance with given name.
InstanceSettings *current_settings = FindSettingsForInstance (instance_name);
if (current_settings != NULL)
{
current_settings->UpdateInstanceSettingsVariable (const_var_name, index_value, value,
instance_name, *entry, op, err, false);
}
else
{
// Instance does not currently exist; make or update a pending setting for it.
InstanceSettingsSP current_settings_sp = PendingSettingsForInstance (instance_name);
// Now we have a settings record, update it appropriately.
current_settings_sp->UpdateInstanceSettingsVariable (const_var_name, index_value, value,
instance_name, *entry, op, err, true);
{ // Scope for mutex.
Mutex::Locker locker (m_pending_settings_mutex);
m_pending_settings[instance_name.GetCString()] = current_settings_sp;
}
if (override)
{
OverrideAllInstances (const_var_name, value, op, index_value, err);
// Update all pending records as well.
std::map<std::string, InstanceSettingsSP>::iterator pos;
std::map<std::string, InstanceSettingsSP>::iterator end = m_pending_settings.end();
for (pos = m_pending_settings.begin(); pos != end; end++)
{
const ConstString tmp_inst_name (pos->first.c_str());
InstanceSettingsSP setting_sp = pos->second;
setting_sp->UpdateInstanceSettingsVariable (const_var_name, index_value, value,
tmp_inst_name, *entry, op, err, true);
}
}
}
}
else
{
// A child setting.
UserSettingsControllerSP child;
ConstString child_prefix (names.GetArgumentAtIndex (0));
int num_children = GetNumChildren();
bool found = false;
for (int i = 0; i < num_children && !found; ++i)
{
child = GetChildAtIndex (i);
ConstString current_prefix = child->GetLevelName();
if (current_prefix == child_prefix)
{
found = true;
std::string new_name;
for (int j = 0; j < names.GetArgumentCount(); ++j)
{
if (j > 0)
new_name += '.';
new_name += names.GetArgumentAtIndex (j);
}
return child->SetVariable (new_name.c_str(), value, op, override, debugger_instance_name,
index_value);
}
}
if (!found)
{
err.SetErrorStringWithFormat ("unable to find variable '%s', cannot assign value",
full_dot_name);
return err;
}
}
}
}
else
{
err.SetErrorStringWithFormat ("'%s' is not a valid level name; was expecting '%s', cannot assign value",
prefix.GetCString(), m_settings.level_name.GetCString());
}
return err;
}
StringList
UserSettingsController::GetVariable
(
const char *full_dot_name,
SettableVariableType &var_type,
const char *debugger_instance_name,
Error &err
)
{
StringList value;
if (!full_dot_name)
{
err.SetErrorString ("invalid variable name");
return value;
}
Args names = UserSettingsController::BreakNameIntoPieces (full_dot_name);
int num_pieces = names.GetArgumentCount();
ConstString const_var_name;
ConstString prefix (names.GetArgumentAtIndex (0));
const_var_name.SetCString (names.GetArgumentAtIndex (num_pieces - 1));
const SettingEntry *global_entry = GetGlobalEntry (const_var_name);
const SettingEntry *instance_entry = GetInstanceEntry (const_var_name);
if ((prefix != m_settings.level_name)
&& (m_settings.level_name.GetLength () > 0))
{
err.SetErrorString ("invalid variable name");
return value;
}
// prefix name matched; remove it from names.
if (m_settings.level_name.GetLength() > 0)
names.Shift();
// Should we pass this off to a child? If there is more than one name piece left, and the next name piece
// matches a child prefix, then yes.
UserSettingsControllerSP child;
if (names.GetArgumentCount() > 1)
{
ConstString child_prefix (names.GetArgumentAtIndex (0));
bool found = false;
for (int i = 0; i < m_children.size() && !found; ++i)
{
if (child_prefix == m_children[i]->GetLevelName())
{
found = true;
child = m_children[i];
std::string new_name;
for (int j = 0; j < names.GetArgumentCount(); ++j)
{
if (j > 0)
new_name += '.';
new_name += names.GetArgumentAtIndex (j);
}
return child->GetVariable (new_name.c_str(), var_type, debugger_instance_name, err);
}
}
if (!found)
{
// Cannot be handled by a child, because name did not match any child prefixes.
// Cannot be a class-wide variable because there are too many name pieces.
if (instance_entry != NULL)
{
var_type = instance_entry->var_type;
ConstString instance_name (names.GetArgumentAtIndex (0));
InstanceSettings *current_settings = FindSettingsForInstance (instance_name);
if (current_settings != NULL)
{
current_settings->GetInstanceSettingsValue (*instance_entry, const_var_name, value, &err);
}
else
{
// Look for instance name setting in pending settings.
std::string inst_name_str = instance_name.GetCString();
std::map<std::string, InstanceSettingsSP>::iterator pos;
pos = m_pending_settings.find (inst_name_str);
if (pos != m_pending_settings.end())
{
InstanceSettingsSP settings_sp = pos->second;
settings_sp->GetInstanceSettingsValue (*instance_entry, const_var_name, value, &err);
}
else
{
if (m_settings.level_name.GetLength() > 0)
{
// No valid instance name; assume they want the default settings.
m_default_settings->GetInstanceSettingsValue (*instance_entry, const_var_name, value, &err);
}
else
{
// We're at the Debugger level; use the debugger's instance settings.
StreamString tmp_name;
if (debugger_instance_name[0] != '[')
tmp_name.Printf ("[%s]", debugger_instance_name);
else
tmp_name.Printf ("%s", debugger_instance_name);
ConstString dbg_name (debugger_instance_name);
InstanceSettings *dbg_settings = FindSettingsForInstance (dbg_name);
if (dbg_settings)
dbg_settings->GetInstanceSettingsValue (*instance_entry, const_var_name, value, &err);
}
}
}
}
else
err.SetErrorString ("invalid variable name");
}
}
else
{
// Only one name left. It must belong to the current level, or be an error.
if ((global_entry == NULL)
&& (instance_entry == NULL))
{
err.SetErrorString ("invalid variable name");
}
else if (global_entry)
{
var_type = global_entry->var_type;
GetGlobalVariable (const_var_name, value, err);
}
else if (instance_entry)
{
var_type = instance_entry->var_type;
if (m_settings.level_name.GetLength() > 0)
m_default_settings->GetInstanceSettingsValue (*instance_entry, const_var_name, value, &err);
else
{
// We're at the Debugger level; use the debugger's instance settings.
StreamString tmp_name;
if (debugger_instance_name[0] != '[')
tmp_name.Printf ("[%s]", debugger_instance_name);
else
tmp_name.Printf ("%s", debugger_instance_name);
ConstString dbg_name (tmp_name.GetData());
InstanceSettings *dbg_settings = FindSettingsForInstance (dbg_name);
if (dbg_settings)
dbg_settings->GetInstanceSettingsValue (*instance_entry, const_var_name, value, &err);
}
}
}
return value;
}
void
UserSettingsController::RemovePendingSettings (const ConstString &instance_name)
{
StreamString tmp_name;
// Add surrounding brackets to instance name if not already present.
if (instance_name.GetCString()[0] != '[')
tmp_name.Printf ("[%s]", instance_name.GetCString());
else
tmp_name.Printf ("%s", instance_name.GetCString());
std::string instance_name_str (tmp_name.GetData());
std::map<std::string, InstanceSettingsSP>::iterator pos;
Mutex::Locker locker (m_pending_settings_mutex);
m_pending_settings.erase (instance_name_str);
}
const InstanceSettingsSP &
UserSettingsController::FindPendingSettings (const ConstString &instance_name)
{
std::map<std::string, InstanceSettingsSP>::iterator pos;
StreamString tmp_name;
// Add surrounding brackets to instance name if not already present.
if (instance_name.GetCString()[0] != '[')
tmp_name.Printf ("[%s]", instance_name.GetCString());
else
tmp_name.Printf ("%s", instance_name.GetCString());
std::string instance_name_str (tmp_name.GetData()); // Need std::string for std::map look-up
{ // Scope for mutex.
Mutex::Locker locker (m_pending_settings_mutex);
pos = m_pending_settings.find (instance_name_str);
if (pos != m_pending_settings.end())
return pos->second;
}
return m_default_settings;
}
void
UserSettingsController::CreateDefaultInstanceSettings ()
{
Error err;
const ConstString &default_instance_name = InstanceSettings::GetDefaultName();
for (int i = 0; i < m_settings.instance_settings.size(); ++i)
{
SettingEntry &entry = m_settings.instance_settings[i];
ConstString var_name (entry.var_name);
const char *default_value = entry.default_value;
// If there is no default value, then use the first enumeration value
// as the default value
if (default_value == NULL && entry.var_type == eSetVarTypeEnum)
default_value = entry.enum_values[0].string_value;
if (default_value != NULL)
m_default_settings->UpdateInstanceSettingsVariable (var_name,
NULL,
default_value,
default_instance_name,
entry,
eVarSetOperationAssign,
err,
true);
}
}
void
UserSettingsController::CopyDefaultSettings (const InstanceSettingsSP &actual_settings,
const ConstString &instance_name,
bool pending)
{
Error err;
for (int i = 0; i < m_settings.instance_settings.size(); ++i)
{
SettingEntry &entry = m_settings.instance_settings[i];
ConstString var_name (entry.var_name);
StringList value;
m_default_settings->GetInstanceSettingsValue (entry, var_name, value, NULL);
std::string value_str;
if (value.GetSize() == 1)
value_str.append (value.GetStringAtIndex (0));
else if (value.GetSize() > 1)
{
for (int j = 0; j < value.GetSize(); ++j)
{
if (j > 0)
value_str.append (" ");
value_str.append (value.GetStringAtIndex (j));
}
}
actual_settings->UpdateInstanceSettingsVariable (var_name, NULL, value_str.c_str(), instance_name, entry,
eVarSetOperationAssign, err, pending);
}
}
InstanceSettingsSP
UserSettingsController::PendingSettingsForInstance (const ConstString &instance_name)
{
std::string name_str (instance_name.GetCString());
std::map<std::string, InstanceSettingsSP>::iterator pos;
Mutex::Locker locker (m_pending_settings_mutex);
pos = m_pending_settings.find (name_str);
if (pos != m_pending_settings.end())
{
InstanceSettingsSP settings_sp = pos->second;
return settings_sp;
}
else
{
InstanceSettingsSP new_settings_sp = CreateInstanceSettings (instance_name.GetCString());
CopyDefaultSettings (new_settings_sp, instance_name, true);
m_pending_settings[name_str] = new_settings_sp;
return new_settings_sp;
}
// Should never reach this line.
InstanceSettingsSP dummy;
return dummy;
}
void
UserSettingsController::GetAllDefaultSettingValues (Stream &strm)
{
std::string parent_prefix;
BuildParentPrefix (parent_prefix);
for (int i = 0; i < m_settings.instance_settings.size(); ++i)
{
SettingEntry &entry = m_settings.instance_settings[i];
ConstString var_name (entry.var_name);
StringList value;
m_default_settings->GetInstanceSettingsValue (entry, var_name, value, NULL);
if (!parent_prefix.empty())
strm.Printf ("%s.", parent_prefix.c_str());
DumpValue (var_name.GetCString(),
entry.var_type,
value,
strm);
}
}
void
UserSettingsController::GetAllPendingSettingValues (Stream &strm)
{
std::map<std::string, InstanceSettingsSP>::iterator pos;
std::string parent_prefix;
BuildParentPrefix (parent_prefix);
const char *prefix = parent_prefix.c_str();
for (pos = m_pending_settings.begin(); pos != m_pending_settings.end(); ++pos)
{
std::string tmp_name = pos->first;
InstanceSettingsSP settings_sp = pos->second;
const ConstString instance_name (tmp_name.c_str());
for (int i = 0; i < m_settings.instance_settings.size(); ++i)
{
SettingEntry &entry = m_settings.instance_settings[i];
ConstString var_name (entry.var_name);
StringList tmp_value;
settings_sp->GetInstanceSettingsValue (entry, var_name, tmp_value, NULL);
StreamString value_str;
if (tmp_value.GetSize() == 1)
value_str.Printf ("%s", tmp_value.GetStringAtIndex (0));
else
{
for (int j = 0; j < tmp_value.GetSize(); ++j)
value_str.Printf ("%s ", tmp_value.GetStringAtIndex (j));
}
if (parent_prefix.length() > 0)
{
strm.Printf ("%s.%s.%s (%s) = '%s' [pending]\n", prefix, instance_name.GetCString(),
var_name.GetCString(), UserSettingsController::GetTypeString (entry.var_type),
value_str.GetData());
}
else
{
strm.Printf ("%s (%s) = '%s' [pending]\n", var_name.GetCString(),
UserSettingsController::GetTypeString (entry.var_type),
value_str.GetData());
}
}
}
}
InstanceSettings *
UserSettingsController::FindSettingsForInstance (const ConstString &instance_name)
{
std::string instance_name_str (instance_name.GetCString());
Mutex::Locker locker (m_live_settings_mutex);
InstanceSettingsMap::iterator pos = m_live_settings.find (instance_name_str);
if (pos != m_live_settings.end ())
return pos->second;
return NULL;
}
void
UserSettingsController::GetAllInstanceVariableValues (CommandInterpreter &interpreter,
Stream &strm)
{
std::string parent_prefix;
BuildParentPrefix (parent_prefix);
StreamString description;
Mutex::Locker locker (m_live_settings_mutex);
for (InstanceSettingsMap::iterator pos = m_live_settings.begin(); pos != m_live_settings.end(); ++pos)
{
std::string instance_name = pos->first;
InstanceSettings *settings = pos->second;
for (int i = 0; i < m_settings.instance_settings.size(); ++i)
{
SettingEntry &entry = m_settings.instance_settings[i];
const ConstString var_name (entry.var_name);
StringList tmp_value;
settings->GetInstanceSettingsValue (entry, var_name, tmp_value, NULL);
if (!parent_prefix.empty())
strm.Printf ("%s.", parent_prefix.c_str());
DumpValue(var_name.GetCString(), entry.var_type, tmp_value, strm);
}
}
}
void
UserSettingsController::OverrideAllInstances (const ConstString &var_name,
const char *value,
VarSetOperationType op,
const char *index_value,
Error &err)
{
StreamString description;
Mutex::Locker locker (m_live_settings_mutex);
for (InstanceSettingsMap::iterator pos = m_live_settings.begin(); pos != m_live_settings.end(); ++pos)
{
InstanceSettings *settings = pos->second;
StreamString tmp_name;
tmp_name.Printf ("[%s]", settings->GetInstanceName().GetCString());
const ConstString instance_name (tmp_name.GetData());
const SettingEntry *entry = GetInstanceEntry (var_name);
settings->UpdateInstanceSettingsVariable (var_name, index_value, value, instance_name, *entry, op, err, false);
}
}
void
UserSettingsController::RegisterInstanceSettings (InstanceSettings *instance_settings)
{
Mutex::Locker locker (m_live_settings_mutex);
StreamString tmp_name;
tmp_name.Printf ("[%s]", instance_settings->GetInstanceName().GetCString());
const ConstString instance_name (tmp_name.GetData());
std::string instance_name_str (instance_name.GetCString());
if (instance_name_str.compare (InstanceSettings::GetDefaultName().GetCString()) != 0)
m_live_settings[instance_name_str] = instance_settings;
}
void
UserSettingsController::UnregisterInstanceSettings (InstanceSettings *instance)
{
Mutex::Locker locker (m_live_settings_mutex);
StreamString tmp_name;
tmp_name.Printf ("[%s]", instance->GetInstanceName().GetCString());
std::string instance_name (tmp_name.GetData());
InstanceSettingsMap::iterator pos = m_live_settings.find (instance_name);
if (pos != m_live_settings.end())
m_live_settings.erase (pos);
}
void
UserSettingsController::CreateSettingsVector (const SettingEntry *table,
bool global)
{
int i = 0;
while (table[i].var_name != NULL)
{
const SettingEntry &table_entry = table[i];
ConstString const_var_name (table_entry.var_name);
SettingEntry new_entry;
new_entry = table_entry;
new_entry.var_name = const_var_name.GetCString();
if (global)
m_settings.global_settings.push_back (new_entry);
else
m_settings.instance_settings.push_back (new_entry);
++i;
}
}
//----------------------------------------------------------------------
// UserSettingsController static methods
//----------------------------------------------------------------------
int
FindMaxNameLength (std::vector<SettingEntry> table)
{
int max_length = 1;
for (int i = 0; i < table.size(); ++i)
{
int len = strlen (table[i].var_name);
if (len > max_length)
max_length = len;
}
return max_length;
}
const char *
UserSettingsController::GetTypeString (SettableVariableType var_type)
{
switch (var_type)
{
case eSetVarTypeInt:
return "int";
case eSetVarTypeBoolean:
return "boolean";
case eSetVarTypeString:
return "string";
case eSetVarTypeArray:
return "array";
case eSetVarTypeDictionary:
return "dictionary";
case eSetVarTypeEnum:
return "enum";
case eSetVarTypeNone:
return "no type";
}
return "";
}
void
UserSettingsController::PrintEnumValues (const OptionEnumValueElement *enum_values, Stream &str)
{
int i = 0;
while (enum_values[i].string_value != NULL)
{
str.Printf ("%s ", enum_values[i].string_value);
++i;
}
}
void
UserSettingsController::FindAllSettingsDescriptions (CommandInterpreter &interpreter,
const UserSettingsControllerSP& usc_sp,
const char *current_prefix,
Stream &strm,
Error &err)
{
// Write out current prefix line.
StreamString prefix_line;
StreamString description;
uint32_t max_len = FindMaxNameLength (usc_sp->m_settings.global_settings);
int num_entries = usc_sp->m_settings.global_settings.size();
if (current_prefix && current_prefix[0])
strm.Printf ("\n'%s' variables:\n\n", current_prefix);
else
strm.Printf ("\nTop level variables:\n\n");
if (num_entries > 0)
{
// Write out all "global" variables.
for (int i = 0; i < num_entries; ++i)
{
DumpSettingEntry (interpreter, strm, max_len, usc_sp->m_settings.global_settings[i]);
}
}
num_entries = usc_sp->m_settings.instance_settings.size();
max_len = FindMaxNameLength (usc_sp->m_settings.instance_settings);
if (num_entries > 0)
{
// Write out all instance variables.
for (int i = 0; i < num_entries; ++i)
{
DumpSettingEntry (interpreter, strm, max_len, usc_sp->m_settings.instance_settings[i]);
}
}
// Now, recurse across all children.
int num_children = usc_sp->GetNumChildren();
for (int i = 0; i < num_children; ++i)
{
UserSettingsControllerSP child = usc_sp->GetChildAtIndex (i);
if (child)
{
ConstString child_prefix = child->GetLevelName();
if (current_prefix && current_prefix[0])
{
StreamString new_prefix;
new_prefix.Printf ("%s.%s", current_prefix, child_prefix.GetCString());
UserSettingsController::FindAllSettingsDescriptions (interpreter,
child,
new_prefix.GetData(),
strm,
err);
}
else
{
UserSettingsController::FindAllSettingsDescriptions (interpreter,
child,
child_prefix.GetCString(),
strm,
err);
}
}
}
}
void
UserSettingsController::FindSettingsDescriptions (CommandInterpreter &interpreter,
const UserSettingsControllerSP& usc_sp,
const char *current_prefix,
const char *search_name,
Stream &strm,
Error &err)
{
Args names = UserSettingsController::BreakNameIntoPieces (search_name);
int num_pieces = names.GetArgumentCount ();
if (num_pieces == 0)
return;
if (usc_sp->GetLevelName().GetLength() > 0)
{
ConstString prefix (names.GetArgumentAtIndex (0));
if (prefix != usc_sp->GetLevelName())
{
std::string parent_prefix;
usc_sp->BuildParentPrefix (parent_prefix);
err.SetErrorStringWithFormat ("cannot find match for '%s.%s'", parent_prefix.c_str(),
prefix.GetCString());
return;
}
else
{
names.Shift();
--num_pieces;
}
}
// If there's nothing left then dump all global and instance descriptions for this root.
if (num_pieces == 0)
{
StreamString prefix_line;
StreamString description;
uint32_t max_len;
int num_entries = usc_sp->m_settings.global_settings.size();
max_len = FindMaxNameLength (usc_sp->m_settings.global_settings);
strm.Printf ("\n'%s' variables:\n\n", search_name);
if (num_entries > 0)
{
// Write out all "global" variables.
for (int i = 0; i < num_entries; ++i)
{
DumpSettingEntry (interpreter, strm, max_len, usc_sp->m_settings.global_settings[i]);
}
}
num_entries = usc_sp->m_settings.instance_settings.size();
max_len = FindMaxNameLength (usc_sp->m_settings.instance_settings);
if (num_entries > 0)
{
// Write out all instance variables.
for (int i = 0; i < num_entries; ++i)
{
DumpSettingEntry (interpreter, strm, max_len, usc_sp->m_settings.instance_settings[i]);
}
}
}
else if (num_pieces == 1)
{
ConstString var_name (names.GetArgumentAtIndex (0));
bool is_global = false;
const SettingEntry *setting_entry = usc_sp->GetGlobalEntry (var_name);
if (setting_entry == NULL)
setting_entry = usc_sp->GetInstanceEntry (var_name);
else
is_global = true;
// Check to see if it is a global or instance variable name.
if (setting_entry != NULL)
{
DumpSettingEntry (interpreter, strm, var_name.GetLength(), *setting_entry);
}
else
{
// It must be a child name.
int num_children = usc_sp->GetNumChildren();
bool found = false;
for (int i = 0; i < num_children && !found; ++i)
{
UserSettingsControllerSP child = usc_sp->GetChildAtIndex (i);
if (child)
{
ConstString child_prefix = child->GetLevelName();
if (child_prefix == var_name)
{
found = true;
UserSettingsController::FindSettingsDescriptions (interpreter,
child,
current_prefix,
var_name.GetCString(),
strm,
err);
}
}
}
if (!found)
{
std::string parent_prefix;
usc_sp->BuildParentPrefix (parent_prefix);
err.SetErrorStringWithFormat ("cannot find match for '%s.%s'", parent_prefix.c_str(), search_name);
return;
}
}
}
else
{
// It must be a child name; find the child and call this function recursively on child.
ConstString child_name (names.GetArgumentAtIndex (0));
StreamString rest_of_search_name;
for (int i = 0; i < num_pieces; ++i)
{
rest_of_search_name.Printf ("%s", names.GetArgumentAtIndex (i));
if ((i + 1) < num_pieces)
rest_of_search_name.Printf (".");
}
int num_children = usc_sp->GetNumChildren();
bool found = false;
for (int i = 0; i < num_children && !found; ++i)
{
UserSettingsControllerSP child = usc_sp->GetChildAtIndex (i);
if (child)
{
ConstString child_prefix = child->GetLevelName();
if (child_prefix == child_name)
{
found = true;
UserSettingsController::FindSettingsDescriptions (interpreter, child, current_prefix,
rest_of_search_name.GetData(), strm,
err);
}
}
}
if (!found)
{
std::string parent_prefix;
usc_sp->BuildParentPrefix (parent_prefix);
err.SetErrorStringWithFormat ("cannot find match for '%s.%s'", parent_prefix.c_str(), search_name);
return;
}
}
}
void
UserSettingsController::SearchAllSettingsDescriptions (CommandInterpreter &interpreter,
const UserSettingsControllerSP& usc_sp,
const char *current_prefix,
const char *search_word,
Stream &strm)
{
if ((search_word == NULL) || (strlen (search_word) == 0))
return;
int num_entries = usc_sp->m_settings.global_settings.size();
if (num_entries > 0)
{
for (int i = 0; i < num_entries; ++i)
{
const SettingEntry &entry = usc_sp->m_settings.global_settings[i];
if (strcasestr (entry.description, search_word) != NULL)
{
StreamString var_name;
if (current_prefix && current_prefix[0])
var_name.Printf ("%s.%s", current_prefix, entry.var_name);
else
var_name.Printf ("%s", entry.var_name);
interpreter.OutputFormattedHelpText (strm, var_name.GetData(), "--", entry.description,
var_name.GetSize());
}
}
}
num_entries = usc_sp->m_settings.instance_settings.size();
if (num_entries > 0)
{
for (int i = 0; i < num_entries; ++i)
{
SettingEntry &entry = usc_sp->m_settings.instance_settings[i];
if (strcasestr (entry.description, search_word) != NULL)
{
StreamString var_name;
if (current_prefix && current_prefix[0])
var_name.Printf ("%s.%s", current_prefix, entry.var_name);
else
var_name.Printf ("%s", entry.var_name);
interpreter.OutputFormattedHelpText (strm,
var_name.GetData(),
"--",
entry.description,
var_name.GetSize());
}
}
}
int num_children = usc_sp->GetNumChildren ();
for (int i = 0; i < num_children; ++i)
{
UserSettingsControllerSP child = usc_sp->GetChildAtIndex (i);
if (child)
{
ConstString child_prefix = child->GetLevelName();
if (current_prefix && current_prefix[0])
{
StreamString new_prefix;
new_prefix.Printf ("%s.%s", current_prefix, child_prefix.GetCString());
UserSettingsController::SearchAllSettingsDescriptions (interpreter,
child,
new_prefix.GetData(),
search_word,
strm);
}
else
{
UserSettingsController::SearchAllSettingsDescriptions (interpreter,
child,
child_prefix.GetCString(),
search_word,
strm);
}
}
}
}
bool
UserSettingsController::DumpValue (CommandInterpreter &interpreter,
const UserSettingsControllerSP& usc_sp,
const char *variable_dot_name,
Stream &strm)
{
SettableVariableType var_type;
Error err;
StringList value = usc_sp->GetVariable (variable_dot_name,
var_type,
interpreter.GetDebugger().GetInstanceName().GetCString(),
err);
if (err.Success())
return DumpValue (variable_dot_name, var_type, value, strm);
return false;
}
bool
UserSettingsController::DumpValue (const char *variable_dot_name,
SettableVariableType var_type,
const StringList &value,
Stream &strm)
{
const char *type_name = UserSettingsController::GetTypeString (var_type);
strm.Printf ("%s (%s) = ", variable_dot_name, type_name);
if (value.GetSize() == 0)
{
strm.EOL();
}
else
{
switch (var_type)
{
case eSetVarTypeNone:
case eSetVarTypeEnum:
case eSetVarTypeInt:
case eSetVarTypeBoolean:
strm.Printf ("%s\n", value.GetStringAtIndex (0));
break;
case eSetVarTypeString:
strm.Printf ("\"%s\"\n", value.GetStringAtIndex (0));
break;
case eSetVarTypeArray:
{
strm.EOL();
for (unsigned i = 0, e = value.GetSize(); i != e; ++i)
strm.Printf (" [%u]: \"%s\"\n", i, value.GetStringAtIndex (i));
}
break;
case eSetVarTypeDictionary:
{
strm.EOL();
for (unsigned i = 0, e = value.GetSize(); i != e; ++i)
strm.Printf (" %s\n", value.GetStringAtIndex (i));
}
break;
default:
return false;
}
}
return true;
}
void
UserSettingsController::GetAllVariableValues (CommandInterpreter &interpreter,
const UserSettingsControllerSP& usc_sp,
const char *current_prefix,
Stream &strm,
Error &err)
{
StreamString description;
int num_entries = usc_sp->m_settings.global_settings.size();
for (int i = 0; i < num_entries; ++i)
{
StreamString full_var_name;
const SettingEntry &entry = usc_sp->m_settings.global_settings[i];
if (current_prefix && current_prefix[0])
full_var_name.Printf ("%s.%s", current_prefix, entry.var_name);
else
full_var_name.Printf ("%s", entry.var_name);
DumpValue (interpreter, usc_sp, full_var_name.GetData(), strm);
}
usc_sp->GetAllInstanceVariableValues (interpreter, strm);
usc_sp->GetAllPendingSettingValues (strm);
if (usc_sp->GetLevelName().GetLength() > 0) // Don't bother with default values for Debugger level.
usc_sp->GetAllDefaultSettingValues (strm);
// Now, recurse across all children.
int num_children = usc_sp->GetNumChildren();
for (int i = 0; i < num_children; ++i)
{
UserSettingsControllerSP child = usc_sp->GetChildAtIndex (i);
if (child)
{
ConstString child_prefix = child->GetLevelName();
if (current_prefix && current_prefix[0])
{
StreamString new_prefix;
new_prefix.Printf ("%s.%s", current_prefix, child_prefix.GetCString());
UserSettingsController::GetAllVariableValues (interpreter,
child,
new_prefix.GetData(),
strm,
err);
}
else
{
UserSettingsController::GetAllVariableValues (interpreter,
child,
child_prefix.GetCString(),
strm,
err);
}
}
}
}
Args
UserSettingsController::BreakNameIntoPieces (const char *full_dot_name)
{
Args return_value;
std::string name_string (full_dot_name);
bool done = false;
std::string piece;
std::string remainder (full_dot_name);
while (!done)
{
size_t idx = remainder.find_first_of ('.');
piece = remainder.substr (0, idx);
return_value.AppendArgument (piece.c_str());
if (idx != std::string::npos)
remainder = remainder.substr (idx+1);
else
done = true;
}
return return_value;
}
bool
UserSettingsController::IsLiveInstance (const std::string &instance_name)
{
Mutex::Locker locker (m_live_settings_mutex);
InstanceSettingsMap::iterator pos = m_live_settings.find (instance_name);
if (pos != m_live_settings.end())
return true;
return false;
}
int
UserSettingsController::CompleteSettingsValue (const UserSettingsControllerSP& usc_sp,
const char *full_dot_name,
const char *partial_value,
bool &word_complete,
StringList &matches)
{
Args names = UserSettingsController::BreakNameIntoPieces (full_dot_name);
int num_pieces = names.GetArgumentCount();
word_complete = true;
ConstString root_level = usc_sp->GetLevelName();
int num_extra_levels = num_pieces - 2;
if ((num_extra_levels > 0)
&& root_level.GetLength() > 0)
{
ConstString current_level (names.GetArgumentAtIndex (0));
if (current_level == root_level)
{
names.Shift();
--num_extra_levels;
}
else
return 0;
}
for (int i = 0; i < num_extra_levels; ++i)
{
ConstString child_level (names.GetArgumentAtIndex (0));
bool found = false;
int num_children = usc_sp->GetNumChildren();
UserSettingsControllerSP child_usc_sp = usc_sp;
for (int j = 0; j < num_children && !found; ++j)
{
if (child_usc_sp->GetChildAtIndex (j)->GetLevelName() == child_level)
{
found = true;
child_usc_sp = child_usc_sp->GetChildAtIndex (j);
names.Shift();
}
}
if (!found)
return 0;
}
if (names.GetArgumentCount() != 2)
return 0;
std::string next_name (names.GetArgumentAtIndex (0));
int len = next_name.length();
names.Shift();
if ((next_name[0] == '[') && (next_name[len-1] == ']'))
{
// 'next_name' is instance name. Instance names are irrelevent here.
}
else
{
// 'next_name' is child name.
bool found = false;
int num_children = usc_sp->GetNumChildren();
ConstString child_level (next_name.c_str());
UserSettingsControllerSP child_usc_sp = usc_sp;
for (int j = 0; j < num_children && !found; ++j)
{
if (child_usc_sp->GetChildAtIndex (j)->GetLevelName() == child_level)
{
found = true;
child_usc_sp = child_usc_sp->GetChildAtIndex (j);
}
}
if (!found)
return 0;
}
ConstString var_name (names.GetArgumentAtIndex(0));
const SettingEntry *entry = usc_sp->GetGlobalEntry (var_name);
if (entry == NULL)
entry = usc_sp->GetInstanceEntry (var_name);
if (entry == NULL)
return 0;
if (entry->var_type == eSetVarTypeBoolean)
return UserSettingsController::BooleanMatches (partial_value, word_complete, matches);
else if (entry->var_type == eSetVarTypeEnum)
return UserSettingsController::EnumMatches (partial_value, entry->enum_values, word_complete, matches);
else
return 0;
}
int
UserSettingsController::BooleanMatches (const char *partial_value,
bool &word_complete,
StringList &matches)
{
static const std::string true_string ("true");
static const std::string false_string ("false");
if (partial_value == NULL)
{
matches.AppendString ("true");
matches.AppendString ("false");
}
else
{
int partial_len = strlen (partial_value);
if ((partial_len <= true_string.length())
&& (true_string.find (partial_value) == 0))
matches.AppendString ("true");
else if ((partial_len <= false_string.length())
&& (false_string.find (partial_value) == 0))
matches.AppendString ("false");
}
word_complete = false;
if (matches.GetSize() == 1)
word_complete = true;
return matches.GetSize();
}
int
UserSettingsController::EnumMatches (const char *partial_value,
OptionEnumValueElement *enum_values,
bool &word_complete,
StringList &matches)
{
int len = (partial_value != NULL) ? strlen (partial_value) : 0;
int i = 0;
while (enum_values[i].string_value != NULL)
{
if (len == 0)
matches.AppendString (enum_values[i].string_value);
else
{
std::string tmp_value (enum_values[i].string_value);
if ((len <= tmp_value.length())
&& tmp_value.find (partial_value) == 0)
matches.AppendString (enum_values[i].string_value);
}
++i;
}
word_complete = false;
if (matches.GetSize() == 1)
word_complete = true;
return matches.GetSize();
}
int
UserSettingsController::CompleteSettingsNames (const UserSettingsControllerSP& usc_sp,
Args &partial_setting_name_pieces,
bool &word_complete,
StringList &matches)
{
int num_matches = 0;
int num_name_pieces = partial_setting_name_pieces.GetArgumentCount();
if (num_name_pieces > 1)
{
// There are at least two pieces, perhaps with multiple level names preceding them.
// First traverse all the extra levels, until we have exactly two pieces left.
int num_extra_levels = num_name_pieces - 2;
// Deal with current level first.
ConstString root_level = usc_sp->GetLevelName();
if ((num_extra_levels > 0)
&& (root_level.GetLength() > 0))
{
ConstString current_level (partial_setting_name_pieces.GetArgumentAtIndex (0));
if (current_level == root_level)
{
partial_setting_name_pieces.Shift();
--num_extra_levels;
}
else
return 0; // The current level did not match the name pieces; something is wrong, so return immediately
}
// The variable my_usc_sp keeps track of the user settings controller as
// we descend through the tree hierarchy.
UserSettingsControllerSP my_usc_sp = usc_sp;
for (int i = 0; i < num_extra_levels; ++i)
{
ConstString child_level (partial_setting_name_pieces.GetArgumentAtIndex (0));
bool found = false;
int num_children = my_usc_sp->GetNumChildren();
for (int j = 0; j < num_children && !found; ++j)
{
if (my_usc_sp->GetChildAtIndex (j)->GetLevelName() == child_level)
{
found = true;
my_usc_sp = my_usc_sp->GetChildAtIndex (j);
partial_setting_name_pieces.Shift();
}
}
if (! found)
{
return 0; // Unable to find a matching child level name; something is wrong, so return immediately.
}
}
// Now there should be exactly two name pieces left. If not there is an error, so return immediately
if (partial_setting_name_pieces.GetArgumentCount() != 2)
return 0;
std::string next_name (partial_setting_name_pieces.GetArgumentAtIndex (0));
int len = next_name.length();
partial_setting_name_pieces.Shift();
if ((next_name[0] == '[') && (next_name[len-1] == ']'))
{
// 'next_name' is an instance name. The last name piece must be a non-empty partial match against an
// instance_name, assuming 'next_name' is valid.
if (my_usc_sp->IsLiveInstance (next_name))
{
std::string complete_prefix;
my_usc_sp->BuildParentPrefix (complete_prefix);
num_matches = my_usc_sp->InstanceVariableMatches(partial_setting_name_pieces.GetArgumentAtIndex(0),
complete_prefix,
next_name.c_str(),
matches);
word_complete = true;
if (num_matches > 1)
word_complete = false;
return num_matches;
}
else
return 0; // Invalid instance_name
}
else
{
// 'next_name' must be a child name. Find the correct child and pass the remaining piece to be resolved.
bool found = false;
int num_children = my_usc_sp->GetNumChildren();
ConstString child_level (next_name.c_str());
for (int i = 0; i < num_children; ++i)
{
if (my_usc_sp->GetChildAtIndex (i)->GetLevelName() == child_level)
{
found = true;
return UserSettingsController::CompleteSettingsNames (my_usc_sp->GetChildAtIndex (i),
partial_setting_name_pieces,
word_complete, matches);
}
}
if (!found)
return 0;
}
}
else if (num_name_pieces == 1)
{
std::string complete_prefix;
usc_sp->BuildParentPrefix (complete_prefix);
word_complete = true;
std::string name (partial_setting_name_pieces.GetArgumentAtIndex (0));
if (name[0] == '[')
{
// It's a partial instance name.
num_matches = usc_sp->LiveInstanceMatches (name.c_str(), complete_prefix, word_complete, matches);
}
else
{
// It could be anything *except* an instance name...
num_matches = usc_sp->GlobalVariableMatches (name.c_str(), complete_prefix, matches);
num_matches += usc_sp->InstanceVariableMatches (name.c_str(), complete_prefix, NULL, matches);
num_matches += usc_sp->ChildMatches (name.c_str(), complete_prefix, word_complete, matches);
}
if (num_matches > 1)
word_complete = false;
return num_matches;
}
else
{
// We have a user settings controller with a blank partial string. Return everything possible at this level.
std::string complete_prefix;
usc_sp->BuildParentPrefix (complete_prefix);
num_matches = usc_sp->GlobalVariableMatches (NULL, complete_prefix, matches);
num_matches += usc_sp->InstanceVariableMatches (NULL, complete_prefix, NULL, matches);
num_matches += usc_sp->LiveInstanceMatches (NULL, complete_prefix, word_complete, matches);
num_matches += usc_sp->ChildMatches (NULL, complete_prefix, word_complete, matches);
word_complete = false;
return num_matches;
}
return num_matches;
}
int
UserSettingsController::GlobalVariableMatches (const char *partial_name,
const std::string &complete_prefix,
StringList &matches)
{
int partial_len = (partial_name != NULL) ? strlen (partial_name) : 0;
int num_matches = 0;
for (size_t i = 0; i < m_settings.global_settings.size(); ++i)
{
const SettingEntry &entry = m_settings.global_settings[i];
std::string var_name (entry.var_name);
if ((partial_len == 0)
|| ((partial_len <= var_name.length())
&& (var_name.find (partial_name) == 0)))
{
StreamString match_name;
if (complete_prefix.length() > 0)
{
match_name.Printf ("%s.%s", complete_prefix.c_str(), var_name.c_str());
matches.AppendString (match_name.GetData());
}
else
matches.AppendString (var_name.c_str());
++num_matches;
}
}
return num_matches;
}
int
UserSettingsController::InstanceVariableMatches (const char *partial_name,
const std::string &complete_prefix,
const char *instance_name,
StringList &matches)
{
int partial_len = (partial_name != NULL) ? strlen (partial_name) : 0;
int num_matches = 0;
for (size_t i = 0; i < m_settings.instance_settings.size(); ++i)
{
SettingEntry &entry = m_settings.instance_settings[i];
std::string var_name (entry.var_name);
if ((partial_len == 0)
|| ((partial_len <= var_name.length())
&& (var_name.find (partial_name) == 0)))
{
StreamString match_name;
if (complete_prefix.length() > 0)
{
if (instance_name != NULL)
match_name.Printf ("%s.%s.%s", complete_prefix.c_str(), instance_name, var_name.c_str());
else
match_name.Printf ("%s.%s", complete_prefix.c_str(), var_name.c_str());
matches.AppendString (match_name.GetData());
}
else
{
if (instance_name != NULL)
{
match_name.Printf ("%s.%s", instance_name, var_name.c_str());
matches.AppendString (match_name.GetData());
}
else
matches.AppendString (var_name.c_str());
}
++num_matches;
}
}
return num_matches;
}
int
UserSettingsController::LiveInstanceMatches (const char *partial_name,
const std::string &complete_prefix,
bool &word_complete,
StringList &matches)
{
int partial_len = (partial_name != NULL) ? strlen (partial_name) : 0;
int num_matches = 0;
InstanceSettingsMap::iterator pos;
Mutex::Locker locker (m_live_settings_mutex);
for (pos = m_live_settings.begin(); pos != m_live_settings.end(); ++pos)
{
std::string instance_name = pos->first;
if ((partial_len == 0)
|| ((partial_len <= instance_name.length())
&& (instance_name.find (partial_name) == 0)))
{
StreamString match_name;
if (complete_prefix.length() > 0)
match_name.Printf ("%s.%s.", complete_prefix.c_str(), instance_name.c_str());
else
match_name.Printf ("%s.", instance_name.c_str());
matches.AppendString (match_name.GetData());
++num_matches;
}
}
if (num_matches > 0)
word_complete = false;
return num_matches;
}
int
UserSettingsController::ChildMatches (const char *partial_name,
const std::string &complete_prefix,
bool &word_complete,
StringList &matches)
{
int partial_len = (partial_name != NULL) ? strlen (partial_name) : 0;
int num_children = GetNumChildren();
int num_matches = 0;
for (int i = 0; i < num_children; ++i)
{
std::string child_name (GetChildAtIndex(i)->GetLevelName().GetCString());
StreamString match_name;
if ((partial_len == 0)
|| ((partial_len <= child_name.length())
&& (child_name.find (partial_name) == 0)))
{
if (complete_prefix.length() > 0)
match_name.Printf ("%s.%s.", complete_prefix.c_str(), child_name.c_str());
else
match_name.Printf ("%s.", child_name.c_str());
matches.AppendString (match_name.GetData());
++num_matches;
}
}
if (num_matches > 0)
word_complete = false;
return num_matches;
}
void
UserSettingsController::VerifyOperationForType (SettableVariableType var_type,
VarSetOperationType op,
const ConstString &var_name,
Error &err)
{
if (op == eVarSetOperationAssign)
return;
if (op == eVarSetOperationInvalid)
{
err.SetErrorString ("invalid 'settings' subcommand operation");
return;
}
switch (op)
{
case eVarSetOperationInsertBefore:
case eVarSetOperationInsertAfter:
if (var_type != eSetVarTypeArray)
err.SetErrorString ("invalid operation: this operation can only be performed on array variables");
break;
case eVarSetOperationReplace:
case eVarSetOperationRemove:
if ((var_type != eSetVarTypeArray)
&& (var_type != eSetVarTypeDictionary))
err.SetErrorString ("invalid operation: this operation can only be performed on array or dictionary variables");
break;
case eVarSetOperationAppend:
case eVarSetOperationClear:
if ((var_type != eSetVarTypeArray)
&& (var_type != eSetVarTypeDictionary)
&& (var_type != eSetVarTypeString))
err.SetErrorString ("invalid operation: this operation can only be performed on array, dictionary or string variables");
break;
default:
break;
}
return;
}
void
UserSettingsController::UpdateStringVariable (VarSetOperationType op,
std::string &string_var,
const char *new_value,
Error &err)
{
if (op == eVarSetOperationAssign)
{
if (new_value && new_value[0])
string_var.assign (new_value);
else
string_var.clear();
}
else if (op == eVarSetOperationAppend)
{
if (new_value && new_value[0])
string_var.append (new_value);
}
else if (op == eVarSetOperationClear)
string_var.clear();
else
err.SetErrorString ("unrecognized operation. Cannot update value");
}
Error
UserSettingsController::UpdateStringOptionValue (const char *value,
VarSetOperationType op,
OptionValueString &option_value)
{
Error error;
if (op == eVarSetOperationAssign)
{
option_value.SetCurrentValue (value);
}
else if (op == eVarSetOperationAppend)
{
option_value.AppendToCurrentValue (value);
}
else if (op == eVarSetOperationClear)
{
option_value.Clear();
}
else
{
error.SetErrorString ("unrecognized operation, cannot update value");
}
return error;
}
Error
UserSettingsController::UpdateFileSpecOptionValue (const char *value,
VarSetOperationType op,
OptionValueFileSpec &option_value)
{
Error error;
if (op == eVarSetOperationAssign)
{
option_value.GetCurrentValue().SetFile (value, false);
}
else if (op == eVarSetOperationAppend)
{
char path[PATH_MAX];
if (option_value.GetCurrentValue().GetPath (path, sizeof(path)))
{
int path_len = ::strlen (path);
int value_len = ::strlen (value);
if (value_len + 1 > sizeof(path) - path_len)
{
error.SetErrorString("path too long.");
}
else
{
::strncat (path, value, sizeof(path) - path_len - 1);
option_value.GetCurrentValue().SetFile (path, false);
}
}
else
{
error.SetErrorString("path too long.");
}
}
else if (op == eVarSetOperationClear)
{
option_value.Clear();
}
else
{
error.SetErrorString ("operation not supported for FileSpec option value type.");
}
return error;
}
void
UserSettingsController::UpdateBooleanVariable (VarSetOperationType op,
bool &bool_value,
const char *value_cstr,
bool clear_value,
Error &err)
{
switch (op)
{
case eVarSetOperationReplace:
case eVarSetOperationInsertBefore:
case eVarSetOperationInsertAfter:
case eVarSetOperationRemove:
case eVarSetOperationAppend:
case eVarSetOperationInvalid:
default:
err.SetErrorString ("invalid operation for Boolean variable, cannot update value");
break;
case eVarSetOperationClear:
err.Clear();
bool_value = clear_value;
break;
case eVarSetOperationAssign:
{
bool success = false;
if (value_cstr == NULL)
err.SetErrorStringWithFormat ("invalid boolean string value (NULL)");
else if (value_cstr[0] == '\0')
err.SetErrorStringWithFormat ("invalid boolean string value (empty)");
else
{
bool new_value = Args::StringToBoolean (value_cstr, false, &success);
if (success)
{
err.Clear();
bool_value = new_value;
}
else
err.SetErrorStringWithFormat ("invalid boolean string value: '%s'", value_cstr);
}
}
break;
}
}
Error
UserSettingsController::UpdateBooleanOptionValue (const char *value,
VarSetOperationType op,
OptionValueBoolean &option_value)
{
Error error;
switch (op)
{
case eVarSetOperationReplace:
case eVarSetOperationInsertBefore:
case eVarSetOperationInsertAfter:
case eVarSetOperationRemove:
case eVarSetOperationAppend:
case eVarSetOperationInvalid:
default:
error.SetErrorString ("Invalid operation for Boolean variable. Cannot update value.\n");
break;
case eVarSetOperationClear:
option_value.Clear();
break;
case eVarSetOperationAssign:
{
bool success = false;
error = option_value.SetValueFromCString(value);
if (value == NULL)
error.SetErrorStringWithFormat ("invalid boolean string value (NULL)\n");
else if (value[0] == '\0')
error.SetErrorStringWithFormat ("invalid boolean string value (empty)\n");
else
{
bool new_value = Args::StringToBoolean (value, false, &success);
if (success)
{
error.Clear();
option_value = new_value;
}
else
error.SetErrorStringWithFormat ("invalid boolean string value: '%s'\n", value);
}
}
break;
}
return error;
}
void
UserSettingsController::UpdateStringArrayVariable (VarSetOperationType op,
const char *index_value,
Args &array_var,
const char *new_value,
Error &err)
{
int index = -1;
bool valid_index = true;
if (index_value != NULL)
{
for (int i = 0; i < strlen(index_value); ++i)
if (!isdigit (index_value[i]))
{
valid_index = false;
err.SetErrorStringWithFormat ("'%s' is not a valid integer index, cannot update array value",
index_value);
}
if (valid_index)
index = atoi (index_value);
if (index < 0
|| index >= array_var.GetArgumentCount())
{
valid_index = false;
err.SetErrorStringWithFormat ("%d is outside the bounds of the specified array variable, "
"cannot update array value", index);
}
}
switch (op)
{
case eVarSetOperationAssign:
array_var.SetCommandString (new_value);
break;
case eVarSetOperationReplace:
{
if (valid_index)
array_var.ReplaceArgumentAtIndex (index, new_value);
break;
}
case eVarSetOperationInsertBefore:
case eVarSetOperationInsertAfter:
{
if (valid_index)
{
Args new_array (new_value);
if (op == eVarSetOperationInsertAfter)
++index;
for (int i = 0; i < new_array.GetArgumentCount(); ++i)
array_var.InsertArgumentAtIndex (index, new_array.GetArgumentAtIndex (i));
}
break;
}
case eVarSetOperationRemove:
{
if (valid_index)
array_var.DeleteArgumentAtIndex (index);
break;
}
case eVarSetOperationAppend:
{
Args new_array (new_value);
array_var.AppendArguments (new_array);
break;
}
case eVarSetOperationClear:
array_var.Clear();
break;
default:
err.SetErrorString ("unrecognized operation, cannot update value");
break;
}
}
void
UserSettingsController::UpdateDictionaryVariable (VarSetOperationType op,
const char *index_value,
std::map<std::string, std::string> &dictionary,
const char *new_value,
Error &err)
{
switch (op)
{
case eVarSetOperationReplace:
if (index_value != NULL)
{
std::string key (index_value);
std::map<std::string, std::string>::iterator pos;
pos = dictionary.find (key);
if (pos != dictionary.end())
dictionary[key] = new_value;
else
err.SetErrorStringWithFormat ("'%s' is not an existing key; cannot replace value", index_value);
}
else
err.SetErrorString ("'settings replace' requires a key for dictionary variables, no key supplied");
break;
case eVarSetOperationRemove:
if (index_value != NULL)
{
std::string key (index_value);
dictionary.erase (key);
}
else
err.SetErrorString ("'settings remove' requires a key for dictionary variables, no key supplied");
break;
case eVarSetOperationClear:
dictionary.clear ();
break;
case eVarSetOperationAppend:
case eVarSetOperationAssign:
{
// Clear the dictionary if it's an assign with new_value as NULL.
if (new_value == NULL && op == eVarSetOperationAssign)
{
dictionary.clear ();
break;
}
Args args (new_value);
size_t num_args = args.GetArgumentCount();
RegularExpression regex("(\\[\"?)?" // Regex match 1 (optional key prefix of '["' pr '[')
"([A-Za-z_][A-Za-z_0-9]*)" // Regex match 2 (key string)
"(\"?\\])?" // Regex match 3 (optional key suffix of '"]' pr ']')
"=" // The equal sign that is required
"(.*)"); // Regex match 4 (value string)
std::string key, value;
for (size_t i = 0; i < num_args; ++i)
{
const char *key_equal_value_arg = args.GetArgumentAtIndex (i);
// Execute the regular expression on each arg.
if (regex.Execute(key_equal_value_arg, 5))
{
// The regular expression succeeded. The match at index
// zero will be the entire string that matched the entire
// regular expression. The match at index 1 - 4 will be
// as mentioned above by the creation of the regex pattern.
// Match index 2 is the key, match index 4 is the value.
regex.GetMatchAtIndex (key_equal_value_arg, 2, key);
regex.GetMatchAtIndex (key_equal_value_arg, 4, value);
dictionary[key] = value;
}
else
{
err.SetErrorString ("invalid format for dictionary value, expected one of '[\"<key>\"]=<value>', '[<key>]=<value>', or '<key>=<value>'");
}
}
}
break;
case eVarSetOperationInsertBefore:
case eVarSetOperationInsertAfter:
err.SetErrorString ("specified operation cannot be performed on dictionary variables");
break;
default:
err.SetErrorString ("unrecognized operation");
break;
}
}
const char *
UserSettingsController::EnumToString (const OptionEnumValueElement *enum_values,
int value)
{
int i = 0;
while (enum_values[i].string_value != NULL)
{
if (enum_values[i].value == value)
return enum_values[i].string_value;
++i;
}
return "";
}
void
UserSettingsController::UpdateEnumVariable (OptionEnumValueElement *enum_values,
int *enum_var,
const char *new_value,
Error &error)
{
*enum_var = Args::StringToOptionEnum (new_value, enum_values, enum_values[0].value, error);
}
void
UserSettingsController::RenameInstanceSettings (const char *old_name, const char *new_name)
{
Mutex::Locker live_mutex (m_live_settings_mutex);
Mutex::Locker pending_mutex (m_pending_settings_mutex);
std::string old_name_key (old_name);
std::string new_name_key (new_name);
// First, find the live instance settings for the old_name. If they don't exist in the live settings
// list, then this is not a setting that can be renamed.
if ((old_name_key[0] != '[') || (old_name_key[old_name_key.size() -1] != ']'))
{
StreamString tmp_str;
tmp_str.Printf ("[%s]", old_name);
old_name_key = tmp_str.GetData();
}
if ((new_name_key[0] != '[') || (new_name_key[new_name_key.size() -1] != ']'))
{
StreamString tmp_str;
tmp_str.Printf ("[%s]", new_name);
new_name_key = tmp_str.GetData();
}
if (old_name_key.compare (new_name_key) == 0)
return;
size_t len = new_name_key.length();
std::string stripped_new_name = new_name_key.substr (1, len-2); // new name without the '[ ]'
InstanceSettingsMap::iterator pos;
pos = m_live_settings.find (old_name_key);
if (pos != m_live_settings.end())
{
InstanceSettings *live_settings = pos->second;
// Rename the settings.
live_settings->ChangeInstanceName (stripped_new_name);
// Now see if there are any pending settings for the new name; if so, copy them into live_settings.
std::map<std::string, InstanceSettingsSP>::iterator pending_pos;
pending_pos = m_pending_settings.find (new_name_key);
if (pending_pos != m_pending_settings.end())
{
InstanceSettingsSP pending_settings_sp = pending_pos->second;
live_settings->CopyInstanceSettings (pending_settings_sp, false);
}
// Erase the old entry (under the old name) from live settings.
m_live_settings.erase (pos);
// Add the new entry, with the new name, into live settings.
m_live_settings[new_name_key] = live_settings;
}
}
//----------------------------------------------------------------------
// class InstanceSettings
//----------------------------------------------------------------------
InstanceSettings::InstanceSettings (const UserSettingsControllerSP &owner_sp, const char *instance_name, bool live_instance) :
m_owner_wp (owner_sp),
m_instance_name (instance_name)
{
if ((m_instance_name != InstanceSettings::GetDefaultName())
&& (m_instance_name != InstanceSettings::InvalidName())
&& live_instance)
owner_sp->RegisterInstanceSettings (this);
}
InstanceSettings::~InstanceSettings ()
{
if (m_instance_name != InstanceSettings::GetDefaultName())
{
UserSettingsControllerSP owner_sp (m_owner_wp.lock());
if (owner_sp)
owner_sp->UnregisterInstanceSettings (this);
}
}
const ConstString &
InstanceSettings::GetDefaultName ()
{
static const ConstString g_default_settings_name ("[DEFAULT]");
return g_default_settings_name;
}
const ConstString &
InstanceSettings::InvalidName ()
{
static const ConstString g_invalid_name ("Invalid instance name");
return g_invalid_name;
}
void
InstanceSettings::ChangeInstanceName (const std::string &new_instance_name)
{
m_instance_name.SetCString (new_instance_name.c_str());
}
Reference in New Issue View Git Blame Copy Permalink