//===-- clang-format/ClangFormat.cpp - Clang format tool ------------------===//

//

// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.

// See https://llvm.org/LICENSE.txt for license information.

// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

//

//===----------------------------------------------------------------------===//

///

/// \file

/// This file implements a clang-format tool that automatically formats

/// (fragments of) C++ code.

///

//===----------------------------------------------------------------------===//

#include "clang/Basic/Diagnostic.h"

#include "clang/Basic/DiagnosticOptions.h"

#include "clang/Basic/FileManager.h"

#include "clang/Basic/SourceManager.h"

#include "clang/Basic/Version.h"

#include "clang/Format/Format.h"

#include "clang/Rewrite/Core/Rewriter.h"

#include "llvm/ADT/StringSwitch.h"

#include "llvm/Support/CommandLine.h"

#include "llvm/Support/FileSystem.h"

#include "llvm/Support/InitLLVM.h"

#include "llvm/Support/Process.h"

#include <fstream>

using namespace llvm;

using clang::tooling::Replacements;

static cl::opt<bool> Help("h", cl::desc("Alias for -help"), cl::Hidden);

// Mark all our options with this category, everything else (except for -version

// and -help) will be hidden.

static cl::OptionCategory ClangFormatCategory("Clang-format options");

static cl::list<unsigned>

    Offsets("offset",

            cl::desc("Format a range starting at this byte offset.\n"

                     "Multiple ranges can be formatted by specifying\n"

                     "several -offset and -length pairs.\n"

                     "Can only be used with one input file."),

            cl::cat(ClangFormatCategory));

static cl::list<unsigned>

    Lengths("length",

            cl::desc("Format a range of this length (in bytes).\n"

                     "Multiple ranges can be formatted by specifying\n"

                     "several -offset and -length pairs.\n"

                     "When only a single -offset is specified without\n"

                     "-length, clang-format will format up to the end\n"

                     "of the file.\n"

                     "Can only be used with one input file."),

            cl::cat(ClangFormatCategory));

static cl::list<std::string>

    LineRanges("lines",

               cl::desc("<start line>:<end line> - format a range of\n"

                        "lines (both 1-based).\n"

                        "Multiple ranges can be formatted by specifying\n"

                        "several -lines arguments.\n"

                        "Can't be used with -offset and -length.\n"

                        "Can only be used with one input file."),

               cl::cat(ClangFormatCategory));

static cl::opt<std::string>

    Style("style", cl::desc(clang::format::StyleOptionHelpDescription),

          cl::init(clang::format::DefaultFormatStyle),

          cl::cat(ClangFormatCategory));

static cl::opt<std::string>

    FallbackStyle("fallback-style",

                  cl::desc("The name of the predefined style used as a\n"

                           "fallback in case clang-format is invoked with\n"

                           "-style=file, but can not find the .clang-format\n"

                           "file to use.\n"

                           "Use -fallback-style=none to skip formatting."),

                  cl::init(clang::format::DefaultFallbackStyle),

                  cl::cat(ClangFormatCategory));

static cl::opt<std::string> AssumeFileName(

    "assume-filename",

    cl::desc("Override filename used to determine the language.\n"

             "When reading from stdin, clang-format assumes this\n"

             "filename to determine the language."),

    cl::init("<stdin>"), cl::cat(ClangFormatCategory));

static cl::opt<bool> Inplace("i",

                             cl::desc("Inplace edit <file>s, if specified."),

                             cl::cat(ClangFormatCategory));

static cl::opt<bool> OutputXML("output-replacements-xml",

                               cl::desc("Output replacements as XML."),

                               cl::cat(ClangFormatCategory));

static cl::opt<bool>

    DumpConfig("dump-config",

               cl::desc("Dump configuration options to stdout and exit.\n"

                        "Can be used with -style option."),

               cl::cat(ClangFormatCategory));

static cl::opt<unsigned>

    Cursor("cursor",

           cl::desc("The position of the cursor when invoking\n"

                    "clang-format from an editor integration"),

           cl::init(0), cl::cat(ClangFormatCategory));

