[SIL][Remarks] Use camelCase for fields, arguments, and variables

Author: francisvm

include/swift/SIL/OptimizationRemark.h

@@ -34,24 +34,24 @@ namespace OptRemark {
 /// Used in the streaming interface as the general argument type.  It
 /// internally converts everything into a key-value pair.
 struct Argument {
-  std::string Key;
-  std::string Val;
+  std::string key;
+  std::string val;
   /// If set, the debug location corresponding to the value.
-  SourceLoc Loc;
+  SourceLoc loc;
 
-  explicit Argument(StringRef Str = "") : Key("String"), Val(Str) {}
-  Argument(StringRef Key, StringRef Val) : Key(Key), Val(Val) {}
+  explicit Argument(StringRef Str = "") : key("String"), val(Str) {}
+  Argument(StringRef key, StringRef val) : key(key), val(val) {}
 
-  Argument(StringRef Key, int N);
-  Argument(StringRef Key, long N);
-  Argument(StringRef Key, long long N);
-  Argument(StringRef Key, unsigned N);
-  Argument(StringRef Key, unsigned long N);
-  Argument(StringRef Key, unsigned long long N);
+  Argument(StringRef key, int n);
+  Argument(StringRef key, long n);
+  Argument(StringRef key, long long n);
+  Argument(StringRef key, unsigned n);
+  Argument(StringRef key, unsigned long n);
+  Argument(StringRef key, unsigned long long n);
 
-  Argument(StringRef Key, SILFunction *F);
-  Argument(StringRef Key, SILType Ty);
-  Argument(StringRef Key, CanType Ty);
+  Argument(StringRef key, SILFunction *f);
+  Argument(StringRef key, SILType ty);
+  Argument(StringRef key, CanType ty);
 };
 
 /// Shorthand to insert named-value pairs.
@@ -60,132 +60,133 @@ using NV = Argument;
 /// Inserting this into a Remark indents the text when printed as a debug
 /// message.
 struct IndentDebug {
-  explicit IndentDebug(unsigned Width) : Width(Width) {}
-  unsigned Width;
+  explicit IndentDebug(unsigned width) : width(width) {}
+  unsigned width;
 };
 
 /// The base class for remarks.  This can be created by optimization passed to
 /// report successful and unsuccessful optimizations. CRTP is used to preserve
 /// the underlying type encoding the remark kind in the insertion operator.
 template <typename DerivedT> class Remark {
   /// Arguments collected via the streaming interface.
-  SmallVector<Argument, 4> Args;
+  SmallVector<Argument, 4> args;
 
   /// The name of the pass generating the remark.
-  StringRef PassName;
+  StringRef passName;
 
   /// Textual identifier for the remark (single-word, camel-case). Can be used
   /// by external tools reading the YAML output file for optimization remarks to
   /// identify the remark.
-  StringRef Identifier;
+  StringRef identifier;
 
   /// Source location for the diagnostics.
-  SourceLoc Location;
+  SourceLoc location;
 
   /// The function for the diagnostics.
-  SILFunction *Function;
+  SILFunction *function;
 
   /// Indentation used if this remarks is printed as a debug message.
-  unsigned IndentDebugWidth = 0;
+  unsigned indentDebugWidth = 0;
 
 protected:
-  Remark(StringRef Identifier, SILInstruction &I)
-      : Identifier(Identifier), Location(I.getLoc().getSourceLoc()),
-        Function(I.getParent()->getParent()) {}
+  Remark(StringRef identifier, SILInstruction &i)
+      : identifier(identifier), location(i.getLoc().getSourceLoc()),
+        function(i.getParent()->getParent()) {}
 
 public:
-  DerivedT &operator<<(StringRef S) {
-    Args.emplace_back(S);
+  DerivedT &operator<<(StringRef s) {
+    args.emplace_back(s);
     return *static_cast<DerivedT *>(this);
   }
 
-  DerivedT &operator<<(Argument A) {
-    Args.push_back(std::move(A));
+  DerivedT &operator<<(Argument a) {
+    args.push_back(std::move(a));
     return *static_cast<DerivedT *>(this);
   }
 
-  DerivedT &operator<<(IndentDebug ID) {
-    IndentDebugWidth = ID.Width;
+  DerivedT &operator<<(IndentDebug indent) {
+    indentDebugWidth = indent.width;
     return *static_cast<DerivedT *>(this);
   }
 
-  StringRef getPassName() const { return PassName; }
-  StringRef getIdentifier() const { return Identifier; }
-  SILFunction *getFunction() const { return Function; }
-  SourceLoc getLocation() const { return Location; }
+  StringRef getPassName() const { return passName; }
+  StringRef getIdentifier() const { return identifier; }
+  SILFunction *getFunction() const { return function; }
+  SourceLoc getLocation() const { return location; }
   std::string getMsg() const;
   std::string getDebugMsg() const;
   Remark<DerivedT> &getRemark() { return *this; }
-  SmallVector<Argument, 4> &getArgs() { return Args; }
+  SmallVector<Argument, 4> &getArgs() { return args; }
 
-  void setPassName(StringRef PN) { PassName = PN; }
+  void setPassName(StringRef name) { passName = name; }
 };
 
 /// Remark to report a successful optimization.
 struct RemarkPassed : public Remark<RemarkPassed> {
-  RemarkPassed(StringRef Id, SILInstruction &I) : Remark(Id, I) {}
+  RemarkPassed(StringRef id, SILInstruction &i) : Remark(id, i) {}
 };
 /// Remark to report a unsuccessful optimization.
 struct RemarkMissed : public Remark<RemarkMissed> {
-  RemarkMissed(StringRef Id, SILInstruction &I) : Remark(Id, I) {}
+  RemarkMissed(StringRef id, SILInstruction &i) : Remark(id, i) {}
 };
 
 /// Used to emit the remarks.  Passes reporting remarks should create an
 /// instance of this.
 class Emitter {
-  SILModule &Module;
-  std::string PassName;
-  bool PassedEnabled;
-  bool MissedEnabled;
+  SILModule &module;
+  std::string passName;
+  bool passedEnabled;
+  bool missedEnabled;
 
   // Making these non-generic allows out-of-line definition.
-  void emit(const RemarkPassed &R);
-  void emit(const RemarkMissed &R);
-  static void emitDebug(const RemarkPassed &R);
-  static void emitDebug(const RemarkMissed &R);
+  void emit(const RemarkPassed &remark);
+  void emit(const RemarkMissed &remark);
+  static void emitDebug(const RemarkPassed &remark);
+  static void emitDebug(const RemarkMissed &remark);
 
   template <typename RemarkT> bool isEnabled();
 
 public:
-  Emitter(StringRef PassName, SILModule &M);
+  Emitter(StringRef passName, SILModule &m);
 
   /// Take a lambda that returns a remark which will be emitted.  The
   /// lambda is not evaluated unless remarks are enabled.  Second argument is
   /// only used to restrict this to functions.
   template <typename T>
-  void emit(T RemarkBuilder, decltype(RemarkBuilder()) * = nullptr) {
-    using RemarkT = decltype(RemarkBuilder());
+  void emit(T remarkBuilder, decltype(remarkBuilder()) * = nullptr) {
+    using RemarkT = decltype(remarkBuilder());
     // Avoid building the remark unless remarks are enabled.
-    if (isEnabled<RemarkT>() || Module.getOptRecordStream()) {
-      auto rb = RemarkBuilder();
-      rb.setPassName(PassName);
+    if (isEnabled<RemarkT>() || module.getOptRecordStream()) {
+      auto rb = remarkBuilder();
+      rb.setPassName(passName);
       emit(rb);
     }
   }
 
   /// Emit an optimization remark or debug message.
   template <typename T>
-  static void emitOrDebug(const char *PassName, Emitter *ORE, T RemarkBuilder,
-                          decltype(RemarkBuilder()) * = nullptr) {
-    using RemarkT = decltype(RemarkBuilder());
+  static void emitOrDebug(const char *passName, Emitter *emitter,
+                          T remarkBuilder,
+                          decltype(remarkBuilder()) * = nullptr) {
+    using RemarkT = decltype(remarkBuilder());
     // Avoid building the remark unless remarks are enabled.
-    bool EmitRemark =
-        ORE && (ORE->isEnabled<RemarkT>() || ORE->Module.getOptRecordStream());
+    bool emitRemark = emitter && (emitter->isEnabled<RemarkT>() ||
+                                  emitter->module.getOptRecordStream());
     // Same for DEBUG.
-    bool EmitDebug = false;
+    bool shouldEmitDebug = false;
 #ifndef NDEBUG
-    EmitDebug |= llvm::DebugFlag && llvm::isCurrentDebugType(PassName);
+    shouldEmitDebug |= llvm::DebugFlag && llvm::isCurrentDebugType(passName);
 #endif // NDEBUG
 
-    if (EmitRemark || EmitDebug) {
-      auto R = RemarkBuilder();
-      if (EmitDebug)
-        emitDebug(R);
-      if (EmitRemark) {
-        // If we have ORE use the PassName that was set up with ORE. DEBUG_TYPE
+    if (emitRemark || shouldEmitDebug) {
+      auto r = remarkBuilder();
+      if (shouldEmitDebug)
+        emitDebug(r);
+      if (emitRemark) {
+        // If we have an Emitter use the PassName that was set up. DEBUG_TYPE
         // may be different if a pass is calling other modules.
-        R.setPassName(ORE->PassName);
-        ORE->emit(R);
+        r.setPassName(emitter->passName);
+        emitter->emit(r);
       }
     }
   }
@@ -195,10 +196,10 @@ class Emitter {
   OptRemark::Emitter::emitOrDebug(DEBUG_TYPE, __VA_ARGS__)
 
 template <> inline bool Emitter::isEnabled<RemarkMissed>() {
-  return MissedEnabled;
+  return missedEnabled;
 }
 template <> inline bool Emitter::isEnabled<RemarkPassed>() {
-  return PassedEnabled;
+  return passedEnabled;
 }
 } // namespace OptRemark
 } // namespace swift