CTagsEmitter.cpp revision 249259
150534Smpp//===- CTagsEmitter.cpp - Generate ctags-compatible index ------------------===// 250534Smpp// 3148145Strhodes// The LLVM Compiler Infrastructure 4115766Sharti// 568857Sru// This file is distributed under the University of Illinois Open Source 637941Skjc// License. See LICENSE.TXT for details. 737941Skjc// 8148145Strhodes//===----------------------------------------------------------------------===// 937941Skjc// 10151046Strhodes// This tablegen backend emits an index of definitions in ctags(1) format. 11151046Strhodes// A helper script, utils/TableGen/tdtags, provides an easier-to-use 12148220Strhodes// interface; run 'tdtags -H' for documentation. 13148145Strhodes// 1456468Sasmodai//===----------------------------------------------------------------------===// 1576175Sschweikh 16116294Sharti#define DEBUG_TYPE "ctags-emitter" 17148145Strhodes 18148145Strhodes#include "llvm/Support/SourceMgr.h" 19151046Strhodes#include "llvm/Support/MemoryBuffer.h" 20151046Strhodes#include "llvm/TableGen/Error.h" 21148145Strhodes#include "llvm/TableGen/Record.h" 22148145Strhodes#include "llvm/TableGen/TableGenBackend.h" 23148145Strhodes#include <algorithm> 24148145Strhodes#include <string> 2537941Skjc#include <vector> 2676175Sschweikhusing namespace llvm; 2737941Skjc 2837941Skjcnamespace llvm { extern SourceMgr SrcMgr; } 29131530Sru 30115766Shartinamespace { 3137941Skjc 32116296Sharticlass Tag { 33116445Shartiprivate: 3437941Skjc const std::string *Id; 35116296Sharti SMLoc Loc; 36116296Shartipublic: 37116294Sharti Tag(const std::string &Name, const SMLoc Location) 38130650Sru : Id(&Name), Loc(Location) {} 39130650Sru int operator<(const Tag &B) const { return *Id < *B.Id; } 40115766Sharti void emit(raw_ostream &OS) const { 41115766Sharti int BufferID = SrcMgr.FindBufferContainingLoc(Loc); 42115766Sharti MemoryBuffer *CurMB = SrcMgr.getBufferInfo(BufferID).Buffer; 43130650Sru const char *BufferName = CurMB->getBufferIdentifier(); 44115766Sharti std::pair<unsigned, unsigned> LineAndColumn = SrcMgr.getLineAndColumn(Loc); 45115766Sharti OS << *Id << "\t" << BufferName << "\t" << LineAndColumn.first << "\n"; 46115766Sharti } 47116296Sharti}; 4837941Skjc 49116296Sharticlass CTagsEmitter { 50130650Sruprivate: 51130650Sru RecordKeeper &Records; 52116296Shartipublic: 53130650Sru CTagsEmitter(RecordKeeper &R) : Records(R) {} 54116296Sharti 55130650Sru void run(raw_ostream &OS); 5637941Skjc 5771895Sruprivate: 5871895Sru static SMLoc locate(const Record *R); 5971895Sru}; 6071895Sru 6171895Sru} // End anonymous namespace. 6271895Sru 6337941SkjcSMLoc CTagsEmitter::locate(const Record *R) { 64116296Sharti ArrayRef<SMLoc> Locs = R->getLoc(); 65116296Sharti if (Locs.empty()) { 66116294Sharti SMLoc NullLoc; 6776175Sschweikh return NullLoc; 6838702Swosch } 6937941Skjc return Locs.front(); 7049831Smpp} 71130650Sru 72130650Sruvoid CTagsEmitter::run(raw_ostream &OS) { 73130650Sru const std::map<std::string, Record *> &Classes = Records.getClasses(); 7449831Smpp const std::map<std::string, Record *> &Defs = Records.getDefs(); 75208027Suqs std::vector<Tag> Tags; 76208027Suqs // Collect tags. 77208027Suqs Tags.reserve(Classes.size() + Defs.size()); 78208027Suqs for (std::map<std::string, Record *>::const_iterator I = Classes.begin(), 79 E = Classes.end(); 80 I != E; ++I) 81 Tags.push_back(Tag(I->first, locate(I->second))); 82 for (std::map<std::string, Record *>::const_iterator I = Defs.begin(), 83 E = Defs.end(); 84 I != E; ++I) 85 Tags.push_back(Tag(I->first, locate(I->second))); 86 // Emit tags. 87 std::sort(Tags.begin(), Tags.end()); 88 OS << "!_TAG_FILE_FORMAT\t1\t/original ctags format/\n"; 89 OS << "!_TAG_FILE_SORTED\t1\t/0=unsorted, 1=sorted, 2=foldcase/\n"; 90 for (std::vector<Tag>::const_iterator I = Tags.begin(), E = Tags.end(); 91 I != E; ++I) 92 I->emit(OS); 93} 94 95namespace llvm { 96 97void EmitCTags(RecordKeeper &RK, raw_ostream &OS) { CTagsEmitter(RK).run(OS); } 98 99} // End llvm namespace. 100