static cl::opt<bool>

    SortIncludes("sort-includes",

                 cl::desc("If set, overrides the include sorting behavior\n"

                          "determined by the SortIncludes style flag"),

                 cl::cat(ClangFormatCategory));

static cl::opt<std::string> QualifierAlignment(

    "qualifier-alignment",

    cl::desc("If set, overrides the qualifier alignment style\n"

             "determined by the QualifierAlignment style flag"),

    cl::init(""), cl::cat(ClangFormatCategory));

static cl::opt<std::string>

    Files("files", cl::desc("Provide a list of files to run clang-format"),

          cl::init(""), cl::cat(ClangFormatCategory));

static cl::opt<bool>

    Verbose("verbose", cl::desc("If set, shows the list of processed files"),

            cl::cat(ClangFormatCategory));

// Use --dry-run to match other LLVM tools when you mean do it but don't

// actually do it

static cl::opt<bool>

    DryRun("dry-run",

           cl::desc("If set, do not actually make the formatting changes"),

           cl::cat(ClangFormatCategory));

// Use -n as a common command as an alias for --dry-run. (git and make use -n)

static cl::alias DryRunShort("n", cl::desc("Alias for --dry-run"),

                             cl::cat(ClangFormatCategory), cl::aliasopt(DryRun),

                             cl::NotHidden);

// Emulate being able to turn on/off the warning.

static cl::opt<bool>

    WarnFormat("Wclang-format-violations",

               cl::desc("Warnings about individual formatting changes needed. "

                        "Used only with --dry-run or -n"),

               cl::init(true), cl::cat(ClangFormatCategory), cl::Hidden);

static cl::opt<bool>

    NoWarnFormat("Wno-clang-format-violations",

                 cl::desc("Do not warn about individual formatting changes "

                          "needed. Used only with --dry-run or -n"),

                 cl::init(false), cl::cat(ClangFormatCategory), cl::Hidden);

static cl::opt<unsigned> ErrorLimit(

    "ferror-limit",

    cl::desc("Set the maximum number of clang-format errors to emit\n"

             "before stopping (0 = no limit).\n"

             "Used only with --dry-run or -n"),

    cl::init(0), cl::cat(ClangFormatCategory));

static cl::opt<bool>

    WarningsAsErrors("Werror",

                     cl::desc("If set, changes formatting warnings to errors"),

                     cl::cat(ClangFormatCategory));

namespace {

enum class WNoError { Unknown };

}

static cl::bits<WNoError> WNoErrorList(

    "Wno-error",

    cl::desc("If set don't error out on the specified warning type."),

    cl::values(

        clEnumValN(WNoError::Unknown, "unknown",

                   "If set, unknown format options are only warned about.\n"

                   "This can be used to enable formatting, even if the\n"

                   "configuration contains unknown (newer) options.\n"

                   "Use with caution, as this might lead to dramatically\n"

                   "differing format depending on an option being\n"

                   "supported or not.")),

    cl::cat(ClangFormatCategory));

static cl::opt<bool>

    ShowColors("fcolor-diagnostics",

               cl::desc("If set, and on a color-capable terminal controls "

                        "whether or not to print diagnostics in color"),

               cl::init(true), cl::cat(ClangFormatCategory), cl::Hidden);

static cl::opt<bool>

    NoShowColors("fno-color-diagnostics",

                 cl::desc("If set, and on a color-capable terminal controls "

                          "whether or not to print diagnostics in color"),

                 cl::init(false), cl::cat(ClangFormatCategory), cl::Hidden);

static cl::list<std::string> FileNames(cl::Positional, cl::desc("[<file> ...]"),

                                       cl::cat(ClangFormatCategory));

