Merge branch 'clang-format'

.clang-format

+---
+Language:        Cpp
+# BasedOnStyle:  LLVM
+AccessModifierOffset: -2
+ConstructorInitializerIndentWidth: 4
+AlignEscapedNewlinesLeft: false
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AlwaysBreakTemplateDeclarations: false
+AlwaysBreakBeforeMultilineStrings: false
+BreakBeforeBinaryOperators: false
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BinPackParameters: true
+ColumnLimit:     80
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+DerivePointerAlignment: false
+ExperimentalAutoDetectBinPacking: false
+IndentCaseLabels: false
+IndentWrappedFunctionNames: false
+IndentFunctionDeclarationAfterType: false
+MaxEmptyLinesToKeep: 1
+KeepEmptyLinesAtTheStartOfBlocks: true
+NamespaceIndentation: None
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakString: 1000
+PenaltyBreakFirstLessLess: 120
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Right
+SpacesBeforeTrailingComments: 1
+Cpp11BracedListStyle: true
+Standard:        Cpp11
+IndentWidth:     2
+TabWidth:        8
+UseTab:          Never
+BreakBeforeBraces: Attach
+SpacesInParentheses: false
+SpacesInAngles:  false
+SpaceInEmptyParentheses: false
+SpacesInCStyleCastParentheses: false
+SpacesInContainerLiterals: true
+SpaceBeforeAssignmentOperators: true
+ContinuationIndentWidth: 4
+CommentPragmas:  '^ IWYU pragma:'
+ForEachMacros:   [ foreach, Q_FOREACH, BOOST_FOREACH ]
+SpaceBeforeParens: ControlStatements
+DisableFormat:   false
+...
+

.gitignore

@@ -43,6 +43,7 @@ doc/python-apiref.rst
 doc/building-android-binary.rst
 doc/asio_http2.h.rst
 doc/libnghttp2_asio.rst
+doc/contribute.rst
 python/setup.py
 python/dist
 python/MANIFEST

Makefile.am

@@ -28,3 +28,15 @@ dist_doc_DATA = README.rst
 
 EXTRA_DIST = nghttpx.conf.sample proxy.pac.sample android-config android-make \
 	Dockerfile.android
