Implemented message sink block for unit testing

9 files changed, 230 insertions, 6 deletions

diff --git a/grc/gsm_block_tree.xml b/grc/gsm_block_tree.xml
index 5837ce2..2864e4d 100644
--- a/grc/gsm_block_tree.xml
+++ b/grc/gsm_block_tree.xml
@@ -52,6 +52,7 @@
       <block>gsm_clock_offset_corrector</block>
       <block>gsm_tmsi_dumper</block>
       <block>gsm_message_source</block>
+      <block>gsm_message_sink</block>
     </cat>
   </cat>
 </cat>
diff --git a/grc/misc_utils/CMakeLists.txt b/grc/misc_utils/CMakeLists.txt
index 403a321..5dd4c1b 100644
--- a/grc/misc_utils/CMakeLists.txt
+++ b/grc/misc_utils/CMakeLists.txt
@@ -29,6 +29,7 @@ install(FILES
     gsm_burst_sink.xml
     gsm_burst_source.xml
     gsm_burst_source_qa.xml
-    gsm_burst_sink_qa.xml 
-    gsm_message_source.xml DESTINATION share/gnuradio/grc/blocks
+    gsm_burst_sink_qa.xml
+    gsm_message_source.xml
+    gsm_message_sink.xml DESTINATION share/gnuradio/grc/blocks
 )
diff --git a/grc/misc_utils/gsm_message_sink.xml b/grc/misc_utils/gsm_message_sink.xml
new file mode 100644
index 0000000..e0d6ac0
--- /dev/null
+++ b/grc/misc_utils/gsm_message_sink.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<block>
+  <name>Message Sink</name>
+  <key>gsm_message_sink</key>
+  <import>import grgsm</import>
+  <make>grgsm.message_sink()</make>
+
+  <sink>
+    <name>in</name>
+    <type>message</type>
+  </sink>
+  
+  <doc>
+This block is a message sink for testing purposes.
+
+The data can be retrieved using function get_messages()
+
+  </doc>
+</block>
diff --git a/include/grgsm/misc_utils/CMakeLists.txt b/include/grgsm/misc_utils/CMakeLists.txt
index 000b7ef..18c2860 100644
--- a/include/grgsm/misc_utils/CMakeLists.txt
+++ b/include/grgsm/misc_utils/CMakeLists.txt
@@ -30,7 +30,8 @@ install(FILES
     extract_immediate_assignment.h
     controlled_rotator_cc.h
     controlled_const_source_f.h
-    message_printer.h 
-    tmsi_dumper.h 
-    message_source.h DESTINATION include/grgsm/misc_utils
+    message_printer.h
+    tmsi_dumper.h
+    message_source.h
+    message_sink.h DESTINATION include/grgsm/misc_utils
 )
diff --git a/include/grgsm/misc_utils/message_sink.h b/include/grgsm/misc_utils/message_sink.h
new file mode 100644
index 0000000..5cfe2f7
--- /dev/null
+++ b/include/grgsm/misc_utils/message_sink.h
@@ -0,0 +1,60 @@
+/* -*- c++ -*- */
+/* @file
+ * @author Roman Khassraf <rkhassraf@gmail.com>
+ * @section LICENSE
+ * 
+ * Gr-gsm is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ * 
+ * Gr-gsm is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with gr-gsm; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ * 
+ */
+
+
+#ifndef INCLUDED_GSM_MESSAGE_SINK_H
+#define INCLUDED_GSM_MESSAGE_SINK_H
+
+#include <grgsm/api.h>
+#include <gnuradio/block.h>
+
+namespace gr {
+  namespace gsm {
+
+    /*!
+     * \brief <+description of block+>
+     * \ingroup gsm
+     *
+     */
+    class GSM_API message_sink : virtual public gr::block
+    {
+     public:
+      typedef boost::shared_ptr<message_sink> sptr;
+
+      /*!
+       * \brief Return a shared_ptr to a new instance of grgsm::message_sink.
+       *
+       * To avoid accidental use of raw pointers, grgsm::message_sink's
+       * constructor is in a private implementation
+       * class. grgsm::message_sink::make is the public interface for
+       * creating new instances.
+       */
+      static sptr make();
+      
+      virtual std::vector<std::string> get_messages() = 0;
+    };
+
+  } // namespace gsm
+} // namespace gr
+
+#endif /* INCLUDED_GSM_MESSAGE_SINK_H */
+
diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt
index d66de3d..07b616e 100644
--- a/lib/CMakeLists.txt
+++ b/lib/CMakeLists.txt
@@ -54,7 +54,8 @@ list(APPEND grgsm_sources
     misc_utils/burst_source_impl.cc
     misc_utils/burst_sink_qa_impl.cc
     misc_utils/burst_source_qa_impl.cc
-    misc_utils/message_source_impl.cc 
+    misc_utils/message_source_impl.cc
+    misc_utils/message_sink_impl.cc
     decryption/decryption_impl.cc)
 
 add_library(gnuradio-grgsm SHARED ${grgsm_sources})
