Add SymbolVendor::GetMainFileSpec and simplify CommandObjectTargetModulesList::PrintModule

[ki.stfu]

Summary

Add SymbolVendor::GetMainFileSpec and simplify CommandObjectTargetModulesList::PrintModule.

All tests pass on OS X.

[clayborg]

m_symfile_spec is in Module _only_ for the case where you told us where the symbol file was manually so that we could create the symbol file lazily only when we needed to. You might have /tmp/a.out as the file and /users/me/symbols/a.out as the symbol file and when you create the symbol file we will use Module::GetSymbolFileFileSpec() as a hint as to where to look. The problem is this path might be a path to a bundle, like a dSYM file on MacOSX. So the path might not be resolved and the right file inside the bundle might not be correct. So on MacOSX you might have /tmp/a.out as the module's object file path and "/tmp/a.out.dSYM" as the symbol file path. The SymbolVendorMacOSX will know what to do with this bundle path (it will actually create an object file with "/tmp/a.out.dSYM/Contents/Resources/DWARF/a.out", so though you are updating the m_symfile_spec, it won't be usable by anyone unless they first call Module::GetSymbolVendor() and then call Module::GetSymbolFileFileSpec(). So that isn't a great API. Granted this should be documented better in the GetSymbolFileFileSpec() prototype in the Module.h header file. So the previous code that was there is correct and no changes really need to be made since I wouldn't want anyone really using GetSymbolFileFileSpec() since they would have to know to call Module::GetSymbolVendor() first. Feel free to add a SymbolVendor::GetMainFileSpec() to SymbolVendor and place the following code in it:

SymbolFile *symbol_file = symbol_vendor->GetSymbolFile();
if (symbol_file)
{
    ObjectFile *object_file = symbol_file->GetObjectFile();
    if (object_file)
        return object_file->GetFileSpec();
}
return FileSpec();

We should name the accessor SymbolVendor::GetMainFileSpec() because a SymbolVendor might use more than one file for the debug info. None currently do, but that is the idea behind SymbolVendor: do what you need to do to get the best debug info possible and use as many sources/files as required.

[ki.stfu]

Add SymbolVendor::GetMainFileSpec

[ki.stfu]

Some fixes

include/lldb/Symbol/SymbolVendor.h

GetTypes (SymbolContextScope *sc_scope,
               TypeList &type_list);
 
     SymbolFile *
     GetSymbolFile()
     {
         return m_sym_file_ap.get();
     }
 
+    FileSpec &
+    GetMainFileSpec();
+
+    const FileSpec &
+    GetMainFileSpec() const;
+
     // Get module unified section list symbol table.
     virtual Symtab *
     GetSymtab ();
 
     // Clear module unified section list symbol table.
     virtual void
     ClearSymtab ();
 

source/Commands/CommandObjectTarget.cpp

PrintModule (Target *target, Module *module, int indent, Stream &strm)
                         else
                             strm.Printf("{%" PRIu64 "}", (uint64_t)ref_count);
                     }
                     break;
 
                 case 's':
                 case 'S':
                     {
-                        SymbolVendor *symbol_vendor = module->GetSymbolVendor();
+                        const SymbolVendor *symbol_vendor = module->GetSymbolVendor();
                         if (symbol_vendor)
                         {
-                            SymbolFile *symbol_file = symbol_vendor->GetSymbolFile();
-                            if (symbol_file)
-                            {
-                                if (format_char == 'S')
-                                {
-                                    FileSpec &symfile_spec = symbol_file->GetObjectFile()->GetFileSpec();
-                                    // Dump symbol file only if different from module file
-                                    if (!symfile_spec || symfile_spec == module->GetFileSpec())
-                                    {
-                                        print_space = false;
-                                        break;
-                                    }
-                                    // Add a newline and indent past the index
-                                    strm.Printf ("\n%*s", indent, "");
-                                }
-                                DumpFullpath (strm, &symbol_file->GetObjectFile()->GetFileSpec(), width);
-                                dump_object_name = true;
-                                break;
-                            }
-                        }
+                            const FileSpec &symfile_spec = symbol_vendor->GetMainFileSpec();
+                            DumpFullpath (strm, &symfile_spec, width);
                         strm.Printf("%.*s", width, "<NONE>");
                     }
                     break;
 
                 case 'm':
                     module->GetModificationTime().Dump(&strm, width);
                     break;
 

source/Symbol/SymbolVendor.cpp

if (module_sp)
                 m_compile_units[idx] = m_sym_file_ap->ParseCompileUnitAtIndex(idx);
                 cu_sp = m_compile_units[idx];
             }
         }
     }
     return cu_sp;
 }
 
+FileSpec &
+GetMainFileSpec()
+{
+    if (m_sym_file_ap.get())
+    {
+        ObjectFile *symfile_objfile = m_sym_file_ap->GetObjectFile();
+        if (symfile_objfile)
+            return symfile_objfile->GetFileSpec();
+    }
+
+    return FileSpec();
+}
+
+const FileSpec &
+GetMainFileSpec() const
+{
+    if (m_sym_file_ap.get())
+    {
+        const ObjectFile *symfile_objfile = m_sym_file_ap->GetObjectFile();
+        if (symfile_objfile)
+            return symfile_objfile->GetFileSpec();
+    }
+
+    return FileSpec();
+}
+
 Symtab *
 SymbolVendor::GetSymtab ()
 {
     ModuleSP module_sp(GetModule());
     if (module_sp)
     {
         ObjectFile *objfile = module_sp->GetObjectFile();
         if (objfile)