Changeset 242273 in webkit

Timestamp:

Mar 1, 2019 11:21:15 AM (5 years ago)

Author:

rniwa@webkit.org

Message:

Codify the naming convention for fooIfExists
​https://bugs.webkit.org/show_bug.cgi?id=194930

Reviewed by Darin Adler.

Updating the coding style guideline after the discussion following
​https://lists.webkit.org/pipermail/webkit-dev/2013-June/025056.html

• code-style.md:

Location:

trunk/Websites/webkit.org

Files:

• ChangeLog (modified) (1 diff)
• code-style.md (modified) (1 diff)

trunk/Websites/webkit.org/ChangeLog

@@ +1 @@
+2019-02-21  Ryosuke Niwa  <rniwa@webkit.org>
+
+        Codify the naming convention for fooIfExists
+        https://bugs.webkit.org/show_bug.cgi?id=194930
+
+        Reviewed by Darin Adler.
+
+        Updating the coding style guideline after the discussion following
+        https://lists.webkit.org/pipermail/webkit-dev/2013-June/025056.html
+
+        * code-style.md:
+
 2019-02-20  Jon Davis  <jond@apple.com>
 

trunk/Websites/webkit.org/code-style.md

@@ -675 +675 @@
 ```cpp
 bool toASCII(short*, size_t);
+```
+
+[](#names-if-exists) The getter function for a member variable should not have any suffix or prefix indicating the function can optionally create or initialize the member variable. Suffix the getter function which does not automatically create the object with `IfExists` if there is a variant which does.
+
+###### Right:
+
+```cpp
+StyleResolver* styleResolverIfExists();
+StyleResolver& styleResolver();
+```
+
+###### Wrong:
+
+```cpp
+StyleResolver* styleResolver();
+StyleResolver& ensureStyleResolver();
+```
+
+###### Right:
+
+```cpp
+Frame* frame();
+```
+
+###### Wrong:
+
+```cpp
+Frame* frameIfExists();
 ```