Opentracing-cpp Redux

.clang-format

@@ -0,0 +1,46 @@
+---
+Language     : Cpp
+BasedOnStyle : Google
+AccessModifierOffset: -2
+AlignConsecutiveAssignments: true
+AlignConsecutiveDeclarations: true
+AlignOperands: true
+AllowShortIfStatementsOnASingleLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortFunctionsOnASingleLine: false
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakAfterDefinitionReturnType: true
+AlwaysBreakAfterReturnType: None
+BinPackArguments: false
+BinPackParameters: false
+BreakConstructorInitializersBeforeComma: true
+BraceWrapping:
+    AfterClass: false
+    AfterControlStatement: true
+    AfterEnum: true
+    AfterFunction: true
+    AfterNamespace: false
+    AfterObjCDeclaration: false
+    AfterStruct: false
+    AfterUnion: false
+    BeforeCatch: true
+    BeforeElse: true
+    IndentBraces: false
+BreakBeforeBraces: Custom
+
+ColumnLimit: 80
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 0
+IndentCaseLabels: true
+IndentWidth: 4
+MaxEmptyLinesToKeep: 1
+PointerAlignment: Left
+SpaceAfterCStyleCast: true
+SpaceBeforeParens: ControlStatements
+SpacesInContainerLiterals: true
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard: Cpp03
+TabWidth: 4
+UseTab: Never
+...

.gitignore

