contrib/llvm-project/lldb/source/Core/SourceManager.cpp

   1 //===-- SourceManager.cpp -------------------------------------------------===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #include "lldb/Core/SourceManager.h"
  10
  11 #include "lldb/Core/Address.h"
  12 #include "lldb/Core/AddressRange.h"
  13 #include "lldb/Core/Debugger.h"
  14 #include "lldb/Core/FormatEntity.h"
  15 #include "lldb/Core/Highlighter.h"
  16 #include "lldb/Core/Module.h"
  17 #include "lldb/Core/ModuleList.h"
  18 #include "lldb/Host/FileSystem.h"
  19 #include "lldb/Symbol/CompileUnit.h"
  20 #include "lldb/Symbol/Function.h"
  21 #include "lldb/Symbol/LineEntry.h"
  22 #include "lldb/Symbol/SymbolContext.h"
  23 #include "lldb/Target/PathMappingList.h"
  24 #include "lldb/Target/Target.h"
  25 #include "lldb/Utility/AnsiTerminal.h"
  26 #include "lldb/Utility/ConstString.h"
  27 #include "lldb/Utility/DataBuffer.h"
  28 #include "lldb/Utility/DataBufferLLVM.h"
  29 #include "lldb/Utility/RegularExpression.h"
  30 #include "lldb/Utility/Stream.h"
  31 #include "lldb/lldb-enumerations.h"
  32
  33 #include "llvm/ADT/Twine.h"
  34
  35 #include <memory>
  36 #include <utility>
  37
  38 #include <assert.h>
  39 #include <stdio.h>
  40
  41 namespace lldb_private {
  42 class ExecutionContext;
  43 }
  44 namespace lldb_private {
  45 class ValueObject;
  46 }
  47
  48 using namespace lldb;
  49 using namespace lldb_private;
  50
  51 static inline bool is_newline_char(char ch) { return ch == '\n' || ch == '\r'; }
  52
  53 // SourceManager constructor
  54 SourceManager::SourceManager(const TargetSP &target_sp)
  55     : m_last_line(0), m_last_count(0), m_default_set(false),
  56       m_target_wp(target_sp),
  57       m_debugger_wp(target_sp->GetDebugger().shared_from_this()) {}
  58
  59 SourceManager::SourceManager(const DebuggerSP &debugger_sp)
  60     : m_last_line(0), m_last_count(0), m_default_set(false), m_target_wp(),
  61       m_debugger_wp(debugger_sp) {}
  62
  63 // Destructor
  64 SourceManager::~SourceManager() {}
  65
  66 SourceManager::FileSP SourceManager::GetFile(const FileSpec &file_spec) {
  67   if (!file_spec)
  68     return nullptr;
  69
  70   DebuggerSP debugger_sp(m_debugger_wp.lock());
  71   FileSP file_sp;
  72   if (debugger_sp && debugger_sp->GetUseSourceCache())
  73     file_sp = debugger_sp->GetSourceFileCache().FindSourceFile(file_spec);
  74
  75   TargetSP target_sp(m_target_wp.lock());
  76
  77   // It the target source path map has been updated, get this file again so we
  78   // can successfully remap the source file
  79   if (target_sp && file_sp &&
  80       file_sp->GetSourceMapModificationID() !=
  81           target_sp->GetSourcePathMap().GetModificationID())
  82     file_sp.reset();
  83
  84   // Update the file contents if needed if we found a file
  85   if (file_sp)
  86     file_sp->UpdateIfNeeded();
  87
  88   // If file_sp is no good or it points to a non-existent file, reset it.
  89   if (!file_sp || !FileSystem::Instance().Exists(file_sp->GetFileSpec())) {
  90     if (target_sp)
  91       file_sp = std::make_shared<File>(file_spec, target_sp.get());
  92     else
  93       file_sp = std::make_shared<File>(file_spec, debugger_sp);
  94
  95     if (debugger_sp && debugger_sp->GetUseSourceCache())
  96       debugger_sp->GetSourceFileCache().AddSourceFile(file_sp);
  97   }
  98   return file_sp;
  99 }
 100
 101 static bool should_highlight_source(DebuggerSP debugger_sp) {
 102   if (!debugger_sp)
 103     return false;
 104
 105   // We don't use ANSI stop column formatting if the debugger doesn't think it
 106   // should be using color.
 107   if (!debugger_sp->GetUseColor())
 108     return false;
 109
 110   return debugger_sp->GetHighlightSource();
 111 }
 112
 113 static bool should_show_stop_column_with_ansi(DebuggerSP debugger_sp) {
 114   // We don't use ANSI stop column formatting if we can't lookup values from
 115   // the debugger.
 116   if (!debugger_sp)
 117     return false;
 118
 119   // We don't use ANSI stop column formatting if the debugger doesn't think it
 120   // should be using color.
 121   if (!debugger_sp->GetUseColor())
 122     return false;
 123
 124   // We only use ANSI stop column formatting if we're either supposed to show
 125   // ANSI where available (which we know we have when we get to this point), or
 126   // if we're only supposed to use ANSI.
 127   const auto value = debugger_sp->GetStopShowColumn();
 128   return ((value == eStopShowColumnAnsiOrCaret) ||
 129           (value == eStopShowColumnAnsi));
 130 }
 131
 132 static bool should_show_stop_column_with_caret(DebuggerSP debugger_sp) {
 133   // We don't use text-based stop column formatting if we can't lookup values
 134   // from the debugger.
 135   if (!debugger_sp)
 136     return false;
 137
 138   // If we're asked to show the first available of ANSI or caret, then we do
 139   // show the caret when ANSI is not available.
 140   const auto value = debugger_sp->GetStopShowColumn();
 141   if ((value == eStopShowColumnAnsiOrCaret) && !debugger_sp->GetUseColor())
 142     return true;
 143
 144   // The only other time we use caret is if we're explicitly asked to show
 145   // caret.
 146   return value == eStopShowColumnCaret;
 147 }
 148
 149 static bool should_show_stop_line_with_ansi(DebuggerSP debugger_sp) {
 150   return debugger_sp && debugger_sp->GetUseColor();
 151 }
 152
 153 size_t SourceManager::DisplaySourceLinesWithLineNumbersUsingLastFile(
 154     uint32_t start_line, uint32_t count, uint32_t curr_line, uint32_t column,
 155     const char *current_line_cstr, Stream *s,
 156     const SymbolContextList *bp_locs) {
 157   if (count == 0)
 158     return 0;
 159
 160   Stream::ByteDelta delta(*s);
 161
 162   if (start_line == 0) {
 163     if (m_last_line != 0 && m_last_line != UINT32_MAX)
 164       start_line = m_last_line + m_last_count;
 165     else
 166       start_line = 1;
 167   }
 168
 169   if (!m_default_set) {
 170     FileSpec tmp_spec;
 171     uint32_t tmp_line;
 172     GetDefaultFileAndLine(tmp_spec, tmp_line);
 173   }
 174
 175   m_last_line = start_line;
 176   m_last_count = count;
 177
 178   if (FileSP last_file_sp = GetLastFile()) {
 179     const uint32_t end_line = start_line + count - 1;
 180     for (uint32_t line = start_line; line <= end_line; ++line) {
 181       if (!last_file_sp->LineIsValid(line)) {
 182         m_last_line = UINT32_MAX;
 183         break;
 184       }
 185
 186       char prefix[32] = "";
 187       if (bp_locs) {
 188         uint32_t bp_count = bp_locs->NumLineEntriesWithLine(line);
 189
 190         if (bp_count > 0)
 191           ::snprintf(prefix, sizeof(prefix), "[%u] ", bp_count);
 192         else
 193           ::snprintf(prefix, sizeof(prefix), "    ");
 194       }
 195
 196       char buffer[3];
 197       sprintf(buffer, "%2.2s", (line == curr_line) ? current_line_cstr : "");
 198       std::string current_line_highlight(buffer);
 199
 200       auto debugger_sp = m_debugger_wp.lock();
 201       if (should_show_stop_line_with_ansi(debugger_sp)) {
 202         current_line_highlight = ansi::FormatAnsiTerminalCodes(
 203             (debugger_sp->GetStopShowLineMarkerAnsiPrefix() +
 204              current_line_highlight +
 205              debugger_sp->GetStopShowLineMarkerAnsiSuffix())
 206                 .str());
 207       }
 208
 209       s->Printf("%s%s %-4u\t", prefix, current_line_highlight.c_str(), line);
 210
 211       // So far we treated column 0 as a special 'no column value', but
 212       // DisplaySourceLines starts counting columns from 0 (and no column is
 213       // expressed by passing an empty optional).
 214       llvm::Optional<size_t> columnToHighlight;
 215       if (line == curr_line && column)
 216         columnToHighlight = column - 1;
 217
 218       size_t this_line_size =
 219           last_file_sp->DisplaySourceLines(line, columnToHighlight, 0, 0, s);
 220       if (column != 0 && line == curr_line &&
 221           should_show_stop_column_with_caret(debugger_sp)) {
 222         // Display caret cursor.
 223         std::string src_line;
 224         last_file_sp->GetLine(line, src_line);
 225         s->Printf("    \t");
 226         // Insert a space for every non-tab character in the source line.
 227         for (size_t i = 0; i + 1 < column && i < src_line.length(); ++i)
 228           s->PutChar(src_line[i] == '\t' ? '\t' : ' ');
 229         // Now add the caret.
 230         s->Printf("^\n");
 231       }
 232       if (this_line_size == 0) {
 233         m_last_line = UINT32_MAX;
 234         break;
 235       }
 236     }
 237   }
 238   return *delta;
 239 }
 240
 241 size_t SourceManager::DisplaySourceLinesWithLineNumbers(
 242     const FileSpec &file_spec, uint32_t line, uint32_t column,
 243     uint32_t context_before, uint32_t context_after,
 244     const char *current_line_cstr, Stream *s,
 245     const SymbolContextList *bp_locs) {
 246   FileSP file_sp(GetFile(file_spec));
 247
 248   uint32_t start_line;
 249   uint32_t count = context_before + context_after + 1;
 250   if (line > context_before)
 251     start_line = line - context_before;
 252   else
 253     start_line = 1;
 254
 255   FileSP last_file_sp(GetLastFile());
 256   if (last_file_sp.get() != file_sp.get()) {
 257     if (line == 0)
 258       m_last_line = 0;
 259     m_last_file_spec = file_spec;
 260   }
 261   return DisplaySourceLinesWithLineNumbersUsingLastFile(
 262       start_line, count, line, column, current_line_cstr, s, bp_locs);
 263 }
 264
 265 size_t SourceManager::DisplayMoreWithLineNumbers(
 266     Stream *s, uint32_t count, bool reverse, const SymbolContextList *bp_locs) {
 267   // If we get called before anybody has set a default file and line, then try
 268   // to figure it out here.
 269   FileSP last_file_sp(GetLastFile());
 270   const bool have_default_file_line = last_file_sp && m_last_line > 0;
 271   if (!m_default_set) {
 272     FileSpec tmp_spec;
 273     uint32_t tmp_line;
 274     GetDefaultFileAndLine(tmp_spec, tmp_line);
 275   }
 276
 277   if (last_file_sp) {
 278     if (m_last_line == UINT32_MAX)
 279       return 0;
 280
 281     if (reverse && m_last_line == 1)
 282       return 0;
 283
 284     if (count > 0)
 285       m_last_count = count;
 286     else if (m_last_count == 0)
 287       m_last_count = 10;
 288
 289     if (m_last_line > 0) {
 290       if (reverse) {
 291         // If this is the first time we've done a reverse, then back up one
 292         // more time so we end up showing the chunk before the last one we've
 293         // shown:
 294         if (m_last_line > m_last_count)
 295           m_last_line -= m_last_count;
 296         else
 297           m_last_line = 1;
 298       } else if (have_default_file_line)
 299         m_last_line += m_last_count;
 300     } else
 301       m_last_line = 1;
 302
 303     const uint32_t column = 0;
 304     return DisplaySourceLinesWithLineNumbersUsingLastFile(
 305         m_last_line, m_last_count, UINT32_MAX, column, "", s, bp_locs);
 306   }
 307   return 0;
 308 }
 309
 310 bool SourceManager::SetDefaultFileAndLine(const FileSpec &file_spec,
 311                                           uint32_t line) {
 312   m_default_set = true;
 313   FileSP file_sp(GetFile(file_spec));
 314
 315   if (file_sp) {
 316     m_last_line = line;
 317     m_last_file_spec = file_spec;
 318     return true;
 319   } else {
 320     return false;
 321   }
 322 }
 323
 324 bool SourceManager::GetDefaultFileAndLine(FileSpec &file_spec, uint32_t &line) {
 325   if (FileSP last_file_sp = GetLastFile()) {
 326     file_spec = m_last_file_spec;
 327     line = m_last_line;
 328     return true;
 329   } else if (!m_default_set) {
 330     TargetSP target_sp(m_target_wp.lock());
 331
 332     if (target_sp) {
 333       // If nobody has set the default file and line then try here.  If there's
 334       // no executable, then we will try again later when there is one.
 335       // Otherwise, if we can't find it we won't look again, somebody will have
 336       // to set it (for instance when we stop somewhere...)
 337       Module *executable_ptr = target_sp->GetExecutableModulePointer();
 338       if (executable_ptr) {
 339         SymbolContextList sc_list;
 340         ConstString main_name("main");
 341         bool symbols_okay = false; // Force it to be a debug symbol.
 342         bool inlines_okay = true;
 343         executable_ptr->FindFunctions(main_name, CompilerDeclContext(),
 344                                       lldb::eFunctionNameTypeBase, inlines_okay,
 345                                       symbols_okay, sc_list);
 346         size_t num_matches = sc_list.GetSize();
 347         for (size_t idx = 0; idx < num_matches; idx++) {
 348           SymbolContext sc;
 349           sc_list.GetContextAtIndex(idx, sc);
 350           if (sc.function) {
 351             lldb_private::LineEntry line_entry;
 352             if (sc.function->GetAddressRange()
 353                     .GetBaseAddress()
 354                     .CalculateSymbolContextLineEntry(line_entry)) {
 355               SetDefaultFileAndLine(line_entry.file, line_entry.line);
 356               file_spec = m_last_file_spec;
 357               line = m_last_line;
 358               return true;
 359             }
 360           }
 361         }
 362       }
 363     }
 364   }
 365   return false;
 366 }
 367
 368 void SourceManager::FindLinesMatchingRegex(FileSpec &file_spec,
 369                                            RegularExpression &regex,
 370                                            uint32_t start_line,
 371                                            uint32_t end_line,
 372                                            std::vector<uint32_t> &match_lines) {
 373   match_lines.clear();
 374   FileSP file_sp = GetFile(file_spec);
 375   if (!file_sp)
 376     return;
 377   return file_sp->FindLinesMatchingRegex(regex, start_line, end_line,
 378                                          match_lines);
 379 }
 380
 381 SourceManager::File::File(const FileSpec &file_spec,
 382                           lldb::DebuggerSP debugger_sp)
 383     : m_file_spec_orig(file_spec), m_file_spec(file_spec),
 384       m_mod_time(FileSystem::Instance().GetModificationTime(file_spec)),
 385       m_debugger_wp(debugger_sp) {
 386   CommonInitializer(file_spec, nullptr);
 387 }
 388
 389 SourceManager::File::File(const FileSpec &file_spec, Target *target)
 390     : m_file_spec_orig(file_spec), m_file_spec(file_spec),
 391       m_mod_time(FileSystem::Instance().GetModificationTime(file_spec)),
 392       m_debugger_wp(target ? target->GetDebugger().shared_from_this()
 393                            : DebuggerSP()) {
 394   CommonInitializer(file_spec, target);
 395 }
 396
 397 void SourceManager::File::CommonInitializer(const FileSpec &file_spec,
 398                                             Target *target) {
 399   if (m_mod_time == llvm::sys::TimePoint<>()) {
 400     if (target) {
 401       m_source_map_mod_id = target->GetSourcePathMap().GetModificationID();
 402
 403       if (!file_spec.GetDirectory() && file_spec.GetFilename()) {
 404         // If this is just a file name, lets see if we can find it in the
 405         // target:
 406         bool check_inlines = false;
 407         SymbolContextList sc_list;
 408         size_t num_matches =
 409             target->GetImages().ResolveSymbolContextForFilePath(
 410                 file_spec.GetFilename().AsCString(), 0, check_inlines,
 411                 SymbolContextItem(eSymbolContextModule |
 412                                   eSymbolContextCompUnit),
 413                 sc_list);
 414         bool got_multiple = false;
 415         if (num_matches != 0) {
 416           if (num_matches > 1) {
 417             SymbolContext sc;
 418             CompileUnit *test_cu = nullptr;
 419
 420             for (unsigned i = 0; i < num_matches; i++) {
 421               sc_list.GetContextAtIndex(i, sc);
 422               if (sc.comp_unit) {
 423                 if (test_cu) {
 424                   if (test_cu != sc.comp_unit)
 425                     got_multiple = true;
 426                   break;
 427                 } else
 428                   test_cu = sc.comp_unit;
 429               }
 430             }
 431           }
 432           if (!got_multiple) {
 433             SymbolContext sc;
 434             sc_list.GetContextAtIndex(0, sc);
 435             if (sc.comp_unit)
 436               m_file_spec = sc.comp_unit->GetPrimaryFile();
 437             m_mod_time = FileSystem::Instance().GetModificationTime(m_file_spec);
 438           }
 439         }
 440       }
 441       // Try remapping if m_file_spec does not correspond to an existing file.
 442       if (!FileSystem::Instance().Exists(m_file_spec)) {
 443         FileSpec new_file_spec;
 444         // Check target specific source remappings first, then fall back to
 445         // modules objects can have individual path remappings that were
 446         // detected when the debug info for a module was found. then
 447         if (target->GetSourcePathMap().FindFile(m_file_spec, new_file_spec) ||
 448             target->GetImages().FindSourceFile(m_file_spec, new_file_spec)) {
 449           m_file_spec = new_file_spec;
 450           m_mod_time = FileSystem::Instance().GetModificationTime(m_file_spec);
 451         }
 452       }
 453     }
 454   }
 455
 456   if (m_mod_time != llvm::sys::TimePoint<>())
 457     m_data_sp = FileSystem::Instance().CreateDataBuffer(m_file_spec);
 458 }
 459
 460 uint32_t SourceManager::File::GetLineOffset(uint32_t line) {
 461   if (line == 0)
 462     return UINT32_MAX;
 463
 464   if (line == 1)
 465     return 0;
 466
 467   if (CalculateLineOffsets(line)) {
 468     if (line < m_offsets.size())
 469       return m_offsets[line - 1]; // yes we want "line - 1" in the index
 470   }
 471   return UINT32_MAX;
 472 }
 473
 474 uint32_t SourceManager::File::GetNumLines() {
 475   CalculateLineOffsets();
 476   return m_offsets.size();
 477 }
 478
 479 const char *SourceManager::File::PeekLineData(uint32_t line) {
 480   if (!LineIsValid(line))
 481     return nullptr;
 482
 483   size_t line_offset = GetLineOffset(line);
 484   if (line_offset < m_data_sp->GetByteSize())
 485     return (const char *)m_data_sp->GetBytes() + line_offset;
 486   return nullptr;
 487 }
 488
 489 uint32_t SourceManager::File::GetLineLength(uint32_t line,
 490                                             bool include_newline_chars) {
 491   if (!LineIsValid(line))
 492     return false;
 493
 494   size_t start_offset = GetLineOffset(line);
 495   size_t end_offset = GetLineOffset(line + 1);
 496   if (end_offset == UINT32_MAX)
 497     end_offset = m_data_sp->GetByteSize();
 498
 499   if (end_offset > start_offset) {
 500     uint32_t length = end_offset - start_offset;
 501     if (!include_newline_chars) {
 502       const char *line_start =
 503           (const char *)m_data_sp->GetBytes() + start_offset;
 504       while (length > 0) {
 505         const char last_char = line_start[length - 1];
 506         if ((last_char == '\r') || (last_char == '\n'))
 507           --length;
 508         else
 509           break;
 510       }
 511     }
 512     return length;
 513   }
 514   return 0;
 515 }
 516
 517 bool SourceManager::File::LineIsValid(uint32_t line) {
 518   if (line == 0)
 519     return false;
 520
 521   if (CalculateLineOffsets(line))
 522     return line < m_offsets.size();
 523   return false;
 524 }
 525
 526 void SourceManager::File::UpdateIfNeeded() {
 527   // TODO: use host API to sign up for file modifications to anything in our
 528   // source cache and only update when we determine a file has been updated.
 529   // For now we check each time we want to display info for the file.
 530   auto curr_mod_time = FileSystem::Instance().GetModificationTime(m_file_spec);
 531
 532   if (curr_mod_time != llvm::sys::TimePoint<>() &&
 533       m_mod_time != curr_mod_time) {
 534     m_mod_time = curr_mod_time;
 535     m_data_sp = FileSystem::Instance().CreateDataBuffer(m_file_spec);
 536     m_offsets.clear();
 537   }
 538 }
 539
 540 size_t SourceManager::File::DisplaySourceLines(uint32_t line,
 541                                                llvm::Optional<size_t> column,
 542                                                uint32_t context_before,
 543                                                uint32_t context_after,
 544                                                Stream *s) {
 545   // Nothing to write if there's no stream.
 546   if (!s)
 547     return 0;
 548
 549   // Sanity check m_data_sp before proceeding.
 550   if (!m_data_sp)
 551     return 0;
 552
 553   size_t bytes_written = s->GetWrittenBytes();
 554
 555   auto debugger_sp = m_debugger_wp.lock();
 556
 557   HighlightStyle style;
 558   // Use the default Vim style if source highlighting is enabled.
 559   if (should_highlight_source(debugger_sp))
 560     style = HighlightStyle::MakeVimStyle();
 561
 562   // If we should mark the stop column with color codes, then copy the prefix
 563   // and suffix to our color style.
 564   if (should_show_stop_column_with_ansi(debugger_sp))
 565     style.selected.Set(debugger_sp->GetStopShowColumnAnsiPrefix(),
 566                        debugger_sp->GetStopShowColumnAnsiSuffix());
 567
 568   HighlighterManager mgr;
 569   std::string path = GetFileSpec().GetPath(/*denormalize*/ false);
 570   // FIXME: Find a way to get the definitive language this file was written in
 571   // and pass it to the highlighter.
 572   const auto &h = mgr.getHighlighterFor(lldb::eLanguageTypeUnknown, path);
 573
 574   const uint32_t start_line =
 575       line <= context_before ? 1 : line - context_before;
 576   const uint32_t start_line_offset = GetLineOffset(start_line);
 577   if (start_line_offset != UINT32_MAX) {
 578     const uint32_t end_line = line + context_after;
 579     uint32_t end_line_offset = GetLineOffset(end_line + 1);
 580     if (end_line_offset == UINT32_MAX)
 581       end_line_offset = m_data_sp->GetByteSize();
 582
 583     assert(start_line_offset <= end_line_offset);
 584     if (start_line_offset < end_line_offset) {
 585       size_t count = end_line_offset - start_line_offset;
 586       const uint8_t *cstr = m_data_sp->GetBytes() + start_line_offset;
 587
 588       auto ref = llvm::StringRef(reinterpret_cast<const char *>(cstr), count);
 589
 590       h.Highlight(style, ref, column, "", *s);
 591
 592       // Ensure we get an end of line character one way or another.
 593       if (!is_newline_char(ref.back()))
 594         s->EOL();
 595     }
 596   }
 597   return s->GetWrittenBytes() - bytes_written;
 598 }
 599
 600 void SourceManager::File::FindLinesMatchingRegex(
 601     RegularExpression &regex, uint32_t start_line, uint32_t end_line,
 602     std::vector<uint32_t> &match_lines) {
 603   match_lines.clear();
 604
 605   if (!LineIsValid(start_line) ||
 606       (end_line != UINT32_MAX && !LineIsValid(end_line)))
 607     return;
 608   if (start_line > end_line)
 609     return;
 610
 611   for (uint32_t line_no = start_line; line_no < end_line; line_no++) {
 612     std::string buffer;
 613     if (!GetLine(line_no, buffer))
 614       break;
 615     if (regex.Execute(buffer)) {
 616       match_lines.push_back(line_no);
 617     }
 618   }
 619 }
 620
 621 bool lldb_private::operator==(const SourceManager::File &lhs,
 622                               const SourceManager::File &rhs) {
 623   if (lhs.m_file_spec != rhs.m_file_spec)
 624     return false;
 625   return lhs.m_mod_time == rhs.m_mod_time;
 626 }
 627
 628 bool SourceManager::File::CalculateLineOffsets(uint32_t line) {
 629   line =
 630       UINT32_MAX; // TODO: take this line out when we support partial indexing
 631   if (line == UINT32_MAX) {
 632     // Already done?
 633     if (!m_offsets.empty() && m_offsets[0] == UINT32_MAX)
 634       return true;
 635
 636     if (m_offsets.empty()) {
 637       if (m_data_sp.get() == nullptr)
 638         return false;
 639
 640       const char *start = (char *)m_data_sp->GetBytes();
 641       if (start) {
 642         const char *end = start + m_data_sp->GetByteSize();
 643
 644         // Calculate all line offsets from scratch
 645
 646         // Push a 1 at index zero to indicate the file has been completely
 647         // indexed.
 648         m_offsets.push_back(UINT32_MAX);
 649         const char *s;
 650         for (s = start; s < end; ++s) {
 651           char curr_ch = *s;
 652           if (is_newline_char(curr_ch)) {
 653             if (s + 1 < end) {
 654               char next_ch = s[1];
 655               if (is_newline_char(next_ch)) {
 656                 if (curr_ch != next_ch)
 657                   ++s;
 658               }
 659             }
 660             m_offsets.push_back(s + 1 - start);
 661           }
 662         }
 663         if (!m_offsets.empty()) {
 664           if (m_offsets.back() < size_t(end - start))
 665             m_offsets.push_back(end - start);
 666         }
 667         return true;
 668       }
 669     } else {
 670       // Some lines have been populated, start where we last left off
 671       assert("Not implemented yet" && false);
 672     }
 673
 674   } else {
 675     // Calculate all line offsets up to "line"
 676     assert("Not implemented yet" && false);
 677   }
 678   return false;
 679 }
 680
 681 bool SourceManager::File::GetLine(uint32_t line_no, std::string &buffer) {
 682   if (!LineIsValid(line_no))
 683     return false;
 684
 685   size_t start_offset = GetLineOffset(line_no);
 686   size_t end_offset = GetLineOffset(line_no + 1);
 687   if (end_offset == UINT32_MAX) {
 688     end_offset = m_data_sp->GetByteSize();
 689   }
 690   buffer.assign((char *)m_data_sp->GetBytes() + start_offset,
 691                 end_offset - start_offset);
 692
 693   return true;
 694 }
 695
 696 void SourceManager::SourceFileCache::AddSourceFile(const FileSP &file_sp) {
 697   FileSpec file_spec = file_sp->GetFileSpec();
 698   FileCache::iterator pos = m_file_cache.find(file_spec);
 699   if (pos == m_file_cache.end())
 700     m_file_cache[file_spec] = file_sp;
 701   else {
 702     if (file_sp != pos->second)
 703       m_file_cache[file_spec] = file_sp;
 704   }
 705 }
 706
 707 SourceManager::FileSP SourceManager::SourceFileCache::FindSourceFile(
 708     const FileSpec &file_spec) const {
 709   FileSP file_sp;
 710   FileCache::const_iterator pos = m_file_cache.find(file_spec);
 711   if (pos != m_file_cache.end())
 712     file_sp = pos->second;
 713   return file_sp;
 714 }