1 //===-- clang-format/ClangFormat.cpp - Clang format tool ------------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 /// 10 /// \file 11 /// \brief This file implements a clang-format tool that automatically formats 12 /// (fragments of) C++ code. 13 /// 14 //===----------------------------------------------------------------------===// 15 16 #include "clang/Basic/Diagnostic.h" 17 #include "clang/Basic/DiagnosticOptions.h" 18 #include "clang/Basic/FileManager.h" 19 #include "clang/Basic/SourceManager.h" 20 #include "clang/Basic/Version.h" 21 #include "clang/Format/Format.h" 22 #include "clang/Lex/Lexer.h" 23 #include "clang/Rewrite/Core/Rewriter.h" 24 #include "llvm/ADT/StringMap.h" 25 #include "llvm/Support/Debug.h" 26 #include "llvm/Support/FileSystem.h" 27 #include "llvm/Support/Signals.h" 28 29 using namespace llvm; 30 31 static cl::opt<bool> Help("h", cl::desc("Alias for -help"), cl::Hidden); 32 33 // Mark all our options with this category, everything else (except for -version 34 // and -help) will be hidden. 35 static cl::OptionCategory ClangFormatCategory("Clang-format options"); 36 37 static cl::list<unsigned> 38 Offsets("offset", 39 cl::desc("Format a range starting at this byte offset.\n" 40 "Multiple ranges can be formatted by specifying\n" 41 "several -offset and -length pairs.\n" 42 "Can only be used with one input file."), 43 cl::cat(ClangFormatCategory)); 44 static cl::list<unsigned> 45 Lengths("length", 46 cl::desc("Format a range of this length (in bytes).\n" 47 "Multiple ranges can be formatted by specifying\n" 48 "several -offset and -length pairs.\n" 49 "When only a single -offset is specified without\n" 50 "-length, clang-format will format up to the end\n" 51 "of the file.\n" 52 "Can only be used with one input file."), 53 cl::cat(ClangFormatCategory)); 54 static cl::list<std::string> 55 LineRanges("lines", cl::desc("<start line>:<end line> - format a range of\n" 56 "lines (both 1-based).\n" 57 "Multiple ranges can be formatted by specifying\n" 58 "several -lines arguments.\n" 59 "Can't be used with -offset and -length.\n" 60 "Can only be used with one input file."), 61 cl::cat(ClangFormatCategory)); 62 static cl::opt<std::string> 63 Style("style", 64 cl::desc(clang::format::StyleOptionHelpDescription), 65 cl::init("file"), cl::cat(ClangFormatCategory)); 66 static cl::opt<std::string> 67 FallbackStyle("fallback-style", 68 cl::desc("The name of the predefined style used as a\n" 69 "fallback in case clang-format is invoked with\n" 70 "-style=file, but can not find the .clang-format\n" 71 "file to use.\n" 72 "Use -fallback-style=none to skip formatting."), 73 cl::init("LLVM"), cl::cat(ClangFormatCategory)); 74 75 static cl::opt<std::string> 76 AssumeFilename("assume-filename", 77 cl::desc("When reading from stdin, clang-format assumes this\n" 78 "filename to look for a style config file (with\n" 79 "-style=file)."), 80 cl::cat(ClangFormatCategory)); 81 82 static cl::opt<bool> Inplace("i", 83 cl::desc("Inplace edit <file>s, if specified."), 84 cl::cat(ClangFormatCategory)); 85 86 static cl::opt<bool> OutputXML("output-replacements-xml", 87 cl::desc("Output replacements as XML."), 88 cl::cat(ClangFormatCategory)); 89 static cl::opt<bool> 90 DumpConfig("dump-config", 91 cl::desc("Dump configuration options to stdout and exit.\n" 92 "Can be used with -style option."), 93 cl::cat(ClangFormatCategory)); 94 static cl::opt<unsigned> 95 Cursor("cursor", 96 cl::desc("The position of the cursor when invoking\n" 97 "clang-format from an editor integration"), 98 cl::init(0), cl::cat(ClangFormatCategory)); 99 100 static cl::list<std::string> FileNames(cl::Positional, cl::desc("[<file> ...]"), 101 cl::cat(ClangFormatCategory)); 102 103 namespace clang { 104 namespace format { 105 106 static FileID createInMemoryFile(StringRef FileName, MemoryBuffer *Source, 107 SourceManager &Sources, FileManager &Files) { 108 const FileEntry *Entry = Files.getVirtualFile(FileName == "-" ? "<stdin>" : 109 FileName, 110 Source->getBufferSize(), 0); 111 Sources.overrideFileContents(Entry, Source, true); 112 return Sources.createFileID(Entry, SourceLocation(), SrcMgr::C_User); 113 } 114 115 // Parses <start line>:<end line> input to a pair of line numbers. 116 // Returns true on error. 117 static bool parseLineRange(StringRef Input, unsigned &FromLine, 118 unsigned &ToLine) { 119 std::pair<StringRef, StringRef> LineRange = Input.split(':'); 120 return LineRange.first.getAsInteger(0, FromLine) || 121 LineRange.second.getAsInteger(0, ToLine); 122 } 123 124 static bool fillRanges(SourceManager &Sources, FileID ID, 125 const MemoryBuffer *Code, 126 std::vector<CharSourceRange> &Ranges) { 127 if (!LineRanges.empty()) { 128 if (!Offsets.empty() || !Lengths.empty()) { 129 llvm::errs() << "error: cannot use -lines with -offset/-length\n"; 130 return true; 131 } 132 133 for (unsigned i = 0, e = LineRanges.size(); i < e; ++i) { 134 unsigned FromLine, ToLine; 135 if (parseLineRange(LineRanges[i], FromLine, ToLine)) { 136 llvm::errs() << "error: invalid <start line>:<end line> pair\n"; 137 return true; 138 } 139 if (FromLine > ToLine) { 140 llvm::errs() << "error: start line should be less than end line\n"; 141 return true; 142 } 143 SourceLocation Start = Sources.translateLineCol(ID, FromLine, 1); 144 SourceLocation End = Sources.translateLineCol(ID, ToLine, UINT_MAX); 145 if (Start.isInvalid() || End.isInvalid()) 146 return true; 147 Ranges.push_back(CharSourceRange::getCharRange(Start, End)); 148 } 149 return false; 150 } 151 152 if (Offsets.empty()) 153 Offsets.push_back(0); 154 if (Offsets.size() != Lengths.size() && 155 !(Offsets.size() == 1 && Lengths.empty())) { 156 llvm::errs() 157 << "error: number of -offset and -length arguments must match.\n"; 158 return true; 159 } 160 for (unsigned i = 0, e = Offsets.size(); i != e; ++i) { 161 if (Offsets[i] >= Code->getBufferSize()) { 162 llvm::errs() << "error: offset " << Offsets[i] 163 << " is outside the file\n"; 164 return true; 165 } 166 SourceLocation Start = 167 Sources.getLocForStartOfFile(ID).getLocWithOffset(Offsets[i]); 168 SourceLocation End; 169 if (i < Lengths.size()) { 170 if (Offsets[i] + Lengths[i] > Code->getBufferSize()) { 171 llvm::errs() << "error: invalid length " << Lengths[i] 172 << ", offset + length (" << Offsets[i] + Lengths[i] 173 << ") is outside the file.\n"; 174 return true; 175 } 176 End = Start.getLocWithOffset(Lengths[i]); 177 } else { 178 End = Sources.getLocForEndOfFile(ID); 179 } 180 Ranges.push_back(CharSourceRange::getCharRange(Start, End)); 181 } 182 return false; 183 } 184 185 static void outputReplacementXML(StringRef Text) { 186 size_t From = 0; 187 size_t Index; 188 while ((Index = Text.find_first_of("\n\r", From)) != StringRef::npos) { 189 llvm::outs() << Text.substr(From, Index - From); 190 switch (Text[Index]) { 191 case '\n': 192 llvm::outs() << " "; 193 break; 194 case '\r': 195 llvm::outs() << " "; 196 break; 197 default: 198 llvm_unreachable("Unexpected character encountered!"); 199 } 200 From = Index + 1; 201 } 202 llvm::outs() << Text.substr(From); 203 } 204 205 // Returns true on error. 206 static bool format(StringRef FileName) { 207 FileManager Files((FileSystemOptions())); 208 DiagnosticsEngine Diagnostics( 209 IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs), 210 new DiagnosticOptions); 211 SourceManager Sources(Diagnostics, Files); 212 ErrorOr<std::unique_ptr<MemoryBuffer>> CodeOrErr = 213 MemoryBuffer::getFileOrSTDIN(FileName); 214 if (std::error_code EC = CodeOrErr.getError()) { 215 llvm::errs() << EC.message() << "\n"; 216 return true; 217 } 218 std::unique_ptr<llvm::MemoryBuffer> Code = std::move(CodeOrErr.get()); 219 if (Code->getBufferSize() == 0) 220 return false; // Empty files are formatted correctly. 221 FileID ID = createInMemoryFile(FileName, Code.get(), Sources, Files); 222 std::vector<CharSourceRange> Ranges; 223 if (fillRanges(Sources, ID, Code.get(), Ranges)) 224 return true; 225 226 FormatStyle FormatStyle = getStyle( 227 Style, (FileName == "-") ? AssumeFilename : FileName, FallbackStyle); 228 Lexer Lex(ID, Sources.getBuffer(ID), Sources, 229 getFormattingLangOpts(FormatStyle)); 230 tooling::Replacements Replaces = reformat(FormatStyle, Lex, Sources, Ranges); 231 if (OutputXML) { 232 llvm::outs() 233 << "<?xml version='1.0'?>\n<replacements xml:space='preserve'>\n"; 234 for (tooling::Replacements::const_iterator I = Replaces.begin(), 235 E = Replaces.end(); 236 I != E; ++I) { 237 llvm::outs() << "<replacement " 238 << "offset='" << I->getOffset() << "' " 239 << "length='" << I->getLength() << "'>"; 240 outputReplacementXML(I->getReplacementText()); 241 llvm::outs() << "</replacement>\n"; 242 } 243 llvm::outs() << "</replacements>\n"; 244 } else { 245 Rewriter Rewrite(Sources, LangOptions()); 246 tooling::applyAllReplacements(Replaces, Rewrite); 247 if (Inplace) { 248 if (Rewrite.overwriteChangedFiles()) 249 return true; 250 } else { 251 if (Cursor.getNumOccurrences() != 0) 252 outs() << "{ \"Cursor\": " 253 << tooling::shiftedCodePosition(Replaces, Cursor) << " }\n"; 254 Rewrite.getEditBuffer(ID).write(outs()); 255 } 256 } 257 return false; 258 } 259 260 } // namespace format 261 } // namespace clang 262 263 static void PrintVersion() { 264 raw_ostream &OS = outs(); 265 OS << clang::getClangToolFullVersion("clang-format") << '\n'; 266 } 267 268 int main(int argc, const char **argv) { 269 llvm::sys::PrintStackTraceOnErrorSignal(); 270 271 // Hide unrelated options. 272 StringMap<cl::Option*> Options; 273 cl::getRegisteredOptions(Options); 274 for (StringMap<cl::Option *>::iterator I = Options.begin(), E = Options.end(); 275 I != E; ++I) { 276 if (I->second->Category != &ClangFormatCategory && I->first() != "help" && 277 I->first() != "version") 278 I->second->setHiddenFlag(cl::ReallyHidden); 279 } 280 281 cl::SetVersionPrinter(PrintVersion); 282 cl::ParseCommandLineOptions( 283 argc, argv, 284 "A tool to format C/C++/Obj-C code.\n\n" 285 "If no arguments are specified, it formats the code from standard input\n" 286 "and writes the result to the standard output.\n" 287 "If <file>s are given, it reformats the files. If -i is specified\n" 288 "together with <file>s, the files are edited in-place. Otherwise, the\n" 289 "result is written to the standard output.\n"); 290 291 if (Help) 292 cl::PrintHelpMessage(); 293 294 if (DumpConfig) { 295 std::string Config = 296 clang::format::configurationAsText(clang::format::getStyle( 297 Style, FileNames.empty() ? AssumeFilename : FileNames[0], 298 FallbackStyle)); 299 llvm::outs() << Config << "\n"; 300 return 0; 301 } 302 303 bool Error = false; 304 switch (FileNames.size()) { 305 case 0: 306 Error = clang::format::format("-"); 307 break; 308 case 1: 309 Error = clang::format::format(FileNames[0]); 310 break; 311 default: 312 if (!Offsets.empty() || !Lengths.empty() || !LineRanges.empty()) { 313 llvm::errs() << "error: -offset, -length and -lines can only be used for " 314 "single file.\n"; 315 return 1; 316 } 317 for (unsigned i = 0; i < FileNames.size(); ++i) 318 Error |= clang::format::format(FileNames[i]); 319 break; 320 } 321 return Error ? 1 : 0; 322 } 323