diff --git a/lib/misc_utils/message_sink_impl.cc b/lib/misc_utils/message_sink_impl.cc
new file mode 100644
index 0000000..269cada
--- /dev/null
+++ b/lib/misc_utils/message_sink_impl.cc
@@ -0,0 +1,90 @@
+/* -*- c++ -*- */
+/* @file
+ * @author Roman Khassraf <rkhassraf@gmail.com>
+ * @section LICENSE
+ *
+ * Gr-gsm is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ *
+ * Gr-gsm is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with gr-gsm; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ *
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <gnuradio/io_signature.h>
+#include "message_sink_impl.h"
+#include <stdio.h>
+#include <sstream>
+
+namespace gr {
+  namespace gsm {
+
+    message_sink::sptr
+    message_sink::make()
+    {
+      return gnuradio::get_initial_sptr
+        (new message_sink_impl());
+    }
+
+    /*
+     * The private constructor
+     */
+    message_sink_impl::message_sink_impl()
+      : gr::block("message_sink",
+              gr::io_signature::make(0, 0, 0),
+              gr::io_signature::make(0, 0, 0))
+    {
+        message_port_register_in(pmt::mp("in"));
+        set_msg_handler(pmt::mp("in"), boost::bind(&message_sink_impl::process_message, this, _1));
+    }
+
+    /*
+     * Our virtual destructor.
+     */
+    message_sink_impl::~message_sink_impl()
+    {
+        for (int i=0; i<d_messages.size(); i++)
+        {
+            std::cout << d_messages[i].c_str() << std::endl;
+        }
+    }
+
+    void message_sink_impl::process_message(pmt::pmt_t msg)
+    {
+        pmt::pmt_t message_plus_header_blob = pmt::cdr(msg);
+        uint8_t * message_plus_header = (uint8_t *)pmt::blob_data(message_plus_header_blob);
+        size_t message_plus_header_len = pmt::blob_length(message_plus_header_blob);
+
+        std::stringstream s_msg_stream;
+        for (int i=0; i<message_plus_header_len; i++)
+        {
+            if (i>0)
+            {
+                s_msg_stream << (" ");
+            }
+            s_msg_stream << std::hex << std::setw(2) << std::setfill('0') << (unsigned)message_plus_header[i];
+        }
+        d_messages.push_back(s_msg_stream.str());
+    }
+
+    std::vector<std::string> message_sink_impl::get_messages()
+    {
+        return d_messages;
+    }
+
+  } /* namespace gsm */
+} /* namespace gr */
+
diff --git a/lib/misc_utils/message_sink_impl.h b/lib/misc_utils/message_sink_impl.h
new file mode 100644
index 0000000..c1fa43c
--- /dev/null
+++ b/lib/misc_utils/message_sink_impl.h
@@ -0,0 +1,47 @@
+/* -*- c++ -*- */
+/* @file
+ * @author Roman Khassraf <rkhassraf@gmail.com>
+ * @section LICENSE
+ *
+ * Gr-gsm is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ *
+ * Gr-gsm is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with gr-gsm; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ *
+ */
+
+#ifndef INCLUDED_GSM_MESSAGE_SINK_IMPL_H
+#define INCLUDED_GSM_MESSAGE_SINK_IMPL_H
+
+#include <grgsm/misc_utils/message_sink.h>
+
+namespace gr {
+  namespace gsm {
+
+    class message_sink_impl : public message_sink
+    {
+     private:
+      std::vector<std::string> d_messages;
+
+     public:
+      message_sink_impl();
+      ~message_sink_impl();
+      void process_message(pmt::pmt_t msg);
+      virtual std::vector<std::string> get_messages();
+    };
+
+  } // namespace gsm
+} // namespace gr
+
+#endif /* INCLUDED_GSM_MESSAGE_SINK_IMPL_H */
+
diff --git a/swig/grgsm_swig.i b/swig/grgsm_swig.i
index 6189fee..5b7f458 100644
--- a/swig/grgsm_swig.i
+++ b/swig/grgsm_swig.i
@@ -28,6 +28,7 @@
 #include "grgsm/misc_utils/burst_source.h"
 #include "grgsm/misc_utils/burst_source_qa.h"
 #include "grgsm/misc_utils/message_source.h"
+#include "grgsm/misc_utils/message_sink.h"
 %}
 
 
@@ -75,3 +76,6 @@ GR_SWIG_BLOCK_MAGIC2(gsm, message_printer);
 GR_SWIG_BLOCK_MAGIC2(gsm, tmsi_dumper);
 %include "grgsm/misc_utils/message_source.h"
 GR_SWIG_BLOCK_MAGIC2(gsm, message_source);
+%include "grgsm/misc_utils/message_sink.h"
+GR_SWIG_BLOCK_MAGIC2(gsm, message_sink);
+