[refactor] Apply forward declaration as much as possible (#64)

* [refactor] Apply forward declaration as much as possible

Fixes #60

### Motivation

The includes in pulsar-client-cpp is very casual. There are a lot of
implicit includes and the forward declaration is not used much. For
example, if `lib/ClientConnection.h` was modified, 27 files would be
recompiled.

The other problem is the `SortIncludes` attribute in `.clang-format`
file is false. It might be okay in early days. However, as the project
grows, including many headers without ordering brings a very bad
experience. Combining with the very few usages of the forward
declaration, it's hard to determine whether a header is still required
after a change.

### Modifications

Apply forward declarations as much as possible and change the
`SortIncludes` to true in `.clang-format` file.

It's special for the `PulsarApi.pb.h` file because the size of this
header is over 1 MiB. For classes we can use forward declaration, but
for enumerations we have to include this header.

To solve this problem, `ProtoApiEnums.h` is added to define some
constant integers that can be cast implicitly from the enumerations. If
we want to use enumerations from `PulsarApi.pb.h`, we can include
`ProtoApiEnums.h` instead.

Finally, to unify the include rules, in `lib/*.h`, if we want to include
a header (e.g. `xxx.h`) from the same directory, just use `#include
"xxx.h"`. Don't use `#include "lib/xxx.h"` or `#include <lib/xxx.h>` in
headers of `lib/` directory.

### Improvements

Since forward declaration is applied everywhere now, take
`lib/ClientConnection.h` for example. After this patch, only 10 files
needs to be recompiled, while 27 files would be recompiled before.

This patch also reduces the binary size and speeds up the compilation
time.

Binary size:
- `libpulsar.a`: 319234696 (305 MiB) -> 286716564 (274 MiB)
- `libpulsar.so`: 110162496 (106 MiB) -> 102428456 (98 MiB)

Compilation time with the following commands:

```bash
cmake -B build -DBUILD_TESTS=OFF
cmake --build build -j8
```

* Fix MSVC build

Author: BewareMyPower

.clang-format

@@ -19,7 +19,7 @@
 BasedOnStyle: Google
 IndentWidth: 4
 ColumnLimit: 110
-SortIncludes: false
+SortIncludes: true
 BreakBeforeBraces: Custom
 BraceWrapping:
   AfterEnum: true

examples/SampleAsyncProducer.cc

@@ -16,12 +16,12 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+#include <pulsar/Client.h>
+
 #include <iostream>
 #include <thread>
 
-#include <pulsar/Client.h>
-
-#include <lib/LogUtils.h>
+#include "lib/LogUtils.h"
 
 DECLARE_LOG_OBJECT()
 

examples/SampleConsumer.cc

@@ -16,11 +16,11 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-#include <iostream>
-
 #include <pulsar/Client.h>
 
-#include <lib/LogUtils.h>
+#include <iostream>
+
+#include "lib/LogUtils.h"
 
 DECLARE_LOG_OBJECT()
 

examples/SampleConsumerListener.cc

@@ -16,11 +16,11 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-#include <iostream>
-
 #include <pulsar/Client.h>
 
-#include <lib/LogUtils.h>
+#include <iostream>
+
+#include "lib/LogUtils.h"
 
 DECLARE_LOG_OBJECT()
 

examples/SampleProducer.cc

@@ -16,11 +16,11 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-#include <iostream>
-
 #include <pulsar/Client.h>
 
-#include <lib/LogUtils.h>
+#include <iostream>
+
+#include "lib/LogUtils.h"
 
 DECLARE_LOG_OBJECT()
 

include/pulsar/Authentication.h

@@ -19,13 +19,14 @@
 #ifndef PULSAR_AUTHENTICATION_H_
 #define PULSAR_AUTHENTICATION_H_
 
+#include <pulsar/Result.h>
 #include <pulsar/defines.h>
-#include <vector>
-#include <string>
+
+#include <functional>
 #include <map>
 #include <memory>
-#include <pulsar/Result.h>
-#include <functional>
+#include <string>
+#include <vector>
 
 namespace pulsar {
 

include/pulsar/BatchReceivePolicy.h

@@ -20,6 +20,7 @@
 #define BATCH_RECEIVE_POLICY_HPP_
 
 #include <pulsar/defines.h>
+
 #include <memory>
 
 namespace pulsar {

include/pulsar/BrokerConsumerStats.h

@@ -19,13 +19,13 @@
 #ifndef PULSAR_CPP_BROKERCONSUMERSTATS_H
 #define PULSAR_CPP_BROKERCONSUMERSTATS_H
 
-#include <pulsar/defines.h>
-#include <string.h>
-#include <iostream>
+#include <pulsar/ConsumerType.h>
 #include <pulsar/Result.h>
+#include <pulsar/defines.h>
+
 #include <functional>
+#include <iostream>
 #include <memory>
-#include <pulsar/ConsumerType.h>
 
 namespace pulsar {
 class BrokerConsumerStatsImplBase;

include/pulsar/Client.h

@@ -19,17 +19,18 @@
 #ifndef PULSAR_CLIENT_HPP_
 #define PULSAR_CLIENT_HPP_
 
-#include <pulsar/defines.h>
+#include <pulsar/ClientConfiguration.h>
+#include <pulsar/ConsoleLoggerFactory.h>
 #include <pulsar/Consumer.h>
+#include <pulsar/FileLoggerFactory.h>
+#include <pulsar/Message.h>
+#include <pulsar/MessageBuilder.h>
 #include <pulsar/Producer.h>
 #include <pulsar/Reader.h>
 #include <pulsar/Result.h>
-#include <pulsar/Message.h>
-#include <pulsar/MessageBuilder.h>
-#include <pulsar/ClientConfiguration.h>
 #include <pulsar/Schema.h>
-#include <pulsar/ConsoleLoggerFactory.h>
-#include <pulsar/FileLoggerFactory.h>
+#include <pulsar/defines.h>
+
 #include <string>
 
 namespace pulsar {

include/pulsar/ClientConfiguration.h

@@ -19,9 +19,9 @@
 #ifndef PULSAR_CLIENTCONFIGURATION_H_
 #define PULSAR_CLIENTCONFIGURATION_H_
 
-#include <pulsar/defines.h>
 #include <pulsar/Authentication.h>
 #include <pulsar/Logger.h>
+#include <pulsar/defines.h>
 
 namespace pulsar {
 class PulsarWrapper;

include/pulsar/Consumer.h

@@ -19,10 +19,11 @@
 #ifndef CONSUMER_HPP_
 #define CONSUMER_HPP_
 
-#include <iostream>
-#include <pulsar/defines.h>
 #include <pulsar/BrokerConsumerStats.h>
 #include <pulsar/ConsumerConfiguration.h>
+#include <pulsar/defines.h>
+
+#include <iostream>
 
 namespace pulsar {
 class PulsarWrapper;

include/pulsar/ConsumerConfiguration.h

@@ -19,18 +19,20 @@
 #ifndef PULSAR_CONSUMERCONFIGURATION_H_
 #define PULSAR_CONSUMERCONFIGURATION_H_
 
-#include <functional>
-#include <memory>
-#include <pulsar/defines.h>
-#include <pulsar/Result.h>
-#include <pulsar/ConsumerType.h>
-#include <pulsar/Message.h>
-#include <pulsar/Schema.h>
 #include <pulsar/ConsumerCryptoFailureAction.h>
+#include <pulsar/ConsumerEventListener.h>
+#include <pulsar/ConsumerType.h>
 #include <pulsar/CryptoKeyReader.h>
 #include <pulsar/InitialPosition.h>
 #include <pulsar/KeySharedPolicy.h>
-#include <pulsar/ConsumerEventListener.h>
+#include <pulsar/Message.h>
+#include <pulsar/Result.h>
+#include <pulsar/Schema.h>
+#include <pulsar/defines.h>
+
+#include <functional>
+#include <memory>
+
 #include "BatchReceivePolicy.h"
 
 namespace pulsar {

include/pulsar/CryptoKeyReader.h

@@ -19,9 +19,9 @@
 #ifndef CRYPTOKEYREADER_H_
 #define CRYPTOKEYREADER_H_
 
-#include <pulsar/defines.h>
-#include <pulsar/Result.h>
 #include <pulsar/EncryptionKeyInfo.h>
+#include <pulsar/Result.h>
+#include <pulsar/defines.h>
 
 namespace pulsar {
 

include/pulsar/DeprecatedException.h

@@ -19,9 +19,10 @@
 #ifndef DEPRECATED_EXCEPTION_HPP_
 #define DEPRECATED_EXCEPTION_HPP_
 
+#include <pulsar/defines.h>
+
 #include <stdexcept>
 #include <string>
-#include <pulsar/defines.h>
 
 namespace pulsar {
 class PULSAR_PUBLIC DeprecatedException : public std::runtime_error {

include/pulsar/EncryptionKeyInfo.h

@@ -19,10 +19,11 @@
 #ifndef ENCRYPTIONKEYINFO_H_
 #define ENCRYPTIONKEYINFO_H_
 
-#include <memory>
+#include <pulsar/defines.h>
+
 #include <iostream>
 #include <map>
-#include <pulsar/defines.h>
+#include <memory>
 
 namespace pulsar {
 

include/pulsar/KeySharedPolicy.h

@@ -21,7 +21,6 @@
 #include <pulsar/defines.h>
 
 #include <memory>
-
 #include <utility>
 #include <vector>
 

include/pulsar/Logger.h

@@ -18,9 +18,10 @@
  */
 #pragma once
 
+#include <pulsar/defines.h>
+
 #include <memory>
 #include <string>
-#include <pulsar/defines.h>
 
 namespace pulsar {
 

include/pulsar/Message.h

@@ -19,12 +19,12 @@
 #ifndef MESSAGE_HPP_
 #define MESSAGE_HPP_
 
-#include <map>
-#include <string>
+#include <pulsar/defines.h>
 
+#include <map>
 #include <memory>
+#include <string>
 
-#include <pulsar/defines.h>
 #include "MessageId.h"
 
 namespace pulsar {

include/pulsar/MessageBatch.h

@@ -19,10 +19,10 @@
 
 #ifndef LIB_MESSAGE_BATCH_H
 #define LIB_MESSAGE_BATCH_H
-#include <vector>
-
-#include <pulsar/defines.h>
 #include <pulsar/Message.h>
+#include <pulsar/defines.h>
+
+#include <vector>
 
 namespace pulsar {
 

include/pulsar/MessageBuilder.h

@@ -19,13 +19,13 @@
 #ifndef MESSAGE_BUILDER_H
 #define MESSAGE_BUILDER_H
 
+#include <pulsar/Message.h>
+#include <pulsar/defines.h>
+
 #include <chrono>
 #include <string>
 #include <vector>
 
-#include <pulsar/Message.h>
-#include <pulsar/defines.h>
-
 namespace pulsar {
 class PulsarWrapper;
 

include/pulsar/MessageId.h

@@ -19,11 +19,12 @@
 #ifndef MESSAGE_ID_H
 #define MESSAGE_ID_H
 
-#include <iosfwd>
+#include <pulsar/defines.h>
 #include <stdint.h>
+
+#include <iosfwd>
 #include <memory>
 #include <string>
-#include <pulsar/defines.h>
 
 namespace pulsar {
 

include/pulsar/MessageRoutingPolicy.h

@@ -19,10 +19,11 @@
 #ifndef PULSAR_MESSAGE_ROUTING_POLICY_HEADER_
 #define PULSAR_MESSAGE_ROUTING_POLICY_HEADER_
 
-#include <pulsar/defines.h>
 #include <pulsar/DeprecatedException.h>
 #include <pulsar/Message.h>
 #include <pulsar/TopicMetadata.h>
+#include <pulsar/defines.h>
+
 #include <memory>
 
 /*

include/pulsar/Producer.h

@@ -19,11 +19,12 @@
 #ifndef PRODUCER_HPP_
 #define PRODUCER_HPP_
 
-#include <pulsar/defines.h>
 #include <pulsar/ProducerConfiguration.h>
-#include <memory>
+#include <pulsar/defines.h>
 #include <stdint.h>
 
+#include <memory>
+
 namespace pulsar {
 class ProducerImplBase;
 class PulsarWrapper;

include/pulsar/ProducerConfiguration.h

@@ -18,16 +18,16 @@
  */
 #ifndef PULSAR_PRODUCERCONFIGURATION_H_
 #define PULSAR_PRODUCERCONFIGURATION_H_
-#include <pulsar/defines.h>
 #include <pulsar/CompressionType.h>
-#include <pulsar/MessageRoutingPolicy.h>
-#include <pulsar/Result.h>
+#include <pulsar/CryptoKeyReader.h>
 #include <pulsar/Message.h>
-#include <functional>
+#include <pulsar/MessageRoutingPolicy.h>
 #include <pulsar/ProducerCryptoFailureAction.h>
-#include <pulsar/CryptoKeyReader.h>
+#include <pulsar/Result.h>
 #include <pulsar/Schema.h>
+#include <pulsar/defines.h>
 
+#include <functional>
 #include <set>
 
 namespace pulsar {

include/pulsar/ProtobufNativeSchema.h

@@ -18,8 +18,8 @@
  */
 #pragma once
 
-#include <pulsar/Schema.h>
 #include <google/protobuf/descriptor.h>
+#include <pulsar/Schema.h>
 
 namespace pulsar {
 

include/pulsar/Reader.h

@@ -19,9 +19,9 @@
 #ifndef PULSAR_READER_HPP_
 #define PULSAR_READER_HPP_
 
-#include <pulsar/defines.h>
 #include <pulsar/Message.h>
 #include <pulsar/ReaderConfiguration.h>
+#include <pulsar/defines.h>
 
 namespace pulsar {
 class PulsarWrapper;