namespace clang {

namespace format {

static FileID createInMemoryFile(StringRef FileName, MemoryBufferRef Source,

                                 SourceManager &Sources, FileManager &Files,

                                 llvm::vfs::InMemoryFileSystem *MemFS) {

  MemFS->addFileNoOwn(FileName, 0, Source);

  auto File = Files.getOptionalFileRef(FileName);

  assert(File && "File not added to MemFS?");

  return Sources.createFileID(*File, SourceLocation(), SrcMgr::C_User);

}

// Parses <start line>:<end line> input to a pair of line numbers.

// Returns true on error.

static bool parseLineRange(StringRef Input, unsigned &FromLine,

                           unsigned &ToLine) {

  std::pair<StringRef, StringRef> LineRange = Input.split(':');

  return LineRange.first.getAsInteger(0, FromLine) ||

         LineRange.second.getAsInteger(0, ToLine);

}

static bool fillRanges(MemoryBuffer *Code,

                       std::vector<tooling::Range> &Ranges) {

  IntrusiveRefCntPtr<llvm::vfs::InMemoryFileSystem> InMemoryFileSystem(

      new llvm::vfs::InMemoryFileSystem);

  FileManager Files(FileSystemOptions(), InMemoryFileSystem);

  DiagnosticsEngine Diagnostics(

      IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs),

      new DiagnosticOptions);

  SourceManager Sources(Diagnostics, Files);

  FileID ID = createInMemoryFile("<irrelevant>", *Code, Sources, Files,

                                 InMemoryFileSystem.get());

  if (!LineRanges.empty()) {

    if (!Offsets.empty() || !Lengths.empty()) {

      errs() << "error: cannot use -lines with -offset/-length\n";

      return true;

    }

    
for (unsigned i = 0, e = LineRanges.size(); 5
i < e; 
++i6
) {

      unsigned FromLine, ToLine;

      if (parseLineRange(LineRanges[i], FromLine, ToLine)) {

        errs() << "error: invalid <start line>:<end line> pair\n";

        return true;

      }

      if (FromLine > ToLine) {

        errs() << "error: start line should be less than end line\n";

        return true;

      }

      SourceLocation Start = Sources.translateLineCol(ID, FromLine, 1);

      SourceLocation End = Sources.translateLineCol(ID, ToLine, UINT_MAX);

      if (Start.isInvalid() || End.isInvalid())

        return true;

      unsigned Offset = Sources.getFileOffset(Start);

      unsigned Length = Sources.getFileOffset(End) - Offset;

      Ranges.push_back(tooling::Range(Offset, Length));

    }

    return false;

  }

  if (Offsets.empty())

    Offsets.push_back(0);

  if (Offsets.size() != Lengths.size() &&

      
!(38
Offsets.size() == 138
 && 
Lengths.empty()38
)) {

    errs() << "error: number of -offset and -length arguments must match.\n";

    return true;

  }

  
for (unsigned i = 0, e = Offsets.size(); 39
i != e; 
++i40
) {

    if (Offsets[i] >= Code->getBufferSize()) {

      errs() << "error: offset " << Offsets[i] << " is outside the file\n";

      return true;

    }

    SourceLocation Start =

        Sources.getLocForStartOfFile(ID).getLocWithOffset(Offsets[i]);

    SourceLocation End;

    if (i < Lengths.size()) {

      if (Offsets[i] + Lengths[i] > Code->getBufferSize()) {

        errs() << "error: invalid length " << Lengths[i]

               << ", offset + length (" << Offsets[i] + Lengths[i]

               << ") is outside the file.\n";

        return true;

      }

      End = Start.getLocWithOffset(Lengths[i]);

    } else {

      End = Sources.getLocForEndOfFile(ID);

    }

    unsigned Offset = Sources.getFileOffset(Start);

    unsigned Length = Sources.getFileOffset(End) - Offset;

    Ranges.push_back(tooling::Range(Offset, Length));

  }

