Install (#31)

Add `make install` `make uninstall` and `make check-install` features. `check-install` compiles, links, and runs the `example/decode` program. This ensures the headers and library are installed correctly. Moved `include/ict` into `include/xenon/ict`. Signed-off-by: Mark Beckwith <wythe@intrig.com>
intrig · Aug 28, 2019 · 0e25bb9 · 0e25bb9
1 parent cd4097a
commit 0e25bb9
Show file tree

Hide file tree

Showing 47 changed files with 128 additions and 157 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,3 @@
 [submodule "include/ict"]
-	path = include/ict
+	path = include/xenon/ict
 	url = https://github.com/intrig/ict.git
diff --git a/.travis.yml b/.travis.yml
@@ -6,6 +6,8 @@ notifications:
     email: false
 compiler:
     - gcc
-
 os:
     -linux
+
+script:
+    - ./configure && make && make check && sudo make install && sudo ldconfig && make check-install
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-.PHONY: all clean realclean check test update get-deps
+.PHONY: all clean realclean check test update get-deps install uninstall check-install
 
 all: include/ict/ict.h build
 	ninja -C build
@@ -17,7 +17,17 @@ realclean:
 check: build
 	ninja -C build test
 
-test: check
+install: build
+	ninja -C build install
+
+uninstall:
+	ninja -C build uninstall
+
+check-install: build
+	XDDLPATH=/usr/local/share/xddl xv unit/xddlunit/icd_gold.xv
+	c++ -pipe -D_FILE_OFFSET_BITS=64 -Wall -Winvalid-pch -Wnon-virtual-dtor -std=c++17 -O3 -o 'build/decode.cpp.o' -c examples/decode.cpp
+	c++ -o build/decode 'build/decode.cpp.o' -lxenon
+	XDDLPATH=/usr/local/share/xddl build/decode
 
 tags:
 	@echo Making tags...

diff --git a/examples/decode.cpp b/examples/decode.cpp
@@ -1,58 +1,64 @@
-//-- Copyright 2016 Intrig
-//-- See https://github.com/intrig/xenon for license.
 #include <iostream>
 #include <vector>
 #include <xenon/xenon.h>
 
-using std::cout;
 using std::cerr;
+using std::cout;
 
 struct nv_pairs {
-    nv_pairs(const std::string & name, int64_t value) : name(name), value(value) {}
+    nv_pairs(const std::string &name, int64_t value)
+        : name(name), value(value) {}
     std::string name;
     int64_t value;
 };
 
-int main(int, char**) {
+int main(int, char **) {
     try {
         auto fields = std::vector<nv_pairs>();
 
         cout << "loading\n";
-        xenon::spec_server doc("~/wythe/xenon/xddl/icd.xddl");
+        xenon::spec_server doc("icd.xddl");
         cout << "assigning\n";
-        auto msg = xenon::parse(doc, "0101046B102C000114E03003603800203801C03801E03801F030037030002030"
-              "00903000603000E0300120300130380000300110300030380080300200300210"
-              "3001903001603000F03000703000403000C03000503000D1A03C9E16C18070DE"
-              "2C7CFF3C7CC1001E00E01C000389");
+        auto msg = xenon::parse(
+            doc,
+            "0101046B102C000114E03003603800203801C03801E03801F030037030002030"
+            "00903000603000E0300120300130380000300110300030380080300200300210"
+            "3001903001603000F03000703000403000C03000503000D1A03C9E16C18070DE"
+            "2C7CFF3C7CC1001E00E01C000389");
 
         cout << "iterating over top level nodes only\n";
         for (auto c = msg.begin(); c != msg.end(); ++c) {
             // and now we can process each node
             cout << c->name() << '\n';
         }
 
-        cout << "putting fields and their values into a vector: " << xenon::to_text(msg);
+        cout << "putting fields and their values into a vector: "
+             << xenon::to_text(msg);
 
-        // We can do this using the ict::recurse() algorithm that takes a root node and a lambda expression.  The first
-        // cursor parameter in the lambda expression is a cursor to the current node.
+        // We can do this using the ict::recurse() algorithm that takes a root
+        // node and a lambda expression.  The first cursor parameter in the
+        // lambda expression is a cursor to the current node.
         ict::recurse(msg.root(), [&](xenon::message::cursor c) {
-            if (c->consumes()) fields.emplace_back(c->name(), c->value());
+            if (c->consumes())
+                fields.emplace_back(c->name(), c->value());
         });
         cout << "done, processed " << fields.size() << " fields\n\n";
 
         cout << "now find a field: DATA/MSG_TYPE\n";
         auto c = xenon::find_first(msg, "DATA/MSG_TYPE");
 
-        if (c != msg.end()) cout << "found it! " << xenon::description(c) << "\n\n";
+        if (c != msg.end())
+            cout << "found it! " << xenon::description(c) << "\n\n";
 
         cout << "now find another\n";
-        c = xenon::find_first(msg.root(), "RLP_CAP_INFO_BLOCK/MAX_MS_NAK_ROUNDS_FWD");
+        c = xenon::find_first(msg.root(),
+                              "RLP_CAP_INFO_BLOCK/MAX_MS_NAK_ROUNDS_FWD");
         if (c != msg.end()) {
             cout << "found it! " << c->value() << "\n";
             cout << "full path is: " << xenon::path_string(c) << "\n\n";
         }
 
-    } catch (std::exception & e) { 
+    } catch (std::exception &e) {
         cerr << e.what() << '\n';
         return 1;
     }

diff --git a/examples/sibs.cpp b/examples/sibs.cpp
@@ -1,7 +1,7 @@
 //-- Copyright 2016 Intrig
 //-- See https://github.com/intrig/xenon for license.
 #include <iostream>
-#include <ict/command.h>
+#include <xenon/ict/command.h>
 #include <xenon/xenon.h>
 
 using std::cout;

diff --git a/include/xenon/DateTime.h b/include/xenon/DateTime.h
@@ -38,7 +38,7 @@
 #include <ctime>
 #include <iomanip>
 
-#include <ict/ict.h>
+#include "ict/ict.h"
 
 #ifdef _WIN32
 #define NOMINMAX

diff --git a/include/xenon/att_pair.h b/include/xenon/att_pair.h
@@ -2,7 +2,7 @@
 //-- Copyright 2016 Intrig
 //-- See https://github.com/intrig/xenon for license.
 #include <vector>
-#include <ict/string64.h>
+#include <xenon/ict/string64.h>
 
 namespace xenon {
 struct att_pair {

diff --git a/include/xenon/cpp_code.h b/include/xenon/cpp_code.h
@@ -1,7 +1,5 @@
 #pragma once
-//-- Copyright 2016 Intrig
-//-- See https://github.com/intrig/xenon for license.
-#include <ict/ict.h>
+#include "ict/ict.h"
 
 #include <string>
 #include <vector>

diff --git a/include/xenon/functions.h b/include/xenon/functions.h
@@ -1,7 +1,5 @@
 #pragma once
-//-- Copyright 2016 Intrig
-//-- See https://github.com/intrig/xenon for license.
-#include <ict/ict.h>
+#include "ict/ict.h"
 #include <vector>
 #include <string>
 

diff --git a/include/ict → include/xenon/ict b/include/ict → include/xenon/ict
diff --git a/include/xenon/meson.build b/include/xenon/meson.build
@@ -2,5 +2,38 @@ xddl_h = custom_target(
     'xddl_h',
     output : 'xddl.h',
     input : '../../src/xddl.xspx',
-    command : [xspx_exe, '-H', '@OUTPUT@', '-S', 'foo.cpp', '@INPUT@'])
+    command : [xspx_exe, '-H', '@OUTPUT@', '-S', 'foo.cpp', '@INPUT@'],
+    install : true,
+    install_dir : get_option('includedir') + '/xenon')
 
+install_headers(
+    'DateTime.h',
+    'att_pair.h',
+    'cloned_ptr.h',
+    'cpp_code.h',
+    'functions.h',
+    'message.h',
+    'node.h',
+    'recref.h',
+    'spec_server.h',
+    'xddl_code.h',
+    'xddl_head.h',
+    'xddl_parser.h',
+    'xddl_tail.h',
+    'xenon.h',
+    'ximsi.h',
+    'xml_parser.h',
+    'xml_parser_base.h',
+    install_dir : get_option('includedir') + '/xenon')
+
+install_headers(
+    'ict/bitstring.h',
+    'ict/command.h',
+    'ict/exception.h',
+    'ict/expr.h',
+    'ict/ict.h',
+    'ict/multivector.h',
+    'ict/netvar.h',
+    'ict/osstream.h',
+    'ict/string64.h',
+    install_dir : get_option('includedir') + '/xenon/ict')
diff --git a/include/xenon/message.h b/include/xenon/message.h
@@ -1,8 +1,5 @@
 #pragma once
-//-- Copyright 2016 Intrig
-//-- See https://github.com/intrig/xenon for license.
-// #include <ict/multivector.h>
-#include <ict/bitstring.h>
+#include "ict/bitstring.h"
 #include "xddl.h"
 #include <xenon/node.h>
 

diff --git a/include/xenon/node.h b/include/xenon/node.h
@@ -1,9 +1,7 @@
 #pragma once
-//-- Copyright 2016 Intrig
-//-- See https://github.com/intrig/xenon for license.
-#include <ict/bitstring.h>
-#include <ict/multivector.h>
-#include <ict/string64.h>
+#include "ict/bitstring.h"
+#include "ict/multivector.h"
+#include "ict/string64.h"
 #include <memory>
 #include <functional>
 #include <iostream>

diff --git a/include/xenon/recref.h b/include/xenon/recref.h
@@ -1,6 +1,5 @@
 #pragma once
-
-#include <ict/ict.h>
+#include "ict/ict.h"
 #include <string>
 
 namespace ict {

diff --git a/include/xenon/xddl_code.h b/include/xenon/xddl_code.h
@@ -2,7 +2,7 @@
 //-- Copyright 2016 Intrig
 //-- See https://github.com/intrig/xenon for license.
 #include <xenon/xml_parser_base.h>
-#include <ict/osstream.h>
+#include <xenon/ict/osstream.h>
 
 #include <stack>
 #include <map>

diff --git a/include/xenon/xddl_head.h b/include/xenon/xddl_head.h
@@ -1,11 +1,9 @@
 #pragma once
-//-- Copyright 2016 Intrig
-//-- See https://github.com/intrig/xenon for license.
-#include <ict/string64.h>
-#include <ict/ict.h>
-#include <ict/multivector.h>
+#include "ict/ict.h"
+#include "ict/string64.h"
+#include "ict/multivector.h"
 #include <string>
-#include <ict/expr.h>
+#include "ict/expr.h"
 #include <xenon/att_pair.h>
 #include <xenon/functions.h>
 #include <xenon/recref.h>

diff --git a/include/xenon/xenon.h b/include/xenon/xenon.h
@@ -1,12 +1,10 @@
 #pragma once
-//-- Copyright 2016 Intrig
-//-- See https://github.com/intrig/xenon for license.
 #include <random>
 #include <functional>
 #include <xenon/recref.h>
 #include <xenon/message.h>
 #include <xenon/spec_server.h>
-#include <ict/bitstring.h>
+#include "ict/bitstring.h"
 namespace xenon {
 inline ict::bitstring serialize(const message & m) {
     ict::obitstream bs;

diff --git a/include/xenon/ximsi.h b/include/xenon/ximsi.h
@@ -1,13 +1,10 @@
 #pragma once
-//-- Copyright 2016 Intrig
-//-- See https://github.com/intrig/xenon for license.
-
 #include <string.h>
 #include <iostream>
-#include <ict/bitstring.h>
-#include <ict/exception.h>
+#include "ict/bitstring.h"
+#include "ict/exception.h"
 #include <cstdint>
-#include <ict/netvar.h>
+#include "ict/netvar.h"
 
 namespace ict {
 namespace util {

diff --git a/include/xenon/xml_parser.h b/include/xenon/xml_parser.h
@@ -6,7 +6,7 @@
 
 #include <xenon/xml_parser_base.h>
 
-#include <ict/string64.h>
+#include <xenon/ict/string64.h>
 #include <xenon/att_pair.h>
 
 // TODO: rewrite XmlParserBase to be 

diff --git a/include/xenon/xml_parser_base.h b/include/xenon/xml_parser_base.h
@@ -1,7 +1,7 @@
 #pragma once
 //-- Copyright 2016 Intrig
 //-- See https://github.com/intrig/xenon for license.
-#include <ict/ict.h>
+#include "ict/ict.h"
 
 #include <string>
 #include <iostream>

diff --git a/meson.build b/meson.build
@@ -17,3 +17,8 @@ subdir('xddl')
 subdir('unit')
 subdir('examples')
 subdir('perf')
+
+install_subdir('xddl',
+    exclude_directories : ['logs', 'IP/logs'],
+    exclude_files : ['README.txt', '3GPP/36.331.asn', '3GPP/25.331.asn'],
+    install_dir : get_option('datadir'))
diff --git a/perf/decode.cpp b/perf/decode.cpp
@@ -4,7 +4,7 @@
 #include <vector>
 #include <xenon/xenon.h>
 #include <xenon/xddl_code.h>
-#include <ict/command.h>
+#include <xenon/ict/command.h>
 #include <boost/filesystem.hpp>
 
 namespace bf = boost::filesystem;

diff --git a/src/meson.build b/src/meson.build
@@ -8,4 +8,5 @@ xddl_cpp = custom_target(
 
 xenon_lib = library('xenon', 'lua-5.1.4/src/lua_all.cpp', 'xml_parser_base.cpp', 
     'message.cpp', 'xenon.cpp', xddl_h, xddl_cpp,
-    include_directories : [inc, lua_inc])
+    include_directories : [inc, lua_inc],
+    install : true)
diff --git a/src/xddl.xspx b/src/xddl.xspx
@@ -49,8 +49,8 @@
         #include &lt;xenon/xddl_head.h&gt;
         #include &lt;memory&gt;
         #include &lt;bitset&gt;
-        #include &lt;ict/multivector.h&gt;
-        #include &lt;ict/expr.h&gt;
+        #include &lt;xenon/ict/multivector.h&gt;
+        #include &lt;xenon/ict/expr.h&gt;
     </code>
 
     <!-- code segment at the bottom of header file. -->

diff --git a/src/xenon.cpp b/src/xenon.cpp
@@ -1,7 +1,7 @@
 //-- Copyright 2016 Intrig
 //-- See https://github.com/intrig/xenon for license.
 #include <algorithm>
-#include <ict/bitstring.h>
+#include <xenon/ict/bitstring.h>
 #include <xenon/xenon.h>
 #include <xenon/node.h>
 #include <xenon/xddl.h>

diff --git a/src/xml_parser_base.cpp b/src/xml_parser_base.cpp
@@ -1,9 +1,5 @@
-//-- Copyright 2016 Intrig
-//-- See https://github.com/intrig/xenon for license.
-
 #include <xenon/xml_parser_base.h>
-
-#include <ict/ict.h>
+#include <xenon/ict/ict.h>
 
 namespace xenon {
 // order matters here, index is state()

diff --git a/tools/asnstrip.cpp b/tools/asnstrip.cpp
@@ -5,7 +5,7 @@
 #include <algorithm>
 #include <vector>
 
-#include <ict/command.h>
+#include <xenon/ict/command.h>
 #include <xenon/xddl_code.h>
 
 

diff --git a/tools/asnx/asn1.ypp b/tools/asnx/asn1.ypp
@@ -7,7 +7,7 @@
 #include <iostream>
 #include <fstream>
 #include "asnast.h"
-#include <ict/command.h>
+#include <xenon/ict/command.h>
 #include <cstdio>
 
 using namespace std;

diff --git a/tools/asnx/asnast.cpp b/tools/asnx/asnast.cpp
@@ -1,7 +1,7 @@
 //-- Copyright 2016 Intrig
 //-- See https://github.com/intrig/xenon for license.
 #include "asnast.h"
-#include <ict/ict.h>
+#include <xenon/ict/ict.h>
 
 using namespace std;