10b57cec5SDimitry Andric //===- SourceMgr.cpp - Manager for Simple Source Buffers & Diagnostics ----===// 20b57cec5SDimitry Andric // 30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information. 50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 60b57cec5SDimitry Andric // 70b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 80b57cec5SDimitry Andric // 90b57cec5SDimitry Andric // This file implements the SourceMgr class. This class is used as a simple 100b57cec5SDimitry Andric // substrate for diagnostics, #include handling, and other low level things for 110b57cec5SDimitry Andric // simple parsers. 120b57cec5SDimitry Andric // 130b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 140b57cec5SDimitry Andric 150b57cec5SDimitry Andric #include "llvm/Support/SourceMgr.h" 160b57cec5SDimitry Andric #include "llvm/ADT/ArrayRef.h" 170b57cec5SDimitry Andric #include "llvm/ADT/STLExtras.h" 180b57cec5SDimitry Andric #include "llvm/ADT/SmallVector.h" 190b57cec5SDimitry Andric #include "llvm/ADT/StringRef.h" 200b57cec5SDimitry Andric #include "llvm/ADT/Twine.h" 210b57cec5SDimitry Andric #include "llvm/Support/ErrorOr.h" 220b57cec5SDimitry Andric #include "llvm/Support/Locale.h" 230b57cec5SDimitry Andric #include "llvm/Support/MemoryBuffer.h" 240b57cec5SDimitry Andric #include "llvm/Support/Path.h" 250b57cec5SDimitry Andric #include "llvm/Support/SMLoc.h" 260b57cec5SDimitry Andric #include "llvm/Support/WithColor.h" 270b57cec5SDimitry Andric #include "llvm/Support/raw_ostream.h" 280b57cec5SDimitry Andric #include <algorithm> 290b57cec5SDimitry Andric #include <cassert> 300b57cec5SDimitry Andric #include <cstddef> 310b57cec5SDimitry Andric #include <limits> 320b57cec5SDimitry Andric #include <memory> 330b57cec5SDimitry Andric #include <string> 340b57cec5SDimitry Andric #include <utility> 350b57cec5SDimitry Andric 360b57cec5SDimitry Andric using namespace llvm; 370b57cec5SDimitry Andric 380b57cec5SDimitry Andric static const size_t TabStop = 8; 390b57cec5SDimitry Andric 400b57cec5SDimitry Andric unsigned SourceMgr::AddIncludeFile(const std::string &Filename, 410b57cec5SDimitry Andric SMLoc IncludeLoc, 420b57cec5SDimitry Andric std::string &IncludedFile) { 430b57cec5SDimitry Andric IncludedFile = Filename; 440b57cec5SDimitry Andric ErrorOr<std::unique_ptr<MemoryBuffer>> NewBufOrErr = 450b57cec5SDimitry Andric MemoryBuffer::getFile(IncludedFile); 460b57cec5SDimitry Andric 470b57cec5SDimitry Andric // If the file didn't exist directly, see if it's in an include path. 480b57cec5SDimitry Andric for (unsigned i = 0, e = IncludeDirectories.size(); i != e && !NewBufOrErr; 490b57cec5SDimitry Andric ++i) { 500b57cec5SDimitry Andric IncludedFile = 510b57cec5SDimitry Andric IncludeDirectories[i] + sys::path::get_separator().data() + Filename; 520b57cec5SDimitry Andric NewBufOrErr = MemoryBuffer::getFile(IncludedFile); 530b57cec5SDimitry Andric } 540b57cec5SDimitry Andric 550b57cec5SDimitry Andric if (!NewBufOrErr) 560b57cec5SDimitry Andric return 0; 570b57cec5SDimitry Andric 580b57cec5SDimitry Andric return AddNewSourceBuffer(std::move(*NewBufOrErr), IncludeLoc); 590b57cec5SDimitry Andric } 600b57cec5SDimitry Andric 610b57cec5SDimitry Andric unsigned SourceMgr::FindBufferContainingLoc(SMLoc Loc) const { 620b57cec5SDimitry Andric for (unsigned i = 0, e = Buffers.size(); i != e; ++i) 630b57cec5SDimitry Andric if (Loc.getPointer() >= Buffers[i].Buffer->getBufferStart() && 640b57cec5SDimitry Andric // Use <= here so that a pointer to the null at the end of the buffer 650b57cec5SDimitry Andric // is included as part of the buffer. 660b57cec5SDimitry Andric Loc.getPointer() <= Buffers[i].Buffer->getBufferEnd()) 670b57cec5SDimitry Andric return i + 1; 680b57cec5SDimitry Andric return 0; 690b57cec5SDimitry Andric } 700b57cec5SDimitry Andric 710b57cec5SDimitry Andric template <typename T> 720b57cec5SDimitry Andric unsigned SourceMgr::SrcBuffer::getLineNumber(const char *Ptr) const { 730b57cec5SDimitry Andric 740b57cec5SDimitry Andric // Ensure OffsetCache is allocated and populated with offsets of all the 750b57cec5SDimitry Andric // '\n' bytes. 760b57cec5SDimitry Andric std::vector<T> *Offsets = nullptr; 770b57cec5SDimitry Andric if (OffsetCache.isNull()) { 780b57cec5SDimitry Andric Offsets = new std::vector<T>(); 790b57cec5SDimitry Andric OffsetCache = Offsets; 800b57cec5SDimitry Andric size_t Sz = Buffer->getBufferSize(); 810b57cec5SDimitry Andric assert(Sz <= std::numeric_limits<T>::max()); 820b57cec5SDimitry Andric StringRef S = Buffer->getBuffer(); 830b57cec5SDimitry Andric for (size_t N = 0; N < Sz; ++N) { 840b57cec5SDimitry Andric if (S[N] == '\n') { 850b57cec5SDimitry Andric Offsets->push_back(static_cast<T>(N)); 860b57cec5SDimitry Andric } 870b57cec5SDimitry Andric } 880b57cec5SDimitry Andric } else { 890b57cec5SDimitry Andric Offsets = OffsetCache.get<std::vector<T> *>(); 900b57cec5SDimitry Andric } 910b57cec5SDimitry Andric 920b57cec5SDimitry Andric const char *BufStart = Buffer->getBufferStart(); 930b57cec5SDimitry Andric assert(Ptr >= BufStart && Ptr <= Buffer->getBufferEnd()); 940b57cec5SDimitry Andric ptrdiff_t PtrDiff = Ptr - BufStart; 950b57cec5SDimitry Andric assert(PtrDiff >= 0 && static_cast<size_t>(PtrDiff) <= std::numeric_limits<T>::max()); 960b57cec5SDimitry Andric T PtrOffset = static_cast<T>(PtrDiff); 970b57cec5SDimitry Andric 980b57cec5SDimitry Andric // llvm::lower_bound gives the number of EOL before PtrOffset. Add 1 to get 990b57cec5SDimitry Andric // the line number. 1000b57cec5SDimitry Andric return llvm::lower_bound(*Offsets, PtrOffset) - Offsets->begin() + 1; 1010b57cec5SDimitry Andric } 1020b57cec5SDimitry Andric 1030b57cec5SDimitry Andric SourceMgr::SrcBuffer::SrcBuffer(SourceMgr::SrcBuffer &&Other) 1040b57cec5SDimitry Andric : Buffer(std::move(Other.Buffer)), 1050b57cec5SDimitry Andric OffsetCache(Other.OffsetCache), 1060b57cec5SDimitry Andric IncludeLoc(Other.IncludeLoc) { 1070b57cec5SDimitry Andric Other.OffsetCache = nullptr; 1080b57cec5SDimitry Andric } 1090b57cec5SDimitry Andric 1100b57cec5SDimitry Andric SourceMgr::SrcBuffer::~SrcBuffer() { 1110b57cec5SDimitry Andric if (!OffsetCache.isNull()) { 1120b57cec5SDimitry Andric if (OffsetCache.is<std::vector<uint8_t>*>()) 1130b57cec5SDimitry Andric delete OffsetCache.get<std::vector<uint8_t>*>(); 1140b57cec5SDimitry Andric else if (OffsetCache.is<std::vector<uint16_t>*>()) 1150b57cec5SDimitry Andric delete OffsetCache.get<std::vector<uint16_t>*>(); 1160b57cec5SDimitry Andric else if (OffsetCache.is<std::vector<uint32_t>*>()) 1170b57cec5SDimitry Andric delete OffsetCache.get<std::vector<uint32_t>*>(); 1180b57cec5SDimitry Andric else 1190b57cec5SDimitry Andric delete OffsetCache.get<std::vector<uint64_t>*>(); 1200b57cec5SDimitry Andric OffsetCache = nullptr; 1210b57cec5SDimitry Andric } 1220b57cec5SDimitry Andric } 1230b57cec5SDimitry Andric 1240b57cec5SDimitry Andric std::pair<unsigned, unsigned> 1250b57cec5SDimitry Andric SourceMgr::getLineAndColumn(SMLoc Loc, unsigned BufferID) const { 1260b57cec5SDimitry Andric if (!BufferID) 1270b57cec5SDimitry Andric BufferID = FindBufferContainingLoc(Loc); 1280b57cec5SDimitry Andric assert(BufferID && "Invalid Location!"); 1290b57cec5SDimitry Andric 1300b57cec5SDimitry Andric auto &SB = getBufferInfo(BufferID); 1310b57cec5SDimitry Andric const char *Ptr = Loc.getPointer(); 1320b57cec5SDimitry Andric 1330b57cec5SDimitry Andric size_t Sz = SB.Buffer->getBufferSize(); 1340b57cec5SDimitry Andric unsigned LineNo; 1350b57cec5SDimitry Andric if (Sz <= std::numeric_limits<uint8_t>::max()) 1360b57cec5SDimitry Andric LineNo = SB.getLineNumber<uint8_t>(Ptr); 1370b57cec5SDimitry Andric else if (Sz <= std::numeric_limits<uint16_t>::max()) 1380b57cec5SDimitry Andric LineNo = SB.getLineNumber<uint16_t>(Ptr); 1390b57cec5SDimitry Andric else if (Sz <= std::numeric_limits<uint32_t>::max()) 1400b57cec5SDimitry Andric LineNo = SB.getLineNumber<uint32_t>(Ptr); 1410b57cec5SDimitry Andric else 1420b57cec5SDimitry Andric LineNo = SB.getLineNumber<uint64_t>(Ptr); 1430b57cec5SDimitry Andric 1440b57cec5SDimitry Andric const char *BufStart = SB.Buffer->getBufferStart(); 1450b57cec5SDimitry Andric size_t NewlineOffs = StringRef(BufStart, Ptr-BufStart).find_last_of("\n\r"); 1460b57cec5SDimitry Andric if (NewlineOffs == StringRef::npos) NewlineOffs = ~(size_t)0; 1470b57cec5SDimitry Andric return std::make_pair(LineNo, Ptr-BufStart-NewlineOffs); 1480b57cec5SDimitry Andric } 1490b57cec5SDimitry Andric 1500b57cec5SDimitry Andric void SourceMgr::PrintIncludeStack(SMLoc IncludeLoc, raw_ostream &OS) const { 1510b57cec5SDimitry Andric if (IncludeLoc == SMLoc()) return; // Top of stack. 1520b57cec5SDimitry Andric 1530b57cec5SDimitry Andric unsigned CurBuf = FindBufferContainingLoc(IncludeLoc); 1540b57cec5SDimitry Andric assert(CurBuf && "Invalid or unspecified location!"); 1550b57cec5SDimitry Andric 1560b57cec5SDimitry Andric PrintIncludeStack(getBufferInfo(CurBuf).IncludeLoc, OS); 1570b57cec5SDimitry Andric 1580b57cec5SDimitry Andric OS << "Included from " 1590b57cec5SDimitry Andric << getBufferInfo(CurBuf).Buffer->getBufferIdentifier() 1600b57cec5SDimitry Andric << ":" << FindLineNumber(IncludeLoc, CurBuf) << ":\n"; 1610b57cec5SDimitry Andric } 1620b57cec5SDimitry Andric 1630b57cec5SDimitry Andric SMDiagnostic SourceMgr::GetMessage(SMLoc Loc, SourceMgr::DiagKind Kind, 1640b57cec5SDimitry Andric const Twine &Msg, 1650b57cec5SDimitry Andric ArrayRef<SMRange> Ranges, 1660b57cec5SDimitry Andric ArrayRef<SMFixIt> FixIts) const { 1670b57cec5SDimitry Andric // First thing to do: find the current buffer containing the specified 1680b57cec5SDimitry Andric // location to pull out the source line. 1690b57cec5SDimitry Andric SmallVector<std::pair<unsigned, unsigned>, 4> ColRanges; 1700b57cec5SDimitry Andric std::pair<unsigned, unsigned> LineAndCol; 1710b57cec5SDimitry Andric StringRef BufferID = "<unknown>"; 1720b57cec5SDimitry Andric std::string LineStr; 1730b57cec5SDimitry Andric 1740b57cec5SDimitry Andric if (Loc.isValid()) { 1750b57cec5SDimitry Andric unsigned CurBuf = FindBufferContainingLoc(Loc); 1760b57cec5SDimitry Andric assert(CurBuf && "Invalid or unspecified location!"); 1770b57cec5SDimitry Andric 1780b57cec5SDimitry Andric const MemoryBuffer *CurMB = getMemoryBuffer(CurBuf); 1790b57cec5SDimitry Andric BufferID = CurMB->getBufferIdentifier(); 1800b57cec5SDimitry Andric 1810b57cec5SDimitry Andric // Scan backward to find the start of the line. 1820b57cec5SDimitry Andric const char *LineStart = Loc.getPointer(); 1830b57cec5SDimitry Andric const char *BufStart = CurMB->getBufferStart(); 1840b57cec5SDimitry Andric while (LineStart != BufStart && LineStart[-1] != '\n' && 1850b57cec5SDimitry Andric LineStart[-1] != '\r') 1860b57cec5SDimitry Andric --LineStart; 1870b57cec5SDimitry Andric 1880b57cec5SDimitry Andric // Get the end of the line. 1890b57cec5SDimitry Andric const char *LineEnd = Loc.getPointer(); 1900b57cec5SDimitry Andric const char *BufEnd = CurMB->getBufferEnd(); 1910b57cec5SDimitry Andric while (LineEnd != BufEnd && LineEnd[0] != '\n' && LineEnd[0] != '\r') 1920b57cec5SDimitry Andric ++LineEnd; 1930b57cec5SDimitry Andric LineStr = std::string(LineStart, LineEnd); 1940b57cec5SDimitry Andric 1950b57cec5SDimitry Andric // Convert any ranges to column ranges that only intersect the line of the 1960b57cec5SDimitry Andric // location. 1970b57cec5SDimitry Andric for (unsigned i = 0, e = Ranges.size(); i != e; ++i) { 1980b57cec5SDimitry Andric SMRange R = Ranges[i]; 1990b57cec5SDimitry Andric if (!R.isValid()) continue; 2000b57cec5SDimitry Andric 2010b57cec5SDimitry Andric // If the line doesn't contain any part of the range, then ignore it. 2020b57cec5SDimitry Andric if (R.Start.getPointer() > LineEnd || R.End.getPointer() < LineStart) 2030b57cec5SDimitry Andric continue; 2040b57cec5SDimitry Andric 2050b57cec5SDimitry Andric // Ignore pieces of the range that go onto other lines. 2060b57cec5SDimitry Andric if (R.Start.getPointer() < LineStart) 2070b57cec5SDimitry Andric R.Start = SMLoc::getFromPointer(LineStart); 2080b57cec5SDimitry Andric if (R.End.getPointer() > LineEnd) 2090b57cec5SDimitry Andric R.End = SMLoc::getFromPointer(LineEnd); 2100b57cec5SDimitry Andric 2110b57cec5SDimitry Andric // Translate from SMLoc ranges to column ranges. 2120b57cec5SDimitry Andric // FIXME: Handle multibyte characters. 2130b57cec5SDimitry Andric ColRanges.push_back(std::make_pair(R.Start.getPointer()-LineStart, 2140b57cec5SDimitry Andric R.End.getPointer()-LineStart)); 2150b57cec5SDimitry Andric } 2160b57cec5SDimitry Andric 2170b57cec5SDimitry Andric LineAndCol = getLineAndColumn(Loc, CurBuf); 2180b57cec5SDimitry Andric } 2190b57cec5SDimitry Andric 2200b57cec5SDimitry Andric return SMDiagnostic(*this, Loc, BufferID, LineAndCol.first, 2210b57cec5SDimitry Andric LineAndCol.second-1, Kind, Msg.str(), 2220b57cec5SDimitry Andric LineStr, ColRanges, FixIts); 2230b57cec5SDimitry Andric } 2240b57cec5SDimitry Andric 2250b57cec5SDimitry Andric void SourceMgr::PrintMessage(raw_ostream &OS, const SMDiagnostic &Diagnostic, 2260b57cec5SDimitry Andric bool ShowColors) const { 2270b57cec5SDimitry Andric // Report the message with the diagnostic handler if present. 2280b57cec5SDimitry Andric if (DiagHandler) { 2290b57cec5SDimitry Andric DiagHandler(Diagnostic, DiagContext); 2300b57cec5SDimitry Andric return; 2310b57cec5SDimitry Andric } 2320b57cec5SDimitry Andric 2330b57cec5SDimitry Andric if (Diagnostic.getLoc().isValid()) { 2340b57cec5SDimitry Andric unsigned CurBuf = FindBufferContainingLoc(Diagnostic.getLoc()); 2350b57cec5SDimitry Andric assert(CurBuf && "Invalid or unspecified location!"); 2360b57cec5SDimitry Andric PrintIncludeStack(getBufferInfo(CurBuf).IncludeLoc, OS); 2370b57cec5SDimitry Andric } 2380b57cec5SDimitry Andric 2390b57cec5SDimitry Andric Diagnostic.print(nullptr, OS, ShowColors); 2400b57cec5SDimitry Andric } 2410b57cec5SDimitry Andric 2420b57cec5SDimitry Andric void SourceMgr::PrintMessage(raw_ostream &OS, SMLoc Loc, 2430b57cec5SDimitry Andric SourceMgr::DiagKind Kind, 2440b57cec5SDimitry Andric const Twine &Msg, ArrayRef<SMRange> Ranges, 2450b57cec5SDimitry Andric ArrayRef<SMFixIt> FixIts, bool ShowColors) const { 2460b57cec5SDimitry Andric PrintMessage(OS, GetMessage(Loc, Kind, Msg, Ranges, FixIts), ShowColors); 2470b57cec5SDimitry Andric } 2480b57cec5SDimitry Andric 2490b57cec5SDimitry Andric void SourceMgr::PrintMessage(SMLoc Loc, SourceMgr::DiagKind Kind, 2500b57cec5SDimitry Andric const Twine &Msg, ArrayRef<SMRange> Ranges, 2510b57cec5SDimitry Andric ArrayRef<SMFixIt> FixIts, bool ShowColors) const { 2520b57cec5SDimitry Andric PrintMessage(errs(), Loc, Kind, Msg, Ranges, FixIts, ShowColors); 2530b57cec5SDimitry Andric } 2540b57cec5SDimitry Andric 2550b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 2560b57cec5SDimitry Andric // SMDiagnostic Implementation 2570b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 2580b57cec5SDimitry Andric 2590b57cec5SDimitry Andric SMDiagnostic::SMDiagnostic(const SourceMgr &sm, SMLoc L, StringRef FN, 2600b57cec5SDimitry Andric int Line, int Col, SourceMgr::DiagKind Kind, 2610b57cec5SDimitry Andric StringRef Msg, StringRef LineStr, 2620b57cec5SDimitry Andric ArrayRef<std::pair<unsigned,unsigned>> Ranges, 2630b57cec5SDimitry Andric ArrayRef<SMFixIt> Hints) 2640b57cec5SDimitry Andric : SM(&sm), Loc(L), Filename(FN), LineNo(Line), ColumnNo(Col), Kind(Kind), 2650b57cec5SDimitry Andric Message(Msg), LineContents(LineStr), Ranges(Ranges.vec()), 2660b57cec5SDimitry Andric FixIts(Hints.begin(), Hints.end()) { 2670b57cec5SDimitry Andric llvm::sort(FixIts); 2680b57cec5SDimitry Andric } 2690b57cec5SDimitry Andric 2700b57cec5SDimitry Andric static void buildFixItLine(std::string &CaretLine, std::string &FixItLine, 2710b57cec5SDimitry Andric ArrayRef<SMFixIt> FixIts, ArrayRef<char> SourceLine){ 2720b57cec5SDimitry Andric if (FixIts.empty()) 2730b57cec5SDimitry Andric return; 2740b57cec5SDimitry Andric 2750b57cec5SDimitry Andric const char *LineStart = SourceLine.begin(); 2760b57cec5SDimitry Andric const char *LineEnd = SourceLine.end(); 2770b57cec5SDimitry Andric 2780b57cec5SDimitry Andric size_t PrevHintEndCol = 0; 2790b57cec5SDimitry Andric 2800b57cec5SDimitry Andric for (ArrayRef<SMFixIt>::iterator I = FixIts.begin(), E = FixIts.end(); 2810b57cec5SDimitry Andric I != E; ++I) { 2820b57cec5SDimitry Andric // If the fixit contains a newline or tab, ignore it. 2830b57cec5SDimitry Andric if (I->getText().find_first_of("\n\r\t") != StringRef::npos) 2840b57cec5SDimitry Andric continue; 2850b57cec5SDimitry Andric 2860b57cec5SDimitry Andric SMRange R = I->getRange(); 2870b57cec5SDimitry Andric 2880b57cec5SDimitry Andric // If the line doesn't contain any part of the range, then ignore it. 2890b57cec5SDimitry Andric if (R.Start.getPointer() > LineEnd || R.End.getPointer() < LineStart) 2900b57cec5SDimitry Andric continue; 2910b57cec5SDimitry Andric 2920b57cec5SDimitry Andric // Translate from SMLoc to column. 2930b57cec5SDimitry Andric // Ignore pieces of the range that go onto other lines. 2940b57cec5SDimitry Andric // FIXME: Handle multibyte characters in the source line. 2950b57cec5SDimitry Andric unsigned FirstCol; 2960b57cec5SDimitry Andric if (R.Start.getPointer() < LineStart) 2970b57cec5SDimitry Andric FirstCol = 0; 2980b57cec5SDimitry Andric else 2990b57cec5SDimitry Andric FirstCol = R.Start.getPointer() - LineStart; 3000b57cec5SDimitry Andric 3010b57cec5SDimitry Andric // If we inserted a long previous hint, push this one forwards, and add 3020b57cec5SDimitry Andric // an extra space to show that this is not part of the previous 3030b57cec5SDimitry Andric // completion. This is sort of the best we can do when two hints appear 3040b57cec5SDimitry Andric // to overlap. 3050b57cec5SDimitry Andric // 3060b57cec5SDimitry Andric // Note that if this hint is located immediately after the previous 3070b57cec5SDimitry Andric // hint, no space will be added, since the location is more important. 3080b57cec5SDimitry Andric unsigned HintCol = FirstCol; 3090b57cec5SDimitry Andric if (HintCol < PrevHintEndCol) 3100b57cec5SDimitry Andric HintCol = PrevHintEndCol + 1; 3110b57cec5SDimitry Andric 3120b57cec5SDimitry Andric // FIXME: This assertion is intended to catch unintended use of multibyte 3130b57cec5SDimitry Andric // characters in fixits. If we decide to do this, we'll have to track 3140b57cec5SDimitry Andric // separate byte widths for the source and fixit lines. 3150b57cec5SDimitry Andric assert((size_t)sys::locale::columnWidth(I->getText()) == 3160b57cec5SDimitry Andric I->getText().size()); 3170b57cec5SDimitry Andric 3180b57cec5SDimitry Andric // This relies on one byte per column in our fixit hints. 3190b57cec5SDimitry Andric unsigned LastColumnModified = HintCol + I->getText().size(); 3200b57cec5SDimitry Andric if (LastColumnModified > FixItLine.size()) 3210b57cec5SDimitry Andric FixItLine.resize(LastColumnModified, ' '); 3220b57cec5SDimitry Andric 3230b57cec5SDimitry Andric std::copy(I->getText().begin(), I->getText().end(), 3240b57cec5SDimitry Andric FixItLine.begin() + HintCol); 3250b57cec5SDimitry Andric 3260b57cec5SDimitry Andric PrevHintEndCol = LastColumnModified; 3270b57cec5SDimitry Andric 3280b57cec5SDimitry Andric // For replacements, mark the removal range with '~'. 3290b57cec5SDimitry Andric // FIXME: Handle multibyte characters in the source line. 3300b57cec5SDimitry Andric unsigned LastCol; 3310b57cec5SDimitry Andric if (R.End.getPointer() >= LineEnd) 3320b57cec5SDimitry Andric LastCol = LineEnd - LineStart; 3330b57cec5SDimitry Andric else 3340b57cec5SDimitry Andric LastCol = R.End.getPointer() - LineStart; 3350b57cec5SDimitry Andric 3360b57cec5SDimitry Andric std::fill(&CaretLine[FirstCol], &CaretLine[LastCol], '~'); 3370b57cec5SDimitry Andric } 3380b57cec5SDimitry Andric } 3390b57cec5SDimitry Andric 3400b57cec5SDimitry Andric static void printSourceLine(raw_ostream &S, StringRef LineContents) { 3410b57cec5SDimitry Andric // Print out the source line one character at a time, so we can expand tabs. 3420b57cec5SDimitry Andric for (unsigned i = 0, e = LineContents.size(), OutCol = 0; i != e; ++i) { 3430b57cec5SDimitry Andric size_t NextTab = LineContents.find('\t', i); 3440b57cec5SDimitry Andric // If there were no tabs left, print the rest, we are done. 3450b57cec5SDimitry Andric if (NextTab == StringRef::npos) { 3460b57cec5SDimitry Andric S << LineContents.drop_front(i); 3470b57cec5SDimitry Andric break; 3480b57cec5SDimitry Andric } 3490b57cec5SDimitry Andric 3500b57cec5SDimitry Andric // Otherwise, print from i to NextTab. 3510b57cec5SDimitry Andric S << LineContents.slice(i, NextTab); 3520b57cec5SDimitry Andric OutCol += NextTab - i; 3530b57cec5SDimitry Andric i = NextTab; 3540b57cec5SDimitry Andric 3550b57cec5SDimitry Andric // If we have a tab, emit at least one space, then round up to 8 columns. 3560b57cec5SDimitry Andric do { 3570b57cec5SDimitry Andric S << ' '; 3580b57cec5SDimitry Andric ++OutCol; 3590b57cec5SDimitry Andric } while ((OutCol % TabStop) != 0); 3600b57cec5SDimitry Andric } 3610b57cec5SDimitry Andric S << '\n'; 3620b57cec5SDimitry Andric } 3630b57cec5SDimitry Andric 3640b57cec5SDimitry Andric static bool isNonASCII(char c) { 3650b57cec5SDimitry Andric return c & 0x80; 3660b57cec5SDimitry Andric } 3670b57cec5SDimitry Andric 3680b57cec5SDimitry Andric void SMDiagnostic::print(const char *ProgName, raw_ostream &OS, 3690b57cec5SDimitry Andric bool ShowColors, bool ShowKindLabel) const { 3700b57cec5SDimitry Andric { 3710b57cec5SDimitry Andric WithColor S(OS, raw_ostream::SAVEDCOLOR, true, false, !ShowColors); 3720b57cec5SDimitry Andric 3730b57cec5SDimitry Andric if (ProgName && ProgName[0]) 3740b57cec5SDimitry Andric S << ProgName << ": "; 3750b57cec5SDimitry Andric 3760b57cec5SDimitry Andric if (!Filename.empty()) { 3770b57cec5SDimitry Andric if (Filename == "-") 3780b57cec5SDimitry Andric S << "<stdin>"; 3790b57cec5SDimitry Andric else 3800b57cec5SDimitry Andric S << Filename; 3810b57cec5SDimitry Andric 3820b57cec5SDimitry Andric if (LineNo != -1) { 3830b57cec5SDimitry Andric S << ':' << LineNo; 3840b57cec5SDimitry Andric if (ColumnNo != -1) 3850b57cec5SDimitry Andric S << ':' << (ColumnNo + 1); 3860b57cec5SDimitry Andric } 3870b57cec5SDimitry Andric S << ": "; 3880b57cec5SDimitry Andric } 3890b57cec5SDimitry Andric } 3900b57cec5SDimitry Andric 3910b57cec5SDimitry Andric if (ShowKindLabel) { 3920b57cec5SDimitry Andric switch (Kind) { 3930b57cec5SDimitry Andric case SourceMgr::DK_Error: 3940b57cec5SDimitry Andric WithColor::error(OS, "", !ShowColors); 3950b57cec5SDimitry Andric break; 3960b57cec5SDimitry Andric case SourceMgr::DK_Warning: 3970b57cec5SDimitry Andric WithColor::warning(OS, "", !ShowColors); 3980b57cec5SDimitry Andric break; 3990b57cec5SDimitry Andric case SourceMgr::DK_Note: 4000b57cec5SDimitry Andric WithColor::note(OS, "", !ShowColors); 4010b57cec5SDimitry Andric break; 4020b57cec5SDimitry Andric case SourceMgr::DK_Remark: 4030b57cec5SDimitry Andric WithColor::remark(OS, "", !ShowColors); 4040b57cec5SDimitry Andric break; 4050b57cec5SDimitry Andric } 4060b57cec5SDimitry Andric } 4070b57cec5SDimitry Andric 4080b57cec5SDimitry Andric WithColor(OS, raw_ostream::SAVEDCOLOR, true, false, !ShowColors) 4090b57cec5SDimitry Andric << Message << '\n'; 4100b57cec5SDimitry Andric 4110b57cec5SDimitry Andric if (LineNo == -1 || ColumnNo == -1) 4120b57cec5SDimitry Andric return; 4130b57cec5SDimitry Andric 4140b57cec5SDimitry Andric // FIXME: If there are multibyte or multi-column characters in the source, all 4150b57cec5SDimitry Andric // our ranges will be wrong. To do this properly, we'll need a byte-to-column 4160b57cec5SDimitry Andric // map like Clang's TextDiagnostic. For now, we'll just handle tabs by 4170b57cec5SDimitry Andric // expanding them later, and bail out rather than show incorrect ranges and 4180b57cec5SDimitry Andric // misaligned fixits for any other odd characters. 4190b57cec5SDimitry Andric if (find_if(LineContents, isNonASCII) != LineContents.end()) { 4200b57cec5SDimitry Andric printSourceLine(OS, LineContents); 4210b57cec5SDimitry Andric return; 4220b57cec5SDimitry Andric } 4230b57cec5SDimitry Andric size_t NumColumns = LineContents.size(); 4240b57cec5SDimitry Andric 4250b57cec5SDimitry Andric // Build the line with the caret and ranges. 4260b57cec5SDimitry Andric std::string CaretLine(NumColumns+1, ' '); 4270b57cec5SDimitry Andric 4280b57cec5SDimitry Andric // Expand any ranges. 4290b57cec5SDimitry Andric for (unsigned r = 0, e = Ranges.size(); r != e; ++r) { 4300b57cec5SDimitry Andric std::pair<unsigned, unsigned> R = Ranges[r]; 4310b57cec5SDimitry Andric std::fill(&CaretLine[R.first], 4320b57cec5SDimitry Andric &CaretLine[std::min((size_t)R.second, CaretLine.size())], 4330b57cec5SDimitry Andric '~'); 4340b57cec5SDimitry Andric } 4350b57cec5SDimitry Andric 4360b57cec5SDimitry Andric // Add any fix-its. 4370b57cec5SDimitry Andric // FIXME: Find the beginning of the line properly for multibyte characters. 4380b57cec5SDimitry Andric std::string FixItInsertionLine; 4390b57cec5SDimitry Andric buildFixItLine(CaretLine, FixItInsertionLine, FixIts, 4400b57cec5SDimitry Andric makeArrayRef(Loc.getPointer() - ColumnNo, 4410b57cec5SDimitry Andric LineContents.size())); 4420b57cec5SDimitry Andric 4430b57cec5SDimitry Andric // Finally, plop on the caret. 4440b57cec5SDimitry Andric if (unsigned(ColumnNo) <= NumColumns) 4450b57cec5SDimitry Andric CaretLine[ColumnNo] = '^'; 4460b57cec5SDimitry Andric else 4470b57cec5SDimitry Andric CaretLine[NumColumns] = '^'; 4480b57cec5SDimitry Andric 4490b57cec5SDimitry Andric // ... and remove trailing whitespace so the output doesn't wrap for it. We 4500b57cec5SDimitry Andric // know that the line isn't completely empty because it has the caret in it at 4510b57cec5SDimitry Andric // least. 4520b57cec5SDimitry Andric CaretLine.erase(CaretLine.find_last_not_of(' ')+1); 4530b57cec5SDimitry Andric 4540b57cec5SDimitry Andric printSourceLine(OS, LineContents); 4550b57cec5SDimitry Andric 4560b57cec5SDimitry Andric { 4570b57cec5SDimitry Andric WithColor S(OS, raw_ostream::GREEN, true, false, !ShowColors); 4580b57cec5SDimitry Andric 4590b57cec5SDimitry Andric // Print out the caret line, matching tabs in the source line. 4600b57cec5SDimitry Andric for (unsigned i = 0, e = CaretLine.size(), OutCol = 0; i != e; ++i) { 4610b57cec5SDimitry Andric if (i >= LineContents.size() || LineContents[i] != '\t') { 4620b57cec5SDimitry Andric S << CaretLine[i]; 4630b57cec5SDimitry Andric ++OutCol; 4640b57cec5SDimitry Andric continue; 4650b57cec5SDimitry Andric } 4660b57cec5SDimitry Andric 4670b57cec5SDimitry Andric // Okay, we have a tab. Insert the appropriate number of characters. 4680b57cec5SDimitry Andric do { 4690b57cec5SDimitry Andric S << CaretLine[i]; 4700b57cec5SDimitry Andric ++OutCol; 4710b57cec5SDimitry Andric } while ((OutCol % TabStop) != 0); 4720b57cec5SDimitry Andric } 4730b57cec5SDimitry Andric S << '\n'; 4740b57cec5SDimitry Andric } 4750b57cec5SDimitry Andric 4760b57cec5SDimitry Andric // Print out the replacement line, matching tabs in the source line. 4770b57cec5SDimitry Andric if (FixItInsertionLine.empty()) 4780b57cec5SDimitry Andric return; 4790b57cec5SDimitry Andric 4800b57cec5SDimitry Andric for (size_t i = 0, e = FixItInsertionLine.size(), OutCol = 0; i < e; ++i) { 4810b57cec5SDimitry Andric if (i >= LineContents.size() || LineContents[i] != '\t') { 4820b57cec5SDimitry Andric OS << FixItInsertionLine[i]; 4830b57cec5SDimitry Andric ++OutCol; 4840b57cec5SDimitry Andric continue; 4850b57cec5SDimitry Andric } 4860b57cec5SDimitry Andric 4870b57cec5SDimitry Andric // Okay, we have a tab. Insert the appropriate number of characters. 4880b57cec5SDimitry Andric do { 4890b57cec5SDimitry Andric OS << FixItInsertionLine[i]; 4900b57cec5SDimitry Andric // FIXME: This is trying not to break up replacements, but then to re-sync 4910b57cec5SDimitry Andric // with the tabs between replacements. This will fail, though, if two 4920b57cec5SDimitry Andric // fix-it replacements are exactly adjacent, or if a fix-it contains a 4930b57cec5SDimitry Andric // space. Really we should be precomputing column widths, which we'll 4940b57cec5SDimitry Andric // need anyway for multibyte chars. 4950b57cec5SDimitry Andric if (FixItInsertionLine[i] != ' ') 4960b57cec5SDimitry Andric ++i; 4970b57cec5SDimitry Andric ++OutCol; 4980b57cec5SDimitry Andric } while (((OutCol % TabStop) != 0) && i != e); 4990b57cec5SDimitry Andric } 5000b57cec5SDimitry Andric OS << '\n'; 5010b57cec5SDimitry Andric } 502