  return false;

}

static void outputReplacementXML(StringRef Text) {

  // FIXME: When we sort includes, we need to make sure the stream is correct

  // utf-8.

  size_t From = 0;

  size_t Index;

  while ((Index = Text.find_first_of("\n\r<&", From)) != StringRef::npos) {

    outs() << Text.substr(From, Index - From);

    switch (Text[Index]) {

    case '\n':

      outs() << "&#10;";

      break;

    case '\r':

      outs() << "&#13;";

      break;

    case '<':

      outs() << "&lt;";

      break;

    case '&':

      outs() << "&amp;";

      break;

    default:

      llvm_unreachable("Unexpected character encountered!");

    }

    From = Index + 1;

  }

  outs() << Text.substr(From);

}

static void outputReplacementsXML(const Replacements &Replaces) {

  for (const auto &R : Replaces) {

    outs() << "<replacement "

           << "offset='" << R.getOffset() << "' "

           << "length='" << R.getLength() << "'>";

    outputReplacementXML(R.getReplacementText());

    outs() << "</replacement>\n";

  }

}

static bool

emitReplacementWarnings(const Replacements &Replaces, StringRef AssumedFileName,

                        const std::unique_ptr<llvm::MemoryBuffer> &Code) {

  if (Replaces.empty())

    return false;

  unsigned Errors = 0;

  if (WarnFormat && !NoWarnFormat) {

    llvm::SourceMgr Mgr;

    const char *StartBuf = Code->getBufferStart();

    Mgr.AddNewSourceBuffer(

        MemoryBuffer::getMemBuffer(StartBuf, AssumedFileName), SMLoc());

    for (const auto &R : Replaces) {

      SMDiagnostic Diag = Mgr.GetMessage(

          SMLoc::getFromPointer(StartBuf + R.getOffset()),

          WarningsAsErrors ? 
SourceMgr::DiagKind::DK_Error0

                           : SourceMgr::DiagKind::DK_Warning,

          "code should be clang-formatted [-Wclang-format-violations]");

      Diag.print(nullptr, llvm::errs(), (ShowColors && !NoShowColors));

      if (ErrorLimit && 
++Errors >= ErrorLimit0
)

        break;

    }

  }

  return WarningsAsErrors;

}

static void outputXML(const Replacements &Replaces,

                      const Replacements &FormatChanges,

                      const FormattingAttemptStatus &Status,

                      const cl::opt<unsigned> &Cursor,

                      unsigned CursorPosition) {

  outs() << "<?xml version='1.0'?>\n<replacements "

            "xml:space='preserve' incomplete_format='"

         << (Status.FormatComplete ? "false" : 
"true"0
) << "'";

  if (!Status.FormatComplete)

    outs() << " line='" << Status.Line << "'";

  outs() << ">\n";

  if (Cursor.getNumOccurrences() != 0)

    outs() << "<cursor>" << FormatChanges.getShiftedCodePosition(CursorPosition)

           << "</cursor>\n";

  outputReplacementsXML(Replaces);

  outs() << "</replacements>\n";

}

class ClangFormatDiagConsumer : public DiagnosticConsumer {

  virtual void anchor() {}

  void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel,

                        const Diagnostic &Info) override {

    SmallVector<char, 16> vec;

    Info.FormatDiagnostic(vec);

    errs() << "clang-format error:" << vec << "\n";

  }

};

// Returns true on error.

