Merged hei_macros.hpp and hei_includes.hpp
Change-Id: Ieaddde93b376066bd7e7e970c15fcb6700c449ad
Signed-off-by: Zane Shelley <zshelle@us.ibm.com>
diff --git a/src/chip_data/hei_chip_data_stream.hpp b/src/chip_data/hei_chip_data_stream.hpp
index e9cfc75..c9cbde7 100644
--- a/src/chip_data/hei_chip_data_stream.hpp
+++ b/src/chip_data/hei_chip_data_stream.hpp
@@ -4,7 +4,6 @@
#include <string.h>
#include <hei_includes.hpp>
-#include <hei_macros.hpp>
namespace libhei
{
diff --git a/src/hei_includes.hpp b/src/hei_includes.hpp
index 61791f4..40bdfc7 100644
--- a/src/hei_includes.hpp
+++ b/src/hei_includes.hpp
@@ -1,18 +1,33 @@
#pragma once
-/**
- * @file hei_includes.hpp
- * @brief The purpose of this file is to include common headers that will be
- * used throughout this library.
- */
+// The purpose of this file is to include common headers that will be used
+// internally throughout this library. It is advised not to include this in any
+// headers that are installed externally to avoid ballooning the number of
+// headers that are externally exposed.
// Standard library includes
+#include <assert.h>
+#include <inttypes.h>
#include <stdint.h>
#include <stdlib.h>
#include <map>
#include <vector>
-// Internal includes
+// Library includes
#include <hei_chip.hpp>
#include <hei_types.hpp>
+#include <hei_user_interface.hpp>
+
+// Common macros used throughout this library
+#define HEI_ASSERT(expression) assert(expression);
+
+#define HEI_ERR(...) \
+ { \
+ libhei::hei_err((char*)__VA_ARGS__); \
+ }
+
+#define HEI_INF(...) \
+ { \
+ libhei::hei_inf((char*)__VA_ARGS__); \
+ }
diff --git a/src/hei_macros.hpp b/src/hei_macros.hpp
deleted file mode 100644
index cada4d7..0000000
--- a/src/hei_macros.hpp
+++ /dev/null
@@ -1,20 +0,0 @@
-#pragma once
-
-#include <assert.h>
-#include <inttypes.h> // for PRIu64
-
-#include <hei_user_interface.hpp>
-
-/** @brief Common defines used throughout this library */
-
-#define HEI_INF(...) \
- { \
- libhei::hei_inf((char*)__VA_ARGS__); \
- }
-
-#define HEI_ERR(...) \
- { \
- libhei::hei_err((char*)__VA_ARGS__); \
- }
-
-#define HEI_ASSERT(expression) assert(expression);
diff --git a/src/isolator/hei_isolation_node.cpp b/src/isolator/hei_isolation_node.cpp
index 7f8422a..e2bf61a 100644
--- a/src/isolator/hei_isolation_node.cpp
+++ b/src/isolator/hei_isolation_node.cpp
@@ -1,4 +1,3 @@
-#include <hei_macros.hpp>
#include <isolator/hei_isolation_node.hpp>
namespace libhei
diff --git a/src/register/hei_hardware_register.hpp b/src/register/hei_hardware_register.hpp
index cc3cf76..2a4dcfe 100644
--- a/src/register/hei_hardware_register.hpp
+++ b/src/register/hei_hardware_register.hpp
@@ -1,7 +1,6 @@
#pragma once
#include <hei_includes.hpp>
-#include <hei_macros.hpp>
#include <register/hei_register.hpp>
#include <util/hei_bit_string.hpp>
diff --git a/src/util/hei_bit_string.cpp b/src/util/hei_bit_string.cpp
index 2795cf1..9cc2613 100644
--- a/src/util/hei_bit_string.cpp
+++ b/src/util/hei_bit_string.cpp
@@ -2,7 +2,7 @@
* @brief BitString and BitStringBuffer class definitions
*/
-#include <hei_macros.hpp>
+#include <hei_includes.hpp>
#include <util/hei_bit_string.hpp>
#include <algorithm>