[Lldb-commits] [lldb] r253531 - Allow the language plugins a say in how the function name is rendered as part of frame formatting
Enrico Granata via lldb-commits
lldb-commits at lists.llvm.org
Wed Nov 18 17:27:07 PST 2015
That depends - some of the language plugin stuff is being used in C/C++/ObjC, and then there either are new test cases, or existing test cases cover the fact that refactoring has not broken functionality
Some of the new functionality is not (yet) used, and is just infrastructural plumbing - in those cases, the best we can do to test is using existing test coverage to ensure our plumbing through does not break existing behavior
This change falls in this latter category - i.e. since it is just infrastructure work, there is no change in functionality, and the lack of regressions is the best testing coverage we can get in the current world
When I start using this, I will add tests (or rework existing tests) as needed
> On Nov 18, 2015, at 5:19 PM, Zachary Turner <zturner at google.com> wrote:
>
> Hi Enrico, have there been any tests exercising any of the language plugin stuff yet? Hard to follow every CL that goes in, so just trying to catch up.
>
> On Wed, Nov 18, 2015 at 5:14 PM Enrico Granata via lldb-commits <lldb-commits at lists.llvm.org <mailto:lldb-commits at lists.llvm.org>> wrote:
> Author: enrico
> Date: Wed Nov 18 19:11:53 2015
> New Revision: 253531
>
> URL: http://llvm.org/viewvc/llvm-project?rev=253531&view=rev <http://llvm.org/viewvc/llvm-project?rev=253531&view=rev>
> Log:
> Allow the language plugins a say in how the function name is rendered as part of frame formatting
>
> Modified:
> lldb/trunk/include/lldb/Target/Language.h
> lldb/trunk/source/Core/FormatEntity.cpp
> lldb/trunk/source/Target/Language.cpp
>
> Modified: lldb/trunk/include/lldb/Target/Language.h
> URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/include/lldb/Target/Language.h?rev=253531&r1=253530&r2=253531&view=diff <http://llvm.org/viewvc/llvm-project/lldb/trunk/include/lldb/Target/Language.h?rev=253531&r1=253530&r2=253531&view=diff>
> ==============================================================================
> --- lldb/trunk/include/lldb/Target/Language.h (original)
> +++ lldb/trunk/include/lldb/Target/Language.h Wed Nov 18 19:11:53 2015
> @@ -32,7 +32,6 @@ class Language :
> public PluginInterface
> {
> public:
> -
> class TypeScavenger
> {
> public:
> @@ -67,6 +66,13 @@ public:
> const char *key,
> ResultSet &results) = 0;
> };
> +
> + enum class FunctionNameRepresentation
> + {
> + eName,
> + eNameWithArgs,
> + eNameWithNoArgs
> + };
>
> ~Language() override;
>
> @@ -134,6 +140,11 @@ public:
> virtual bool
> IsUninitializedReference (ValueObject& valobj);
>
> + virtual bool
> + GetFunctionDisplayName (const SymbolContext *sc,
> + FunctionNameRepresentation representation,
> + Stream& s);
> +
> // These are accessors for general information about the Languages lldb knows about:
>
> static lldb::LanguageType
>
> Modified: lldb/trunk/source/Core/FormatEntity.cpp
> URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/source/Core/FormatEntity.cpp?rev=253531&r1=253530&r2=253531&view=diff <http://llvm.org/viewvc/llvm-project/lldb/trunk/source/Core/FormatEntity.cpp?rev=253531&r1=253530&r2=253531&view=diff>
> ==============================================================================
> --- lldb/trunk/source/Core/FormatEntity.cpp (original)
> +++ lldb/trunk/source/Core/FormatEntity.cpp Wed Nov 18 19:11:53 2015
> @@ -1653,201 +1653,264 @@ FormatEntity::Format (const Entry &entry
>
> case Entry::Type::FunctionName:
> {
> - const char *name = NULL;
> + Language *language_plugin = nullptr;
> + bool language_plugin_handled = false;
> + StreamString ss;
> if (sc->function)
> - name = sc->function->GetName().AsCString (NULL);
> + language_plugin = Language::FindPlugin(sc->function->GetLanguage());
> else if (sc->symbol)
> - name = sc->symbol->GetName().AsCString (NULL);
> - if (name)
> + language_plugin = Language::FindPlugin(sc->symbol->GetLanguage());
> + if (language_plugin)
> {
> - s.PutCString(name);
> -
> - if (sc->block)
> + language_plugin_handled = language_plugin->GetFunctionDisplayName(sc,
> + Language::FunctionNameRepresentation::eName,
> + ss);
> + }
> + if (language_plugin_handled)
> + {
> + s.PutCString(ss.GetData());
> + return true;
> + }
> + else
> + {
> + const char *name = NULL;
> + if (sc->function)
> + name = sc->function->GetName().AsCString (NULL);
> + else if (sc->symbol)
> + name = sc->symbol->GetName().AsCString (NULL);
> + if (name)
> {
> - Block *inline_block = sc->block->GetContainingInlinedBlock ();
> - if (inline_block)
> + s.PutCString(name);
> +
> + if (sc->block)
> {
> - const InlineFunctionInfo *inline_info = sc->block->GetInlinedFunctionInfo();
> - if (inline_info)
> + Block *inline_block = sc->block->GetContainingInlinedBlock ();
> + if (inline_block)
> {
> - s.PutCString(" [inlined] ");
> - inline_info->GetName(sc->function->GetLanguage()).Dump(&s);
> + const InlineFunctionInfo *inline_info = sc->block->GetInlinedFunctionInfo();
> + if (inline_info)
> + {
> + s.PutCString(" [inlined] ");
> + inline_info->GetName(sc->function->GetLanguage()).Dump(&s);
> + }
> }
> }
> + return true;
> }
> - return true;
> }
> }
> return false;
>
> case Entry::Type::FunctionNameNoArgs:
> {
> - ConstString name;
> + Language *language_plugin = nullptr;
> + bool language_plugin_handled = false;
> + StreamString ss;
> if (sc->function)
> - name = sc->function->GetNameNoArguments();
> + language_plugin = Language::FindPlugin(sc->function->GetLanguage());
> else if (sc->symbol)
> - name = sc->symbol->GetNameNoArguments();
> - if (name)
> + language_plugin = Language::FindPlugin(sc->symbol->GetLanguage());
> + if (language_plugin)
> {
> - s.PutCString(name.GetCString());
> + language_plugin_handled = language_plugin->GetFunctionDisplayName(sc,
> + Language::FunctionNameRepresentation::eNameWithNoArgs,
> + ss);
> + }
> + if (language_plugin_handled)
> + {
> + s.PutCString(ss.GetData());
> return true;
> }
> + else
> + {
> + ConstString name;
> + if (sc->function)
> + name = sc->function->GetNameNoArguments();
> + else if (sc->symbol)
> + name = sc->symbol->GetNameNoArguments();
> + if (name)
> + {
> + s.PutCString(name.GetCString());
> + return true;
> + }
> + }
> }
> return false;
>
> case Entry::Type::FunctionNameWithArgs:
> {
> - // Print the function name with arguments in it
> + Language *language_plugin = nullptr;
> + bool language_plugin_handled = false;
> + StreamString ss;
> if (sc->function)
> + language_plugin = Language::FindPlugin(sc->function->GetLanguage());
> + else if (sc->symbol)
> + language_plugin = Language::FindPlugin(sc->symbol->GetLanguage());
> + if (language_plugin)
> {
> - ExecutionContextScope *exe_scope = exe_ctx ? exe_ctx->GetBestExecutionContextScope() : NULL;
> - const char *cstr = sc->function->GetName().AsCString (NULL);
> - if (cstr)
> + language_plugin_handled = language_plugin->GetFunctionDisplayName(sc,
> + Language::FunctionNameRepresentation::eNameWithArgs,
> + ss);
> + }
> + if (language_plugin_handled)
> + {
> + s.PutCString(ss.GetData());
> + return true;
> + }
> + else
> + {
> + // Print the function name with arguments in it
> + if (sc->function)
> {
> - const InlineFunctionInfo *inline_info = NULL;
> - VariableListSP variable_list_sp;
> - bool get_function_vars = true;
> - if (sc->block)
> + ExecutionContextScope *exe_scope = exe_ctx ? exe_ctx->GetBestExecutionContextScope() : NULL;
> + const char *cstr = sc->function->GetName().AsCString (NULL);
> + if (cstr)
> {
> - Block *inline_block = sc->block->GetContainingInlinedBlock ();
> -
> - if (inline_block)
> + const InlineFunctionInfo *inline_info = NULL;
> + VariableListSP variable_list_sp;
> + bool get_function_vars = true;
> + if (sc->block)
> {
> - get_function_vars = false;
> - inline_info = sc->block->GetInlinedFunctionInfo();
> - if (inline_info)
> - variable_list_sp = inline_block->GetBlockVariableList (true);
> - }
> - }
> -
> - if (get_function_vars)
> - {
> - variable_list_sp = sc->function->GetBlock(true).GetBlockVariableList (true);
> - }
> -
> - if (inline_info)
> - {
> - s.PutCString (cstr);
> - s.PutCString (" [inlined] ");
> - cstr = inline_info->GetName(sc->function->GetLanguage()).GetCString();
> - }
> -
> - VariableList args;
> - if (variable_list_sp)
> - variable_list_sp->AppendVariablesWithScope(eValueTypeVariableArgument, args);
> - if (args.GetSize() > 0)
> - {
> - const char *open_paren = strchr (cstr, '(');
> - const char *close_paren = nullptr;
> - const char *generic = strchr(cstr, '<');
> - // if before the arguments list begins there is a template sign
> - // then scan to the end of the generic args before you try to find
> - // the arguments list
> - if (generic && open_paren && generic < open_paren)
> - {
> - int generic_depth = 1;
> - ++generic;
> - for (;
> - *generic && generic_depth > 0;
> - generic++)
> - {
> - if (*generic == '<')
> - generic_depth++;
> - if (*generic == '>')
> - generic_depth--;
> + Block *inline_block = sc->block->GetContainingInlinedBlock ();
> +
> + if (inline_block)
> + {
> + get_function_vars = false;
> + inline_info = sc->block->GetInlinedFunctionInfo();
> + if (inline_info)
> + variable_list_sp = inline_block->GetBlockVariableList (true);
> }
> - if (*generic)
> - open_paren = strchr(generic, '(');
> - else
> - open_paren = nullptr;
> }
> - if (open_paren)
> +
> + if (get_function_vars)
> {
> - if (IsToken (open_paren, "(anonymous namespace)"))
> - {
> - open_paren = strchr (open_paren + strlen("(anonymous namespace)"), '(');
> - if (open_paren)
> - close_paren = strchr (open_paren, ')');
> - }
> - else
> - close_paren = strchr (open_paren, ')');
> + variable_list_sp = sc->function->GetBlock(true).GetBlockVariableList (true);
> }
> -
> - if (open_paren)
> - s.Write(cstr, open_paren - cstr + 1);
> - else
> +
> + if (inline_info)
> {
> s.PutCString (cstr);
> - s.PutChar ('(');
> + s.PutCString (" [inlined] ");
> + cstr = inline_info->GetName(sc->function->GetLanguage()).GetCString();
> }
> - const size_t num_args = args.GetSize();
> - for (size_t arg_idx = 0; arg_idx < num_args; ++arg_idx)
> +
> + VariableList args;
> + if (variable_list_sp)
> + variable_list_sp->AppendVariablesWithScope(eValueTypeVariableArgument, args);
> + if (args.GetSize() > 0)
> {
> - std::string buffer;
> -
> - VariableSP var_sp (args.GetVariableAtIndex (arg_idx));
> - ValueObjectSP var_value_sp (ValueObjectVariable::Create (exe_scope, var_sp));
> - StreamString ss;
> - const char *var_representation = nullptr;
> - const char *var_name = var_value_sp->GetName().GetCString();
> - if (var_value_sp->GetCompilerType().IsValid())
> - {
> - if (var_value_sp && exe_scope->CalculateTarget())
> - var_value_sp = var_value_sp->GetQualifiedRepresentationIfAvailable(exe_scope->CalculateTarget()->TargetProperties::GetPreferDynamicValue(),
> - exe_scope->CalculateTarget()->TargetProperties::GetEnableSyntheticValue());
> - if (var_value_sp->GetCompilerType().IsAggregateType() &&
> - DataVisualization::ShouldPrintAsOneLiner(*var_value_sp.get()))
> + const char *open_paren = strchr (cstr, '(');
> + const char *close_paren = nullptr;
> + const char *generic = strchr(cstr, '<');
> + // if before the arguments list begins there is a template sign
> + // then scan to the end of the generic args before you try to find
> + // the arguments list
> + if (generic && open_paren && generic < open_paren)
> + {
> + int generic_depth = 1;
> + ++generic;
> + for (;
> + *generic && generic_depth > 0;
> + generic++)
> + {
> + if (*generic == '<')
> + generic_depth++;
> + if (*generic == '>')
> + generic_depth--;
> + }
> + if (*generic)
> + open_paren = strchr(generic, '(');
> + else
> + open_paren = nullptr;
> + }
> + if (open_paren)
> + {
> + if (IsToken (open_paren, "(anonymous namespace)"))
> {
> - static StringSummaryFormat format(TypeSummaryImpl::Flags()
> - .SetHideItemNames(false)
> - .SetShowMembersOneLiner(true),
> - "");
> - format.FormatObject(var_value_sp.get(), buffer, TypeSummaryOptions());
> - var_representation = buffer.c_str();
> + open_paren = strchr (open_paren + strlen("(anonymous namespace)"), '(');
> + if (open_paren)
> + close_paren = strchr (open_paren, ')');
> }
> else
> - var_value_sp->DumpPrintableRepresentation(ss,
> - ValueObject::ValueObjectRepresentationStyle::eValueObjectRepresentationStyleSummary,
> - eFormatDefault,
> - ValueObject::PrintableRepresentationSpecialCases::ePrintableRepresentationSpecialCasesAllow,
> - false);
> + close_paren = strchr (open_paren, ')');
> }
>
> - if (ss.GetData() && ss.GetSize())
> - var_representation = ss.GetData();
> - if (arg_idx > 0)
> - s.PutCString (", ");
> - if (var_value_sp->GetError().Success())
> + if (open_paren)
> + s.Write(cstr, open_paren - cstr + 1);
> + else
> {
> - if (var_representation)
> - s.Printf ("%s=%s", var_name, var_representation);
> + s.PutCString (cstr);
> + s.PutChar ('(');
> + }
> + const size_t num_args = args.GetSize();
> + for (size_t arg_idx = 0; arg_idx < num_args; ++arg_idx)
> + {
> + std::string buffer;
> +
> + VariableSP var_sp (args.GetVariableAtIndex (arg_idx));
> + ValueObjectSP var_value_sp (ValueObjectVariable::Create (exe_scope, var_sp));
> + StreamString ss;
> + const char *var_representation = nullptr;
> + const char *var_name = var_value_sp->GetName().GetCString();
> + if (var_value_sp->GetCompilerType().IsValid())
> + {
> + if (var_value_sp && exe_scope->CalculateTarget())
> + var_value_sp = var_value_sp->GetQualifiedRepresentationIfAvailable(exe_scope->CalculateTarget()->TargetProperties::GetPreferDynamicValue(),
> + exe_scope->CalculateTarget()->TargetProperties::GetEnableSyntheticValue());
> + if (var_value_sp->GetCompilerType().IsAggregateType() &&
> + DataVisualization::ShouldPrintAsOneLiner(*var_value_sp.get()))
> + {
> + static StringSummaryFormat format(TypeSummaryImpl::Flags()
> + .SetHideItemNames(false)
> + .SetShowMembersOneLiner(true),
> + "");
> + format.FormatObject(var_value_sp.get(), buffer, TypeSummaryOptions());
> + var_representation = buffer.c_str();
> + }
> + else
> + var_value_sp->DumpPrintableRepresentation(ss,
> + ValueObject::ValueObjectRepresentationStyle::eValueObjectRepresentationStyleSummary,
> + eFormatDefault,
> + ValueObject::PrintableRepresentationSpecialCases::ePrintableRepresentationSpecialCasesAllow,
> + false);
> + }
> +
> + if (ss.GetData() && ss.GetSize())
> + var_representation = ss.GetData();
> + if (arg_idx > 0)
> + s.PutCString (", ");
> + if (var_value_sp->GetError().Success())
> + {
> + if (var_representation)
> + s.Printf ("%s=%s", var_name, var_representation);
> + else
> + s.Printf ("%s=%s at %s", var_name, var_value_sp->GetTypeName().GetCString(), var_value_sp->GetLocationAsCString());
> + }
> else
> - s.Printf ("%s=%s at %s", var_name, var_value_sp->GetTypeName().GetCString(), var_value_sp->GetLocationAsCString());
> + s.Printf ("%s=<unavailable>", var_name);
> }
> +
> + if (close_paren)
> + s.PutCString (close_paren);
> else
> - s.Printf ("%s=<unavailable>", var_name);
> + s.PutChar(')');
> +
> }
> -
> - if (close_paren)
> - s.PutCString (close_paren);
> else
> - s.PutChar(')');
> -
> + {
> + s.PutCString(cstr);
> + }
> + return true;
> }
> - else
> + }
> + else if (sc->symbol)
> + {
> + const char *cstr = sc->symbol->GetName().AsCString (NULL);
> + if (cstr)
> {
> s.PutCString(cstr);
> + return true;
> }
> - return true;
> - }
> - }
> - else if (sc->symbol)
> - {
> - const char *cstr = sc->symbol->GetName().AsCString (NULL);
> - if (cstr)
> - {
> - s.PutCString(cstr);
> - return true;
> }
> }
> }
>
> Modified: lldb/trunk/source/Target/Language.cpp
> URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/source/Target/Language.cpp?rev=253531&r1=253530&r2=253531&view=diff <http://llvm.org/viewvc/llvm-project/lldb/trunk/source/Target/Language.cpp?rev=253531&r1=253530&r2=253531&view=diff>
> ==============================================================================
> --- lldb/trunk/source/Target/Language.cpp (original)
> +++ lldb/trunk/source/Target/Language.cpp Wed Nov 18 19:11:53 2015
> @@ -370,6 +370,14 @@ Language::IsUninitializedReference (Valu
> return false;
> }
>
> +bool
> +Language::GetFunctionDisplayName (const SymbolContext *sc,
> + FunctionNameRepresentation representation,
> + Stream& s)
> +{
> + return false;
> +}
> +
> //----------------------------------------------------------------------
> // Constructor
> //----------------------------------------------------------------------
>
>
> _______________________________________________
> lldb-commits mailing list
> lldb-commits at lists.llvm.org <mailto:lldb-commits at lists.llvm.org>
> http://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits <http://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits>
Thanks,
- Enrico
📩 egranata@.com ☎️ 27683
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/lldb-commits/attachments/20151118/e1935ae2/attachment-0001.html>
More information about the lldb-commits
mailing list