@@ -0,0 +1,26 @@
+*.o
+*.a
+*.so
+config.h
+config.h.in
+*.m4
+Makefile
+Makefile.in
+config.*
+*/.deps/*
+stamp-h1
+*/.dirstamp
+INSTALL
+autom4te.cache/*
+compile
+configure
+depcomp
+install-sh
+libtool
+ltmain.sh
+missing
+CMakeFiles
+*.cmake
+bin/
+build/
+test/unittest

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "thirdparty/googletest"]
+	path = thirdparty/googletest
+	url = https://github.com/google/googletest

AUTHORS

@@ -1,6 +1,7 @@
 AUTHORS
 -------
-
-
 OpenTracing Developers
 
+Dmitrios Kouzis-Loukas : dkouzislouka AT bloomberg DOT net
+James Wells            : jwells31 AT bloomberg DOT net
+Jim Quinn              : jquinn47 AT bloomberg DOT net

CMakeLists.txt

@@ -0,0 +1,22 @@
+cmake_minimum_required (VERSION 2.8)
+set(PROJECT_NAME "opentracing")
+project (${PROJECT_NAME})
+
+set(lib_major_version "2")
+set(lib_minor_version "0")
+set(lib_patch_version "0")
+set(opentracing_version "${lib_major_version}.${lib_minor_version}.${lib_patch_version}")
+set(opentracing_url "https://github.com/opentracing/opentracing-cpp")
+
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+
+option(enable_noop "Build noop tracer." OFF)
+option(enable_tests "Build unit tests." OFF)
+
+add_subdirectory(opentracing)
+
+if(enable_tests)
+    enable_testing()
+    add_subdirectory(thirdparty/googletest/googletest)
+    add_subdirectory(test)
+endif()

ChangeLog

@@ -1,4 +1,46 @@
-
-opentracing-cpp ChangeLog
-
-* initial release
+f18e949 (HEAD -> master, jq/cmake-fun) Remove default contructors and handle side effects
+29e1285 Remove cmake makefile
+a83c752 Merge branch 'master' of https://bbgithub.dev.bloomberg.com/jquinn1/opentracing-cpp
+963d016 Cmake, removing unused template functionality, ditching config.h for now
+1120bb0 (jq/master) Merge pull request #3 from jquinn1/noop-shift
+bde3545 Clean up build system, ability to turn off no-op, integrate tests
+ef885ee (jq/noop-shift) Update reqs for tracerimps
+88e1e8b Merge branch 'master' of https://bbgithub.dev.bloomberg.com/jquinn1/opentracing-cpp
+a8b9017 Moving noop into its own package, updated tests
+5e3885a Merge pull request #2 from jquinn1/changes
+5ff6015 (jq/changes) Review feedback, removing guards, updated docs
+eeb6fa3 typo
+05f3bf3 Example compiler problem
+b5e5486 Update examples
+9f1daca formatting never ends
+8f1025e formatting never ends
+59e565f formatting
+1f77d05 formatting
+63ff455 Updating docs
+9656c0b Adding iterator behaviors
+3b86ccf Adding log/tags/baggage usage
+d35931b Update usage
+47a9047 Adding constants.h
+c8d422c Adding guards, updating documentation and tests
+d42770a Updating documentation
+419580e Updating tests, adding spanoptions, consistently documented
+1ee01dc Minor formatting
+94227b4 Adding No-op implementation
+b45a540 Adding noop, Baggage/BaggageWide, StringRefWide, and docs
+2f37155 Solving the wide baggage problem
+06ff151 Some documentation, StringRefWide
+70d1545 Remove bad example
+3381ca1 Testing everything, at least a little
+ded4c0c StringRef, BaggageRef, BaggageIterator drafted
+efadeda (origin/master, origin/HEAD) keep gcc specific flags specific to a gcc build (#5)
+012743c Update configure.ac
+3933120 Update configure.ac
+6623183 Update ChangeLog
+e1c9ea6 Update AUTHORS
+7fecd71 a clarification (#4)
+e0ea9eb Converting TextMapReader callback to functor (#2)
+8b1efd1 Initial opentracing C++ version
+368f2cd Merge pull request #1 from gitter-badger/gitter-badge
+574ef91 Add Gitter badge
+9ec9136 Update README.md
+bfb0b74 Initial commit

README.md

@@ -3,35 +3,57 @@ C++ implementation of the OpenTracing API http://opentracing.io
 
 [![Join the chat at https://gitter.im/opentracing/opentracing-cpp](https://badges.gitter.im/opentracing/opentracing-cpp.svg)](https://gitter.im/opentracing/opentracing-cpp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
+
 ## Required Reading
 
-In order to understand the C++ platform API, one must first be familiar with the
-[OpenTracing project](http://opentracing.io) and
-[terminology](http://opentracing.io/spec/) more generally. This is a C++98 API that
-is used as a "common denominator". Ît's up to implementors to choose the C++ level
-they are going to use for their implementations:
+In order to understand the C++ platform API, one must first be familiar with the [OpenTracing project](http://opentracing.io) and
+[terminology](http://opentracing.io/spec/) more generally. This is a C++98 API that is used as a "common denominator".
+Ît is up to implementors to choose the C++ level they are going to use for their implementations:
 
 ![stack of libraries](img/stack-of-libraries.png "Stack of Libraries")
 
 ## Compile and install
 
+The default package is a header-only library. It can be installed as such
+
 ```
-libtoolize # or glibtoolize
-./autogen.sh
-./configure
-sudo make install
+mkdir build
+cd build
+cmake ..
+make install
 ```
 
-To test (requires gtest - see [here for OS X](http://stackoverflow.com/questions/20746232/how-to-properly-setup-googletest-on-os-x-aside-from-xcode), [here for ubuntu](http://www.eriksmistad.no/getting-started-with-google-test-on-ubuntu/) and [here for Red Hat](http://stackoverflow.com/questions/13513905/how-to-setup-googletest-as-a-shared-library-on-linux)/for Red Hat note also [this](http://stackoverflow.com/questions/4743233/is-usr-local-lib-searched-for-shared-libraries)):
+If you would like to include the NoopTracer, a static library is created in addition to the headers.
 
 ```
-cd test
+mkdir build
+cd build
+cmake -Denable_noop=ON ..
+make install
+```
+
+#### Tests
+
+Testing requires the use of `gtest`. The `gtest` library is added as a submodule to this repository.
+To build all of the tests, from the root repository:
+
+```
+git submodule init
+git submodule update
+mkdir build
+cd build
+cmake -Denable_tests=ON ..
 make
-./test
+./bin/unittest
 ```
 
+If you're using the `NoopTracer`, you would want to add `-Denable_noop=ON` as well.
+
 ## API overview for those adding instrumentation
 
-Everyday consumers of this `opentracing` package really only need to worry
-about a couple of key abstractions: the `StartSpan` function, the `Span`
-interface, and binding a `Tracer` at `main()`-time.
+Clients of this `OpenTracing` only need to understand the key abstractions:
+    * Installing a Tracer
+    * Using the Global `Tracer` to create `Spans` and `SpanContexts`
+    * Adding tags, logs, or baggage to `Spans`
+
+See the detailed [usage](./docs/usage.md) documentation for details.