Add support for displaying the language in the frame-format string

[dawn]

Summary

Enable ${language} to be specified in the frame-format string to see the current frame's compile unit language in "frame info".

[dawn]

Please review? Thank you.

[clayborg]

Looks good.

lldb/trunk/include/lldb/Core/FormatEntity.h

public:
                 ThreadReturnValue,
                 ThreadCompletedExpression,
                 ScriptThread,
                 ThreadInfo,
                 TargetArch,
                 ScriptTarget,
                 ModuleFile,
                 File,
+                Lang,
                 FrameIndex,
                 FrameRegisterPC,
                 FrameRegisterSP,
                 FrameRegisterFP,
                 FrameRegisterFlags,
                 FrameRegisterByName,
                 ScriptFrame,
                 FunctionID,

lldb/trunk/source/Core/FormatEntity.cpp

 //===-- FormatEntity.cpp ----------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/ADT/StringRef.h"
 
 #include "lldb/Core/FormatEntity.h"
 
 #include "lldb/Core/Address.h"
 #include "lldb/Core/Debugger.h"
+#include "lldb/Core/Language.h"
 #include "lldb/Core/Module.h"
 #include "lldb/Core/Stream.h"
 #include "lldb/Core/StreamString.h"
 #include "lldb/Core/ValueObject.h"
 #include "lldb/Core/ValueObjectVariable.h"
 #include "lldb/DataFormatters/DataVisualization.h"
 #include "lldb/DataFormatters/FormatManager.h"
 #include "lldb/Expression/ClangExpressionVariable.h"

 
 static FormatEntity::Entry::Definition g_top_level_entries[] =
 {
     ENTRY_CHILDREN          ("addr"                , AddressLoadOrFile      , UInt64    , g_addr_entries),
     ENTRY                   ("addr-file-or-load"   , AddressLoadOrFile      , UInt64    ),
     ENTRY_CHILDREN          ("ansi"                , Invalid                , None      , g_ansi_entries),
     ENTRY                   ("current-pc-arrow"    , CurrentPCArrow         , CString   ),
     ENTRY_CHILDREN          ("file"                , File                   , CString   , g_file_child_entries),
+    ENTRY                   ("language"            , Lang                   , CString),
     ENTRY_CHILDREN          ("frame"               , Invalid                , None      , g_frame_child_entries),
     ENTRY_CHILDREN          ("function"            , Invalid                , None      , g_function_child_entries),
     ENTRY_CHILDREN          ("line"                , Invalid                , None      , g_line_child_entries),
     ENTRY_CHILDREN          ("module"              , Invalid                , None      , g_module_child_entries),
     ENTRY_CHILDREN          ("process"             , Invalid                , None      , g_process_child_entries),
     ENTRY_CHILDREN          ("script"              , Invalid                , None      , g_script_child_entries),
     ENTRY_CHILDREN_KEEP_SEP ("svar"                , VariableSynthetic      , None      , g_svar_child_entries),
     ENTRY_CHILDREN          ("thread"              , Invalid                , None      , g_thread_child_entries),
FormatEntity::Entry::TypeToCString (Type t)
     ENUM_TO_CSTR(ThreadReturnValue);
     ENUM_TO_CSTR(ThreadCompletedExpression);
     ENUM_TO_CSTR(ScriptThread);
     ENUM_TO_CSTR(ThreadInfo);
     ENUM_TO_CSTR(TargetArch);
     ENUM_TO_CSTR(ScriptTarget);
     ENUM_TO_CSTR(ModuleFile);
     ENUM_TO_CSTR(File);
+    ENUM_TO_CSTR(Lang);
     ENUM_TO_CSTR(FrameIndex);
     ENUM_TO_CSTR(FrameRegisterPC);
     ENUM_TO_CSTR(FrameRegisterSP);
     ENUM_TO_CSTR(FrameRegisterFP);
     ENUM_TO_CSTR(FrameRegisterFlags);
     ENUM_TO_CSTR(FrameRegisterByName);
     ENUM_TO_CSTR(ScriptFrame);
     ENUM_TO_CSTR(FunctionID);
switch (entry.type)
                 {
                     // CompileUnit is a FileSpec
                     if (DumpFile(s, *cu, (FileKind)entry.number))
                         return true;
                 }
             }
             return false;
 
+        case Entry::Type::Lang:
+            if (sc)
+            {
+                CompileUnit *cu = sc->comp_unit;
+                if (cu)
+                {
+                    Language lang(cu->GetLanguage());
+                    const char *lang_name = lang.AsCString();
+                    if (lang_name)
+                    {
+                        s.PutCString(lang_name);
+                        return true;
+                    }
+                }
+            }
+            return false;
+
         case Entry::Type::FrameIndex:
             if (exe_ctx)
             {
                 StackFrame *frame = exe_ctx->GetFramePtr();
                 if (frame)
                 {
                     const char *format = "%" PRIu32;
                     if (!entry.printf_format.empty())

lldb/trunk/test/settings/TestSettings.py

def test_set_frame_format(self):
         self.runCmd("settings show frame-format")
         m = re.match(
                 '^frame-format \(format-string\) = "(.*)\"$',
                 self.res.GetOutput())
         self.assertTrue(m, "Bad settings string")
         self.format_string = m.group(1)
 
         # Change the default format to print function.name rather than function.name-with-args
-        format_string = "frame #${frame.index}: ${frame.pc}{ ${module.file.basename}`${function.name}{${function.pc-offset}}}{ at ${line.file.fullpath}:${line.number}}\n"
+        format_string = "frame #${frame.index}: ${frame.pc}{ ${module.file.basename}`${function.name}{${function.pc-offset}}}{ at ${line.file.fullpath}:${line.number}}{, lang=${language}}\n"
         self.runCmd("settings set frame-format %s" % format_string)
 
         # Immediately test the setting.
         self.expect("settings show frame-format", SETTING_MSG("frame-format"),
             substrs = [format_string])
 
         self.runCmd("breakpoint set -n main")
         self.runCmd("run")

lldb/trunk/www/formats.html

<div id="middle">
               <div class="postcontent">
 
                    <p>A complete list of currently supported format string variables is listed below:</p>
 
                    <table border="1">
                     <tr valign=top><td><b>Variable Name</b></td><td><b>Description</b></td></tr>
                     <tr valign=top><td><b>file.basename</b></td><td>The current compile unit file basename for the current frame.</td></tr>
                     <tr valign=top><td><b>file.fullpath</b></td><td>The current compile unit file fullpath for the current frame.</td></tr>
+                    <tr valign=top><td><b>language</b></td><td>The current compile unit language for the current frame.</td></tr>
                     <tr valign=top><td><b>frame.index</b></td><td>The frame index (0, 1, 2, 3...)</td></tr>
                     <tr valign=top><td><b>frame.pc</b></td><td>The generic frame register for the program counter.</td></tr>
                     <tr valign=top><td><b>frame.sp</b></td><td>The generic frame register for the stack pointer.</td></tr>
                     <tr valign=top><td><b>frame.fp</b></td><td>The generic frame register for the frame pointer.</td></tr>
                     <tr valign=top><td><b>frame.flags</b></td><td>The generic frame register for the flags register.</td></tr>
                     <tr valign=top><td><b>frame.reg.NAME</b></td><td>Access to any platform specific register by name (replace <b>NAME</b> with the name of the desired register).</td></tr>
                     <tr valign=top><td><b>function.name</b></td><td>The name of the current function or symbol.</td></tr>
                     <tr valign=top><td><b>function.name-with-args</b></td><td>The name of the current function with arguments and values or the symbol name.</td></tr>