+
+.PONY: clang-format
+
+# Format source files using clang-format.  Don't format source files
+# under third-party directory since we are not responsible for thier
+# coding style.
+clang-format:
+	CLANGFORMAT=`git config --get clangformat.binary`; \
+	test -z $${CLANGFORMAT} && CLANGFORMAT="clang-format"; \
+	$${CLANGFORMAT} -i lib/*.{c,h} lib/includes/nghttp2/*.h \
+	src/*.{c,cc,h} src/includes/nghttp2/*.h examples/*.{c,cc} \
+	tests/*.{c,h}

README.rst

@@ -1150,3 +1150,7 @@ to hand over that patch/code to us.  We will credit you for your
 changes as far as possible, to give credit but also to keep a trace
 back to who made what changes.  Please always provide us with your
 full real name when contributing!
+
+See `Contribution Guidelines
+<https://nghttp2.org/documentation/contribute.html>`_ for more
+details.

configure.ac

@@ -597,6 +597,7 @@ AC_CONFIG_FILES([
   doc/nghttp2.h.rst
   doc/nghttp2ver.h.rst
   doc/asio_http2.h.rst
+  doc/contribute.rst
   contrib/Makefile
 ])
 AC_OUTPUT

doc/Makefile.am

@@ -40,6 +40,7 @@ EXTRA_DIST = \
 	sources/libnghttp2_asio.rst \
 	sources/python-apiref.rst \
 	sources/building-android-binary.rst \
+	sources/contribute.rst \
 	_themes/sphinx_rtd_theme/footer.html \
 	_themes/sphinx_rtd_theme/theme.conf \
 	_themes/sphinx_rtd_theme/layout_old.html \

doc/contribute.rst.in

+.. include:: @top_srcdir@/doc/sources/contribute.rst

doc/sources/contribute.rst

+Contribution Guidelines
+=======================
+
+[This text was composed based on 1.2. License section of curl/libcurl
+project.]
+
+When contributing with code, you agree to put your changes and new
+code under the same license nghttp2 is already using unless stated and
+agreed otherwise.
+
+When changing existing source code, you do not alter the copyright of
+the original file(s).  The copyright will still be owned by the
+original creator(s) or those who have been assigned copyright by the
+original author(s).
+
+By submitting a patch to the nghttp2 project, you are assumed to have
+the right to the code and to be allowed by your employer or whatever
+to hand over that patch/code to us.  We will credit you for your
+changes as far as possible, to give credit but also to keep a trace
+back to who made what changes.  Please always provide us with your
+full real name when contributing!
+
+Coding style
+------------
+
+We use clang-format to format source code consistently.  The
+clang-format configuration file .clang-format is located at the root
+directory.  Since clang-format produces slightly different results
+between versions, we currently use clang-format which comes with
+clang-3.5.
+
+To detect any violation to the coding style, we recommend to setup git
+pre-commit hook to check coding style of the changes you introduced.
+The pre-commit file is located at the root directory.  Copy it under
+.git/hooks and make sure that it is executable.  The pre-commit script
+uses clang-format-diff.py to detect any style errors.  If it is not in
+your PATH or it exists under different name (e.g.,
+clang-format-diff-3.5 in debian), either add it to PATH variable or
+add git option ``clangformatdiff.binary`` to point to the script.
+
+For emacs users, integrating clang-format to emacs is very easy.
+clang-format.el should come with clang distribution.  If it is not
+found, download it from `here
+<https://llvm.org/svn/llvm-project/cfe/trunk/tools/clang-format/clang-format.el>`_.
+And add these lines to your .emacs file:
+
+.. code-block:: lisp
+
+    ;; From
+    ;; https://code.google.com/p/chromium/wiki/Emacs#Use_Google's_C++_style!
+    (load "/<path/to>/clang-format.el")
+    (add-hook 'c-mode-common-hook
+         (function (lambda () (local-set-key (kbd "TAB")
+                                             'clang-format-region))))
+
+You can find other editor integration in
+http://clang.llvm.org/docs/ClangFormat.html.

doc/sources/index.rst

@@ -17,6 +17,7 @@ Contents:
    :maxdepth: 2
 
    package_README
+   contribute
    building-android-binary
    tutorial-client
    tutorial-server

examples/asio-sv.cc

@@ -42,8 +42,7 @@
 using namespace nghttp2::asio_http2;
 using namespace nghttp2::asio_http2::server;
 
-int main(int argc, char* argv[])
-{
+int main(int argc, char *argv[]) {
   try {
     // Check command line arguments.
     if (argc < 3) {
@@ -59,19 +58,16 @@ int main(int argc, char* argv[])
 
     server.num_threads(num_threads);
 
-    if(argc >= 5) {
+    if (argc >= 5) {
       server.tls(argv[3], argv[4]);
     }
 
-    server.listen
-      ("*", port,
-       [](const std::shared_ptr<request>& req,
-          const std::shared_ptr<response>& res)
-       {
-         res->write_head(200, { header{ "foo", "bar" } });
-         res->end("hello, world");
-       });
-  } catch (std::exception& e) {
+    server.listen("*", port, [](const std::shared_ptr<request> &req,
+                                const std::shared_ptr<response> &res) {
+      res->write_head(200, {header{"foo", "bar"}});
+      res->end("hello, world");
+    });
+  } catch (std::exception &e) {
     std::cerr << "exception: " << e.what() << "\n";
   }
 

examples/asio-sv2.cc

@@ -45,8 +45,7 @@
 using namespace nghttp2::asio_http2;
 using namespace nghttp2::asio_http2::server;
 
-int main(int argc, char* argv[])
-{
+int main(int argc, char *argv[]) {
   try {
     // Check command line arguments.
     if (argc < 4) {
@@ -63,47 +62,44 @@ int main(int argc, char* argv[])
 
     server.num_threads(num_threads);
 
-    if(argc >= 6) {
+    if (argc >= 6) {
       server.tls(argv[4], argv[5]);
     }
 
-    server.listen
-      ("*", port,
-       [&docroot](const std::shared_ptr<request>& req,
-                  const std::shared_ptr<response>& res)
-       {
-         auto path = percent_decode(req->path());
-         if(!check_path(path)) {
-           res->write_head(404);
-           res->end();
-           return;
-         }
+    server.listen("*", port, [&docroot](const std::shared_ptr<request> &req,
+                                        const std::shared_ptr<response> &res) {
+      auto path = percent_decode(req->path());
+      if (!check_path(path)) {
+        res->write_head(404);
+        res->end();
+        return;
+      }
 
-         if(path == "/") {
-           path = "/index.html";
-         }
+      if (path == "/") {
+        path = "/index.html";
+      }
 
-         path = docroot + path;
-         auto fd = open(path.c_str(), O_RDONLY);
-         if(fd == -1) {
-           res->write_head(404);
-           res->end();
-           return;
-         }
+      path = docroot + path;
+      auto fd = open(path.c_str(), O_RDONLY);
+      if (fd == -1) {
+        res->write_head(404);
+        res->end();
+        return;
+      }
 
-         auto headers = std::vector<header>();
+      auto headers = std::vector<header>();
 
-         struct stat stbuf;
-         if(stat(path.c_str(), &stbuf) == 0) {
-           headers.push_back
-             (header{"content-length", std::to_string(stbuf.st_size)});
-           headers.push_back
-             (header{"last-modified", http_date(stbuf.st_mtim.tv_sec)});
-         }
-         res->write_head(200, std::move(headers));
-         res->end(file_reader_from_fd(fd));
-       });
-  } catch (std::exception& e) {
+      struct stat stbuf;
+      if (stat(path.c_str(), &stbuf) == 0) {
+        headers.push_back(
+            header{"content-length", std::to_string(stbuf.st_size)});
+        headers.push_back(
+            header{"last-modified", http_date(stbuf.st_mtim.tv_sec)});
+      }
+      res->write_head(200, std::move(headers));
+      res->end(file_reader_from_fd(fd));
+    });
+  } catch (std::exception &e) {
     std::cerr << "exception: " << e.what() << "\n";
   }
 

examples/asio-sv3.cc

@@ -43,8 +43,7 @@
 using namespace nghttp2::asio_http2;
 using namespace nghttp2::asio_http2::server;
 
-int main(int argc, char* argv[])
-{
+int main(int argc, char *argv[]) {
   try {
     // Check command line arguments.
     if (argc < 4) {
@@ -61,89 +60,81 @@ int main(int argc, char* argv[])
 
     server.num_threads(num_threads);
 
-    if(argc >= 5) {
+    if (argc >= 5) {
       server.tls(argv[4], argv[5]);
     }
 
     server.num_concurrent_tasks(num_concurrent_tasks);
 
-    server.listen
-      ("*", port,
-       [](const std::shared_ptr<request>& req,
-          const std::shared_ptr<response>& res)
-       {
-         res->write_head(200);
-
-         auto msgq = std::make_shared<std::deque<std::string>>();
-
-         res->end
-           ([msgq](uint8_t *buf, std::size_t len) -> std::pair<ssize_t, bool>
-            {
-              if(msgq->empty()) {
-                // if msgq is empty, tells the library that don't call
-                // this callback until we call res->resume().  This is
-                // done by returing std::make_pair(0, false).
-                return std::make_pair(0, false);
-              }
-              auto msg = std::move(msgq->front());
-              msgq->pop_front();
-
-              if(msg.empty()) {
-                // The empty message signals the end of response in
-                // this simple protocol.
-                return std::make_pair(0, true);
-              }
-
-              auto nwrite = std::min(len, msg.size());
-              std::copy(std::begin(msg), std::begin(msg) + nwrite, buf);
-              if(msg.size() > nwrite) {
-                msgq->push_front(msg.substr(nwrite));
-              }
-              return std::make_pair(nwrite, false);
-            });
-
-         req->run_task
-           ([res, msgq](channel& channel)
-            {
-              // executed in different thread from request callback
-              // was called.
-
-              // Using res and msgq is not safe inside this callback.
-              // But using them in callback passed to channel::post is
-              // safe.
-
-              // We just emit simple message "message N\n" in every 1
-              // second and 3 times in total.
-              for(std::size_t i = 0; i < 3; ++i) {
-                msgq->push_back("message " + std::to_string(i + 1) + "\n");
-
-                channel.post([res]()
-                             {
-                               // executed in same thread where
-                               // request callback was called.
-
-                               // Tells library we have new message.
-                               res->resume();
-                             });
-
-                sleep(1);
-              }
-
-              // Send empty message to signal the end of response
-              // body.
-              msgq->push_back("");
-
-              channel.post([res]()
-                           {
-                             // executed in same thread where request
-                             // callback was called.
-                             res->resume();
-                           });
-
-            });
-
-       });
-  } catch (std::exception& e) {
+    server.listen("*", port, [](const std::shared_ptr<request> &req,
+                                const std::shared_ptr<response> &res) {
+      res->write_head(200);
+
+      auto msgq = std::make_shared<std::deque<std::string>>();
+
+      res->end([msgq](uint8_t * buf, std::size_t len)
+                   -> std::pair<ssize_t, bool> {
+        if (msgq->empty()) {
+          // if msgq is empty, tells the library that don't call
+          // this callback until we call res->resume().  This is
+          // done by returing std::make_pair(0, false).
+          return std::make_pair(0, false);
+        }
+        auto msg = std::move(msgq->front());
+        msgq->pop_front();
+
+        if (msg.empty()) {
+          // The empty message signals the end of response in
+          // this simple protocol.
+          return std::make_pair(0, true);
+        }
+
+        auto nwrite = std::min(len, msg.size());
+        std::copy(std::begin(msg), std::begin(msg) + nwrite, buf);
+        if (msg.size() > nwrite) {
+          msgq->push_front(msg.substr(nwrite));
+        }
+        return std::make_pair(nwrite, false);
+      });
+
+      req->run_task([res, msgq](channel &channel) {
+        // executed in different thread from request callback
+        // was called.
+
+        // Using res and msgq is not safe inside this callback.
+        // But using them in callback passed to channel::post is
+        // safe.
+
+        // We just emit simple message "message N\n" in every 1
+        // second and 3 times in total.
+        for (std::size_t i = 0; i < 3; ++i) {
+          msgq->push_back("message " + std::to_string(i + 1) + "\n");
+
+          channel.post([res]() {
+            // executed in same thread where
+            // request callback was called.
+
+            // Tells library we have new message.
+            res->resume();
+          });
+
+          sleep(1);
+        }
+
+        // Send empty message to signal the end of response
+        // body.
+        msgq->push_back("");
+
+        channel.post([res]() {
+          // executed in same thread where request
+          // callback was called.
+          res->resume();
+        });
+
+      });
+
+    });
+  } catch (std::exception &e) {
     std::cerr << "exception: " << e.what() << "\n";
   }
 

examples/deflate.c

@@ -31,43 +31,39 @@
 
 #include <nghttp2/nghttp2.h>
 
-#define MAKE_NV(K, V)                                           \
-  { (uint8_t*)K, (uint8_t*)V, sizeof(K) - 1, sizeof(V) - 1,     \
-      NGHTTP2_NV_FLAG_NONE }
+#define MAKE_NV(K, V)                                                          \
+  {                                                                            \
+    (uint8_t *) K, (uint8_t *)V, sizeof(K) - 1, sizeof(V) - 1,                 \
+        NGHTTP2_NV_FLAG_NONE                                                   \
+  }
 
 static void deflate(nghttp2_hd_deflater *deflater,
-                    nghttp2_hd_inflater *inflater,
-                    const nghttp2_nv * const nva, size_t nvlen);
+                    nghttp2_hd_inflater *inflater, const nghttp2_nv *const nva,
+                    size_t nvlen);
 
-static int inflate_header_block(nghttp2_hd_inflater *inflater,
-                                uint8_t *in, size_t inlen, int final);
+static int inflate_header_block(nghttp2_hd_inflater *inflater, uint8_t *in,
+                                size_t inlen, int final);
 
-int main(int argc _U_, char **argv _U_)
-{
+int main(int argc _U_, char **argv _U_) {
   int rv;
   nghttp2_hd_deflater *deflater;
   nghttp2_hd_inflater *inflater;
   /* Define 1st header set.  This is looks like a HTTP request. */
   nghttp2_nv nva1[] = {
-    MAKE_NV(":scheme", "https"),
-    MAKE_NV(":authority", "example.org"),
-    MAKE_NV(":path", "/"),
-    MAKE_NV("user-agent", "libnghttp2"),
-    MAKE_NV("accept-encoding", "gzip, deflate")
-  };
+      MAKE_NV(":scheme", "https"), MAKE_NV(":authority", "example.org"),
+      MAKE_NV(":path", "/"), MAKE_NV("user-agent", "libnghttp2"),
+      MAKE_NV("accept-encoding", "gzip, deflate")};
   /* Define 2nd header set */