static bool format(StringRef FileName) {

  if (!OutputXML && 
Inplace43
 && 
FileName == "-"5
) {

    errs() << "error: cannot use -i when reading from stdin.\n";

    return false;

  }

  // On Windows, overwriting a file with an open file mapping doesn't work,

  // so read the whole file into memory when formatting in-place.

  ErrorOr<std::unique_ptr<MemoryBuffer>> CodeOrErr =

      !OutputXML && 
Inplace43
 ? 
MemoryBuffer::getFileAsStream(FileName)5

                            : 
MemoryBuffer::getFileOrSTDIN(FileName)39
;

  if (std::error_code EC = CodeOrErr.getError()) {

    errs() << EC.message() << "\n";

    return true;

  }

  std::unique_ptr<llvm::MemoryBuffer> Code = std::move(CodeOrErr.get());

  if (Code->getBufferSize() == 0)

    return false; // Empty files are formatted correctly.

  StringRef BufStr = Code->getBuffer();

  const char *InvalidBOM = SrcMgr::ContentCache::getInvalidBOM(BufStr);

  if (InvalidBOM) {

    errs() << "error: encoding with unsupported byte order mark \""

           << InvalidBOM << "\" detected";

    if (FileName != "-")

      errs() << " in file '" << FileName << "'";

    errs() << ".\n";

    return true;

  }

  std::vector<tooling::Range> Ranges;

  if (fillRanges(Code.get(), Ranges))

    return true;

  StringRef AssumedFileName = (FileName == "-") ? 
AssumeFileName18
 : 
FileName26
;

  if (AssumedFileName.empty()) {

    llvm::errs() << "error: empty filenames are not allowed\n";

    return true;

  }

  llvm::Expected<FormatStyle> FormatStyle =

      getStyle(Style, AssumedFileName, FallbackStyle, Code->getBuffer(),

               nullptr, WNoErrorList.isSet(WNoError::Unknown));

  if (!FormatStyle) {

    llvm::errs() << llvm::toString(FormatStyle.takeError()) << "\n";

    return true;

  }

  StringRef QualifierAlignmentOrder = QualifierAlignment;

  FormatStyle->QualifierAlignment =

      StringSwitch<FormatStyle::QualifierAlignmentStyle>(

          QualifierAlignmentOrder.lower())

          .Case("right", FormatStyle::QAS_Right)

          .Case("left", FormatStyle::QAS_Left)

          .Default(FormatStyle->QualifierAlignment);

  if (FormatStyle->QualifierAlignment == FormatStyle::QAS_Left)

    FormatStyle->QualifierOrder = {"const", "volatile", "type"};

  else if (FormatStyle->QualifierAlignment == FormatStyle::QAS_Right)

    FormatStyle->QualifierOrder = {"type", "const", "volatile"};

  else if (QualifierAlignmentOrder.contains("type")) {

    FormatStyle->QualifierAlignment = FormatStyle::QAS_Custom;

    SmallVector<StringRef> Qualifiers;

    QualifierAlignmentOrder.split(Qualifiers, " ", /*MaxSplit=*/-1,

                                  /*KeepEmpty=*/false);

    FormatStyle->QualifierOrder = {Qualifiers.begin(), Qualifiers.end()};

  }

  if (SortIncludes.getNumOccurrences() != 0) {

    if (SortIncludes)

      FormatStyle->SortIncludes = FormatStyle::SI_CaseSensitive;

    else

      FormatStyle->SortIncludes = FormatStyle::SI_Never;

  }

  unsigned CursorPosition = Cursor;

  Replacements Replaces = sortIncludes(*FormatStyle, Code->getBuffer(), Ranges,

                                       AssumedFileName, &CursorPosition);

  // To format JSON insert a variable to trick the code into thinking its

  // JavaScript.

  if (FormatStyle->isJson() && 
!FormatStyle->DisableFormat0
) {

    auto Err = Replaces.add(tooling::Replacement(

        tooling::Replacement(AssumedFileName, 0, 0, "x = ")));

    if (Err) {

      llvm::errs() << "Bad Json variable insertion\n";

    }

  }

  auto ChangedCode = tooling::applyAllReplacements(Code->getBuffer(), Replaces);

  if (!ChangedCode) {

    llvm::errs() << llvm::toString(ChangedCode.takeError()) << "\n";

    return true;

  }

  // Get new affected ranges after sorting `#includes`.

  Ranges = tooling::calculateRangesAfterReplacements(Replaces, Ranges);

  FormattingAttemptStatus Status;

  Replacements FormatChanges =

      reformat(*FormatStyle, *ChangedCode, Ranges, AssumedFileName, &Status);

  Replaces = Replaces.merge(FormatChanges);

  if (OutputXML || 
DryRun39
) {

    if (DryRun) {

      return emitReplacementWarnings(Replaces, AssumedFileName, Code);

    } else {

      outputXML(Replaces, FormatChanges, Status, Cursor, CursorPosition);

    }

  } else {

    IntrusiveRefCntPtr<llvm::vfs::InMemoryFileSystem> InMemoryFileSystem(

        new llvm::vfs::InMemoryFileSystem);

    FileManager Files(FileSystemOptions(), InMemoryFileSystem);

    IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts(new DiagnosticOptions());

    ClangFormatDiagConsumer IgnoreDiagnostics;

    DiagnosticsEngine Diagnostics(

        IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs), &*DiagOpts,

        &IgnoreDiagnostics, false);

    SourceManager Sources(Diagnostics, Files);

    FileID ID = createInMemoryFile(AssumedFileName, *Code, Sources, Files,

                                   InMemoryFileSystem.get());

    Rewriter Rewrite(Sources, LangOptions());

    tooling::applyAllReplacements(Replaces, Rewrite);

    if (Inplace) {

      if (Rewrite.overwriteChangedFiles())

        return true;

    } else {

      if (Cursor.getNumOccurrences() != 0) {

        outs() << "{ \"Cursor\": "

               << FormatChanges.getShiftedCodePosition(CursorPosition)

               << ", \"IncompleteFormat\": "

               << (Status.FormatComplete ? 
"false"1
 : 
"true"1
);

        if (!Status.FormatComplete)

          outs() << ", \"Line\": " << Status.Line;

        outs() << " }\n";

      }

      Rewrite.getEditBuffer(ID).write(outs());

    }

  }

  return false;

}

} // namespace format

} // namespace clang

static void PrintVersion(raw_ostream &OS) {

  OS << clang::getClangToolFullVersion("clang-format") << '\n';

}

// Dump the configuration.

static int dumpConfig() {

  StringRef FileName;

  std::unique_ptr<llvm::MemoryBuffer> Code;

  if (FileNames.empty()) {

    // We can't read the code to detect the language if there's no

    // file name, so leave Code empty here.

    FileName = AssumeFileName;

  } else {

    // Read in the code in case the filename alone isn't enough to

    // detect the language.

    ErrorOr<std::unique_ptr<MemoryBuffer>> CodeOrErr =

        MemoryBuffer::getFileOrSTDIN(FileNames[0]);

    if (std::error_code EC = CodeOrErr.getError()) {

      llvm::errs() << EC.message() << "\n";

      return 1;

    }

    FileName = (FileNames[0] == "-") ? 
AssumeFileName0
 : FileNames[0];

    Code = std::move(CodeOrErr.get());

  }

  llvm::Expected<clang::format::FormatStyle> FormatStyle =

      clang::format::getStyle(Style, FileName, FallbackStyle,

                              Code ? Code->getBuffer() : 
""0
);

  if (!FormatStyle) {

    llvm::errs() << llvm::toString(FormatStyle.takeError()) << "\n";

    return 1;

  }

  std::string Config = clang::format::configurationAsText(*FormatStyle);

  outs() << Config << "\n";

  return 0;

}

int main(int argc, const char **argv) {

  llvm::InitLLVM X(argc, argv);

  cl::HideUnrelatedOptions(ClangFormatCategory);

  cl::SetVersionPrinter(PrintVersion);

  cl::ParseCommandLineOptions(

      argc, argv,

      "A tool to format C/C++/Java/JavaScript/JSON/Objective-C/Protobuf/C# "

      "code.\n\n"

      "If no arguments are specified, it formats the code from standard input\n"

      "and writes the result to the standard output.\n"

      "If <file>s are given, it reformats the files. If -i is specified\n"

      "together with <file>s, the files are edited in-place. Otherwise, the\n"

      "result is written to the standard output.\n");

  if (Help) {

    cl::PrintHelpMessage();

    return 0;

  }

  if (DumpConfig) {

    return dumpConfig();

  }

  if (!Files.empty()) {

    std::ifstream ExternalFileOfFiles{std::string(Files)};

    std::string Line;

    unsigned LineNo = 1;

    while (std::getline(ExternalFileOfFiles, Line)) {

      FileNames.push_back(Line);

      LineNo++;

    }

    errs() << "Clang-formating " << LineNo << " files\n";

  }

  bool Error = false;

  if (FileNames.empty()) {

    Error = clang::format::format("-");

    return Error ? 
11
 : 
017
;

  }

  if (FileNames.size() != 1 &&

      
(4
!Offsets.empty()4
 || 
!Lengths.empty()3
 || 
!LineRanges.empty()3
)) {

    errs() << "error: -offset, -length and -lines can only be used for "

              "single file.\n";

    return 1;

  }

  unsigned FileNo = 1;

  for (const auto &FileName : FileNames) {

    if (Verbose)

      errs() << "Formatting [" << FileNo++ << "/" << FileNames.size() << "] "

             << FileName << "\n";

    Error |= clang::format::format(FileName);

  }

  return Error ? 
13
 : 
021
;

}