-  nghttp2_nv nva2[] = {
-    MAKE_NV(":scheme", "https"),
-    MAKE_NV(":authority", "example.org"),
-    MAKE_NV(":path", "/stylesheet/style.css"),
-    MAKE_NV("user-agent", "libnghttp2"),
-    MAKE_NV("accept-encoding", "gzip, deflate"),
-    MAKE_NV("referer", "https://example.org")
-  };
+  nghttp2_nv nva2[] = {MAKE_NV(":scheme", "https"),
+                       MAKE_NV(":authority", "example.org"),
+                       MAKE_NV(":path", "/stylesheet/style.css"),
+                       MAKE_NV("user-agent", "libnghttp2"),
+                       MAKE_NV("accept-encoding", "gzip, deflate"),
+                       MAKE_NV("referer", "https://example.org")};
 
   rv = nghttp2_hd_deflate_new(&deflater, 4096);
 
-  if(rv != 0) {
+  if (rv != 0) {
     fprintf(stderr, "nghttp2_hd_deflate_init failed with error: %s\n",
             nghttp2_strerror(rv));
     exit(EXIT_FAILURE);
@@ -75,7 +71,7 @@ int main(int argc _U_, char **argv _U_)
 
   rv = nghttp2_hd_inflate_new(&inflater);
 
-  if(rv != 0) {
+  if (rv != 0) {
     fprintf(stderr, "nghttp2_hd_inflate_init failed with error: %s\n",
             nghttp2_strerror(rv));
     exit(EXIT_FAILURE);
@@ -95,9 +91,8 @@ int main(int argc _U_, char **argv _U_)
 }
 
 static void deflate(nghttp2_hd_deflater *deflater,
-                    nghttp2_hd_inflater *inflater,
-                    const nghttp2_nv * const nva, size_t nvlen)
-{
+                    nghttp2_hd_inflater *inflater, const nghttp2_nv *const nva,
+                    size_t nvlen) {
   ssize_t rv;
   uint8_t *buf;
   size_t buflen;
@@ -107,13 +102,13 @@ static void deflate(nghttp2_hd_deflater *deflater,
 
   sum = 0;
 
-  for(i = 0; i < nvlen; ++i) {
+  for (i = 0; i < nvlen; ++i) {
     sum += nva[i].namelen + nva[i].valuelen;
   }
 
   printf("Input (%zu byte(s)):\n\n", sum);
 
-  for(i = 0; i < nvlen; ++i) {
+  for (i = 0; i < nvlen; ++i) {
     fwrite(nva[i].name, nva[i].namelen, 1, stdout);
     printf(": ");
     fwrite(nva[i].value, nva[i].valuelen, 1, stdout);
@@ -125,7 +120,7 @@ static void deflate(nghttp2_hd_deflater *deflater,
 
   rv = nghttp2_hd_deflate_hd(deflater, buf, buflen, nva, nvlen);
 
-  if(rv < 0) {
+  if (rv < 0) {
     fprintf(stderr, "nghttp2_hd_deflate_hd() failed with error: %s\n",
             nghttp2_strerror((int)rv));
 
@@ -136,17 +131,17 @@ static void deflate(nghttp2_hd_deflater *deflater,
 
   outlen = rv;
 
-  printf("\nDeflate (%zu byte(s), ratio %.02f):\n\n",
-         outlen, sum == 0 ? 0 : (double)outlen / sum);
+  printf("\nDeflate (%zu byte(s), ratio %.02f):\n\n", outlen,
+         sum == 0 ? 0 : (double)outlen / sum);
 
-  for(i = 0; i < outlen; ++i) {
-    if((i & 0x0fu) == 0) {
+  for (i = 0; i < outlen; ++i) {
+    if ((i & 0x0fu) == 0) {
       printf("%08zX: ", i);
     }
 
     printf("%02X ", buf[i]);
 
-    if(((i + 1) & 0x0fu) == 0) {
+    if (((i + 1) & 0x0fu) == 0) {
       printf("\n");
     }
   }
@@ -157,7 +152,7 @@ static void deflate(nghttp2_hd_deflater *deflater,
      header data. */
   rv = inflate_header_block(inflater, buf, outlen, 1);
 
-  if(rv != 0) {
+  if (rv != 0) {
     free(buf);
 
     exit(EXIT_FAILURE);
@@ -169,20 +164,18 @@ static void deflate(nghttp2_hd_deflater *deflater,
   free(buf);
 }
 
-int inflate_header_block(nghttp2_hd_inflater *inflater,
-                         uint8_t *in, size_t inlen, int final)
-{
+int inflate_header_block(nghttp2_hd_inflater *inflater, uint8_t *in,
+                         size_t inlen, int final) {
   ssize_t rv;
 
-  for(;;) {
+  for (;;) {
     nghttp2_nv nv;
     int inflate_flags = 0;
     size_t proclen;
 
-    rv = nghttp2_hd_inflate_hd(inflater, &nv, &inflate_flags,
-                               in, inlen, final);
+    rv = nghttp2_hd_inflate_hd(inflater, &nv, &inflate_flags, in, inlen, final);
 
-    if(rv < 0) {
+    if (rv < 0) {
       fprintf(stderr, "inflate failed with error code %zd", rv);
       return -1;
     }
@@ -192,20 +185,19 @@ int inflate_header_block(nghttp2_hd_inflater *inflater,
     in += proclen;
     inlen -= proclen;
 
-    if(inflate_flags & NGHTTP2_HD_INFLATE_EMIT) {
+    if (inflate_flags & NGHTTP2_HD_INFLATE_EMIT) {
       fwrite(nv.name, nv.namelen, 1, stderr);
       fprintf(stderr, ": ");
       fwrite(nv.value, nv.valuelen, 1, stderr);
       fprintf(stderr, "\n");
     }
 
-    if(inflate_flags & NGHTTP2_HD_INFLATE_FINAL) {
+    if (inflate_flags & NGHTTP2_HD_INFLATE_FINAL) {
       nghttp2_hd_inflate_end_headers(inflater);
       break;
     }
 
-    if((inflate_flags & NGHTTP2_HD_INFLATE_EMIT) == 0 &&
-       inlen == 0) {
+    if ((inflate_flags & NGHTTP2_HD_INFLATE_EMIT) == 0 && inlen == 0) {
       break;
     }
   }