.gitignore

 .DS_Store
-*/generatedsrc
-*/build
-*/lib
-*/test/lib
-*/test/report
-*/dist
-*/privateprops
-*/.project
-*/.classpath
+generatedsrc
+build
+docs/doxygen_generated
+lib
+test/lib
+report
+dist
+deps
+privateprops
+.project
+.classpath
+.setting
+.settings
+.pydevproject
 *.pyc
-**/.*.swp
-.*.sw[a-z]
+*.swp
+*.sw[a-z]
 *.un~
 Session.vim
-
+manifest.mf
+*.*~

.gitlab-ci.yml

+stages:
+  - deploy
+
+conda-build-job:
+  stage: deploy
+  image: dominikbattefeld/miniconda3-build:conda-22.9.0
+  # Some information for debugging
+  before_script:
+    - conda --version
+    - conda list
+
+  # The actual call to build the package
+  script:
+    - conda build conda.recipe/
+
+  # The path of job artifacts has to be relative to and be a child of our project directory.
+  # Thus, to upload our package as job artifact, we need to copy the output of conda build to our working directory.
+  after_script:
+    - cp -r /opt/conda/conda-bld conda-build-output
+  artifacts:
+    paths:
+      - conda-build-output/*
+

DEPS.txt

+REQUIRED=""
+OPTIONAL=""
+

LICENSE.txt

+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

+# IPAACA
+
+This repository contains the software library IPAACA developed by the Social Cognitive Systems Group at Bielefeld University. IPAACA stands for 'Incremental Processing Architecture for Artificial Conversational Agents.' The library is available in three languages: Python (Python3 compatible), C++, and Java, and for three operating systems: Linux, OS X, and Windows.
+
+## Build dependencies 
+
+### Linux
+Dependencies: Protocol Buffer (libprotobuf), Transport Protocol (**libmosquittopp**, ros, librsb)
+
+sudo apt-get install libprotobuf-dev
+
+sudo apt-get install libprotoc-dev
+
+sudo apt-get install protobuf-compiler
+
+sudo apt-get install mosquitto libmosquittopp-dev
+
+## Build/Install instructions 
+
+### Linux
+**Compiling C++ Version** 
+
+cd ipaaca/ipaacalib/cpp
+
+mkdir build
+
+cd build
+
+cmake ..
+
+make
+
+sudo make install
+
+**Installing Python Version**
+
+cd ipaaca/ipaacalib/python
+
+python3 setup.py install --user
+
+### OS X
+
+### Windows
+
+## Usage
+
+**Python:** import ipaaca
+
+**C++:** #include "ipaaca/ipaaca.h"
+
+## History
+
+
+## Credits
+Hendrik Buschmeier <hbuschme@techfak.uni-bielefeld.de> 
+
+Ramin Yaghoubzadeh <ryaghoub@techfak.uni-bielefeld.de>
+
+## License
+GNU LESSER GENERAL PUBLIC LICENSE (See LICENSE.txt in the repository)
+
+## Further Reading
+[1] IPAACA: https://scs.techfak.uni-bielefeld.de/wiki/public/ipaaca/start
+
+[2] Schlangen et al. "Middleware for Incremental Processing in Conversational Agents," SIGDIAL 2010. https://www.aclweb.org/anthology/W10-4308

build.xml

-<project name="ipaaca" default="build" basedir=".">
-  <target name="resolve">
-    <subant target="resolve" genericantfile="build.xml">
-      <fileset dir="." includes="*/build.xml"/>
-    </subant>
-  </target>
-
-  <target name="build" depends="-pre-compilation">
-    <subant target="build" genericantfile="build.xml">
-      <fileset dir="." includes="*/build.xml"/>
-    </subant>
-  </target>
-
-  <target name="clean">
-    <subant target="clean" genericantfile="build.xml">
-      <fileset dir="." includes="*/build.xml"/>
-    </subant>
-  </target>
-
-  <target name="-pre-compilation">
-    <subant target="-pre-compilation" genericantfile="build.xml">
-      <fileset dir="." includes="*/build.xml"/>
-    </subant>
-  </target>
-
-  <target name="compile" depends="-pre-compilation">
-    <subant target="compile" genericantfile="build.xml">
-      <fileset dir="." includes="*/build.xml"/>
-    </subant>
-  </target>
-
+<project name="ipaaca-all" default="build" basedir=".">
+  <import file="../hmibuild/build-recurse.xml" />
 </project>

conda.recipe/cross-linux.cmake

+# this one is important
+set(CMAKE_SYSTEM_NAME Linux)
+set(CMAKE_PLATFORM Linux)
+#this one not so much
+set(CMAKE_SYSTEM_VERSION 1)
+
+# specify the cross compiler
+set(CMAKE_C_COMPILER $ENV{CC})
+
+# where is the target environment
+set(CMAKE_FIND_ROOT_PATH $ENV{PREFIX} $ENV{BUILD_PREFIX}/$ENV{HOST}/sysroot)
+
+# search for programs in the build host directories
+set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
+# for libraries and headers in the target directories
+set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
+set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
+
+# god-awful hack because it seems to not run correct tests to determine this:
+set(__CHAR_UNSIGNED___EXITCODE 1)
\ No newline at end of file

conda.recipe/install_cpp.sh

+#!/bin/bash
+echo "Installing ipaaca-cpp"
+
+declare -a CMAKE_PLATFORM_FLAGS
+
+INCLUDE_PATH="${PREFIX}/include"
+LIBRARY_PATH="${PREFIX}/lib"
+
+export CMAKE_INCLUDE_PATH=$INCLUDE_PATH
+export CMAKE_LIBRARY_PATH=$LIBRARY_PATH
+
+if [[ "$(uname)" == "Linux" ]]; then
+    # Linus needs this lrt flag
+    export LDFLAGS="$LDFLAGS -lrt"
+    CMAKE_PLATFORM_FLAGS+=(-DCMAKE_TOOLCHAIN_FILE="${RECIPE_DIR}/cross-linux.cmake")
+elif [[ "$(uname)" == "Darwin" ]]; then
+    echo "mac"
+fi
+
+# build protobuf files
+mkdir -p ipaaca-cpp/build/ipaaca
+cd proto
+protoc ipaaca.proto --cpp_out=../ipaaca-cpp/build/ipaaca
+
+# build ipaaca cpp
+cd ../ipaaca-cpp/build
+export VERBOSE=1
+
+cmake .. -DCMAKE_INSTALL_PREFIX=${PREFIX} -DBOOST_INCLUDEDIR=${INCLUDE_PATH} -DBOOST_LIBRARYDIR=${LIBRARY_PATH} ${CMAKE_PLATFORM_FLAGS[@]}
+echo "Finished cmake, trying build now"
+make 
+make install DESTDIR=${PREFIX}
+cd ../../..
\ No newline at end of file

conda.recipe/install_python.sh

+#!/bin/bash
+
+# Since we setup subfolders for ipaaca and proto, we want to step into the ipaaca folder here
+# Note: setup.py assumes protoc file to be at ../proto from here and we do not want to change
+# that for easier manual installation
+cd ipaaca-py
+echo "Installing ipaaca using setup.py"
+$PYTHON -m pip install . -vv --no-deps
+#python setup.py install --single-version-externally-managed --record=record.txt

conda.recipe/meta.yaml

+{% set protobufversion = "3.8.0.*" %}
+{% set pahomqttversion = "1.4.0.*" %} # Currently no longer needed, but you may want to build your own if you want to include Ramin's patch
+
+package:
+        name: ipaaca
+        version: "0.1.3"
+
+source:
+        - path: ../ipaacalib/cpp
+          folder: ipaaca-cpp
+        - path: ../ipaacalib/proto
+          folder: proto
+        - path: ../ipaacalib/python
+          folder: ipaaca-py
+
+build:
+        number: 4
+
+
+requirements:
+        run:
+                - ipaaca-cpp
+                - ipaaca-py
+
+
+outputs:
+        - name: ipaaca-cpp
+          script: install_cpp.sh        # [unix]
+          requirements:
+                  build:
+                        - {{ compiler('c') }}
+                        - {{ compiler('cxx') }}
+                        - cmake >=3.10
+                  host:
+                        - libprotobuf {{ protobufversion }}
+                        - mosquitto
+                        - boost-cpp
+                        - libuuid
+                  run:
+                        - mosquitto
+                        - libprotobuf {{ protobufversion }}
+                        - boost-cpp
+                        - libuuid
+
+        - name: ipaaca-py
+          noarch: python
+          script: install_python.sh
+          requirements:
+                  host:
+                        - python {{ python }}
+                        - pip
+                        - protobuf {{ protobufversion }}
+                  run:
+                        - python 
+                        - mosquitto
+                        - paho-mqtt
+                        - protobuf {{ protobufversion }}

conda.recipe/meta.yaml_variantTest

+{% set protobufversion = "3.8.0" %}
+
+package:
+        name: ipaaca
+        version: "0.1.2"
+
+source:
+        - path: ../ipaacalib/cpp
+          folder: ipaaca-cpp
+        - path: ../ipaacalib/proto
+          folder: proto
+        - path: ../ipaacalib/python
+          folder: ipaaca-py
+
+build:
+    number: 9
+
+requirements:
+        run:
+                - ipaaca-cpp
+                - ipaaca-py
+
+outputs:
+    - name: ipaaca-cpp
+      script: install_cpp.sh        # [unix]
+      requirements:
+      build:
+                - {{ compiler('c') }}
+                - {{ compiler('cxx') }}
+                - cmake >=3.10
+      host:
+                - libprotobuf {{ protobufversion }}
+                - mosquitto
+                - boost-cpp {{ boostcpp }}
+      run:
+                - mosquitto
+                - libprotobuf {{ protobufversion }}
+                - boost-cpp {{ boostcpp }}
+    - name: ipaaca-py
+      noarch: python
+      script: install_python.sh
+      requirements:
+      host:
+                - python {{ py_version }}
+                - pip
+                - setuptools
+                - protobuf {{ protobufversion }}
+      run:
+                - python {{ py_version }}
+                - mosquitto
+                - paho-mqtt
+                - protobuf {{ protobufversion }}
\ No newline at end of file

cpp/build.properties

-language=cpp
-resolve.status=beta
-resource.path=${shared.resources}/Shared3DModels/resource;${shared.resources}/DefaultShaders/resource;${shared.resources}/LogbackConfigs/resource;${shared.resources}/HmiHumanoidBodyControl/resource;${shared.resources}/HmiHumanoidEmbodiments/resource;
-rebuild.list=
-

cpp/build.xml

-<?xml version="1.0" encoding="UTF-8"?>
-<project name="IpaacaCpp"  default="run">
-   <import file="../../soashared/ant/build.xml" />
-   <target name="-pre-compilation">
-     <echo message="Compiling protobuf file" />
-     <exec executable="protoc">
-        <arg value="--proto_path=../proto" />
-        <arg value="../proto/ipaaca.proto" />
-        <arg value="--cpp_out=build/" />
-     </exec>
-   </target>
-</project>
-

cpp/src/Makefile

-CONFIG = -DIPAACA_DEBUG_MESSAGES
-SOURCES = ipaaca.cc ipaaca.pb.cc ipaaca-test-main.cc
-CCFLAGS=-I. -I/usr/local/include -I/opt/local/include ${CONFIG}
-BOOSTLIBS = -L/opt/local/lib -lboost_regex-mt -lboost_date_time-mt -lboost_program_options-mt -lboost_thread-mt -lboost_filesystem-mt -lboost_signals-mt -lboost_system-mt
-PROTOLIBS = -L/opt/local/lib -lprotobuf
-LIBS = ${BOOSTLIBS} ${PROTOLIBS} -L/usr/local/lib -lrsc -lrsbcore
-
-COMPILER = gfilt
-
-all: main
-	
-
-receiver:
-	${COMPILER} ${CCFLAGS} -DMAKE_RECEIVER -o ipaaca-receiver ${SOURCES} ${LIBS}
-
-sender:
-	${COMPILER} ${CCFLAGS} -DMAKE_SENDER -o ipaaca-sender ${SOURCES} ${LIBS}
-
-main:
-	${COMPILER} ${CCFLAGS} -o ipaaca-main ${SOURCES} ${LIBS}
-
-protoc:
-	protoc --proto_path=../../proto ../../proto/ipaaca.proto --cpp_out=.
-
-clean:
-	rm -f ipaaca-test ipaaca-sender ipaaca-receiver ipaaca.pb.h ipaaca.pb.cc
-
-

cpp/src/ipaaca-test-main.cc

-#include <ipaaca.h>
-#include <typeinfo>
-
-//#include <rsc/logging/Logger.h>
-//#include <rsc/logging/LoggerFactory.h>
-// //rsc::logging::LoggerFactory::getInstance().reconfigure(rsc::logging::Logger::LEVEL_ALL);
-
-#ifdef MAKE_RECEIVER
-//boost::mutex mtx;
-using namespace ipaaca;
-
-class Testo {
-	protected:
-		std::string _name;
-	public:
-		inline Testo(const std::string& name="Testo"): _name(name) { }
-		inline void handleIUEvent(EventPtr event)
-		{
-			std::cout << _name << " received a ";
-			std::string type = event->getType();
-			if (type == "ipaaca::IUPayloadUpdate") {
-				std::cout << *boost::static_pointer_cast<IUPayloadUpdate>(event->getData()) << std::endl;
-			} else if (type == "ipaaca::IULinkUpdate") {
-				std::cout << *boost::static_pointer_cast<IULinkUpdate>(event->getData()) << std::endl;
-			} else {
-				std::cout << type << " (Unhandled type!)" << std::endl;
-			}
-		}
-};
-
-int main() {
-	initialize_ipaaca_rsb();
-	
-	ListenerPtr listener = Factory::getInstance().createListener( Scope("/tutorial/converter"));
-	
-	Testo t("TESTO");
-	HandlerPtr event_handler = HandlerPtr(new EventFunctionHandler(boost::bind(&Testo::handleIUEvent, boost::ref(t), _1)));
-	listener->addHandler( event_handler );
-	
-	while(true) {
-		boost::this_thread::sleep(boost::posix_time::milliseconds(100));
-	}
-	return EXIT_SUCCESS;
-}
-#else
-#ifdef MAKE_SENDER
-using namespace ipaaca;
-int main() {
-	initialize_ipaaca_rsb();
-	
-	//Informer<ipaaca::IUPayloadUpdate>::Ptr pinformer = Factory::getInstance().createInformer<ipaaca::IUPayloadUpdate> ( Scope("/tutorial/converter"));
-	//Informer<ipaaca::IULinkUpdate>::Ptr linformer = Factory::getInstance().createInformer<ipaaca::IULinkUpdate> ( Scope("/tutorial/converter"));
-	
-	Informer<AnyType>::Ptr informer = Factory::getInstance().createInformer<AnyType> ( Scope("/tutorial/converter"));
-
-	IUPayloadUpdate* pup = new ipaaca::IUPayloadUpdate();
-	Informer<ipaaca::IUPayloadUpdate>::DataPtr pdata(pup);
-	pup->uid = "2000";
-	pup->revision = 3;
-	pup->writer_name = "Comp1_OB";
-	pup->is_delta = true;
-	pup->new_items["new_key"] = "new_value";
-	pup->new_items["another_key"] = "some_info";
-	pup->keys_to_remove.push_back("old_key");
-	informer->publish(pdata);
-	
-	IULinkUpdate* lup = new ipaaca::IULinkUpdate();
-	Informer<ipaaca::IULinkUpdate>::DataPtr ldata(lup);
-	lup->uid = "2001";
-	lup->revision = 4;
-	lup->writer_name = "Comp2_IB";
-	lup->is_delta = true;
-	lup->new_links["SLL"].insert("2000");
-	lup->new_links["grin"].insert("1002");
-	lup->links_to_remove["grin"].insert("1001");
-	informer->publish(ldata);
-	
-	std::cout << "Done." << std::endl;
-	return EXIT_SUCCESS;
-}
-#else
-
-//
-//   TESTS
-//
-
-using namespace ipaaca;
-
-int main() {
-	try{
-		initialize_ipaaca_rsb();
-		
-		
-		OutputBuffer ob("TestOB");
-		std::cout << "Buffer: " << ob.unique_name() << std::endl;
-		
-		IU::ref iu = IU::create("testcategory");
-		ob.add(iu);
-		
-		std::cout << "_payload.get(\"TEST\") = \"" << iu->_payload.get("TEST") << "\"" << std::endl;
-		std::cout << "_payload[\"TEST\"] = \"" << (std::string) iu->_payload["TEST"] << "\"" << std::endl;
-		iu->_payload["TEST"] = "123.5-WAS-SET";
-		std::cout << "_payload[\"TEST\"] = \"" << (std::string) iu->_payload["TEST"] << "\"" << std::endl;
-		
-		std::string s = "The string \"" + iu->_payload["TEST"].to_str() + "\" is the new value.";
-		std::cout << "Concatenation test: " << s << std::endl;
-	
-		std::cout << "Interpreted as  long  value: " << iu->_payload["TEST"].to_int() << std::endl;
-		std::cout << "Interpreted as double value: " << iu->_payload["TEST"].to_float() << std::endl;
-		iu->commit();
-	} catch (ipaaca::Exception& e) {
-		std::cout << "== IPAACA EXCEPTION == " << e.what() << std::endl;
-	}
-}
-
-#endif
-#endif
-

cpp/src/ipaaca.h

-#ifndef __IPAACA_H__
-#define __IPAACA_H_
-
-#ifdef IPAACA_DEBUG_MESSAGES
-#define IPAACA_INFO(i) std::cout << __FILE__ << ":" << __LINE__ << ": " << __func__ << "() -- " << i << std::endl;
-#define IPAACA_IMPLEMENT_ME std::cout << __FILE__ << ":" << __LINE__ << ": " << __func__ << "() -- IMPLEMENT ME" << std::endl;
-#define IPAACA_TODO(i) std::cout << __FILE__ << ":" << __LINE__ << ": " << __func__ << "() -- TODO: " << i << std::endl;
-#else
-#define IPAACA_INFO(i) ;
-#define IPAACA_IMPLEMENT_ME(i) ;
-#define IPAACA_TODO(i) ;
-#endif
-
-// just for marking pure virtual functions for readability
-#define _IPAACA_ABSTRACT_
-
-#define IPAACA_PAYLOAD_DEFAULT_STRING_VALUE ""
-
-#include <iostream>
-
-#include <boost/thread.hpp>
-#include <boost/shared_ptr.hpp>
-#include <boost/pointer_cast.hpp>
-
-#include <rsc/runtime/TypeStringTools.h>
-#include <rsb/Factory.h>
-#include <rsb/Handler.h>
-#include <rsb/Event.h>
-#include <rsb/converter/Repository.h>
-#include <rsb/converter/ProtocolBufferConverter.h>
-#include <rsb/converter/Converter.h>
-#include <rsb/rsbexports.h>
-
-#include <ipaaca.pb.h>
-
-#include <pthread.h>
-#include <uuid/uuid.h>
-
-//using namespace boost;
-using namespace rsb;
-using namespace rsb::converter;
-
-namespace ipaaca {
-
-typedef uint32_t revision_t;
-
-enum IUEventType {
-	IU_ADDED,
-	IU_COMMITTED,
-	IU_DELETED,
-	IU_RETRACTED,
-	IU_UPDATED,
-	IU_LINKSUPDATED
-};
-
-enum IUAccessMode {
-	IU_ACCESS_PUSH,
-	IU_ACCESS_REMOTE,
-	IU_ACCESS_MESSAGE
-};
-
-//class {
-//public:
-//    template<typename T>
-//    operator shared_ptr<T>() { return shared_ptr<T>(); }
-//} NullPointer;
-
-class PayloadEntryProxy;
-class Payload;
-class IUInterface;
-class IU;
-class RemotePushIU;
-class IULinkUpdate;
-class IULinkUpdateConverter;
-class IUPayloadUpdate;
-class IUPayloadUpdateConverter;
-class IUStore;
-class FrozenIUStore;
-class IUEventHandler;
-class Buffer;
-class InputBuffer;
-class OutputBuffer;
-
-std::string generate_uuid_string();
-
-class IUStore: public std::map<std::string, boost::shared_ptr<IU> >
-{
-};
-class RemotePushIUStore: public std::map<std::string, boost::shared_ptr<RemotePushIU> > // TODO genericize to all remote IU types
-{
-};
-
-
-class Lock
-{
-	protected:
-		pthread_mutexattr_t _attrs;
-		pthread_mutex_t _mutex;
-	public:
-		inline Lock() {
-			pthread_mutexattr_init(&_attrs);
-			pthread_mutexattr_settype(&_attrs, PTHREAD_MUTEX_RECURSIVE);
-			pthread_mutex_init(&_mutex, &_attrs);
-		}
-		inline ~Lock() {
-			pthread_mutex_destroy(&_mutex);
-			pthread_mutexattr_destroy(&_attrs);
-		}
-		inline void lock() {
-			pthread_mutex_lock(&_mutex);
-		}
-		inline void unlock() {
-			pthread_mutex_unlock(&_mutex);
-		}
-};
-
-typedef std::set<std::string> LinkSet;
-typedef std::map<std::string, LinkSet> LinkMap;
-class SmartLinkMap {
-	friend class IUInterface;
-	friend class IU;
-	friend class IUConverter;
-	public:
-		const LinkSet& get_links(const std::string& key);
-		const LinkMap& get_all_links();
-	
-	protected:
-		LinkMap _links;
-		void _add_and_remove_links(const LinkMap& add, const LinkMap& remove);
-		void _replace_links(const LinkMap& links);
-};
-
-const LinkSet EMPTY_LINK_SET;
-//const std::set<std::string> EMPTY_LINK_SET;
-
-class Buffer { //: public boost::enable_shared_from_this<Buffer> {
-	friend class IU;
-	friend class RemotePushIU;
-	protected:
-		std::string _uuid;
-		std::string _basename;
-		std::string _unique_name;
-	protected:
-		_IPAACA_ABSTRACT_ virtual void _send_iu_link_update(IUInterface* iu, bool is_delta, revision_t revision, const LinkMap& new_links, const LinkMap& links_to_remove, const std::string& writer_name="undef") = 0;
-		_IPAACA_ABSTRACT_ virtual void _send_iu_payload_update(IUInterface* iu, bool is_delta, revision_t revision, const std::map<std::string, std::string>& new_items, const std::vector<std::string>& keys_to_remove, const std::string& writer_name="undef") = 0;
-		_IPAACA_ABSTRACT_ virtual void _send_iu_commission(IUInterface* iu, revision_t revision, const std::string& writer_name="undef") = 0;
-		void _allocate_unique_name(const std::string& basename);
-		inline Buffer(const std::string& basename, const std::string& function) {
-			_allocate_unique_name(basename, function);
-		}
-	public:
-		virtual inline ~Buffer() { }
-		inline const std::string& unique_name() { return _unique_name; }
-		//_IPAACA_ABSTRACT_ virtual void add(boost::shared_ptr<IUInterface> iu) = 0;
-};
-
-class OutputBuffer: public Buffer { //, public boost::enable_shared_from_this<OutputBuffer>  {
-	friend class IU;
-	friend class RemotePushIU;
-	protected:
-		std::map<std::string, Informer<AnyType>::Ptr> _informer_store;
-		IUStore _iu_store;
-		Lock _iu_id_counter_lock;
-	protected:
-		// informing functions
-		void _send_iu_link_update(IUInterface* iu, bool is_delta, revision_t revision, const LinkMap& new_links, const LinkMap& links_to_remove, const std::string& writer_name="undef");
-		void _send_iu_payload_update(IUInterface* iu, bool is_delta, revision_t revision, const std::map<std::string, std::string>& new_items, const std::vector<std::string>& keys_to_remove, const std::string& writer_name="undef");
-		void _send_iu_commission(IUInterface* iu, revision_t revision, const std::string& writer_name);
-		// remote access functions
-		// _remote_update_links(IULinkUpdate)
-		// _remote_update_payload(IUPayloadUpdate)
-		// _remote_commit(protobuf::IUCommission)
-	protected:
-		void _publish_iu(boost::shared_ptr<IU> iu);
-		void _retract_iu(boost::shared_ptr<IU> iu);
-		Informer<AnyType>::Ptr _get_informer(const std::string& category);
-	public:
-		OutputBuffer(const std::string& basename);
-		~OutputBuffer() {
-			IPAACA_IMPLEMENT_ME
-		}
-		void add(boost::shared_ptr<IU> iu);
-		boost::shared_ptr<IU> remove(const std::string& iu_uid);
-		boost::shared_ptr<IU> remove(boost::shared_ptr<IU> iu);
-};
-
-class InputBuffer: public Buffer { //, public boost::enable_shared_from_this<InputBuffer>  {
-	friend class IU;
-	friend class RemotePushIU;
-	protected:
-		inline void _send_iu_link_update(IUInterface* iu, bool is_delta, revision_t revision, const LinkMap& new_links, const LinkMap& links_to_remove, const std::string& writer_name="undef")
-		{
-			IPAACA_INFO("(ERROR) InputBuffer::_send_iu_link_update() should never be invoked")
-		}
-		inline void _send_iu_payload_update(IUInterface* iu, bool is_delta, revision_t revision, const std::map<std::string, std::string>& new_items, const std::vector<std::string>& keys_to_remove, const std::string& writer_name="undef")
-		{
-			IPAACA_INFO("(ERROR) InputBuffer::_send_iu_payload_update() should never be invoked")
-		}
-		inline void _send_iu_commission(IUInterface* iu, revision_t revision, const std::string& writer_name="undef")
-		{
-			IPAACA_INFO("(ERROR) InputBuffer::_send_iu_commission() should never be invoked")
-		}
-	public:
-		InputBuffer(const std::string& basename);
-		~InputBuffer() {
-			IPAACA_IMPLEMENT_ME
-		}
-		inline void add(boost::shared_ptr<IU> iu)
-		{
-			IPAACA_IMPLEMENT_ME
-		}
-};
-
-/*
-class IUEventFunctionHandler: public rsb::EventFunctionHandler {
-	protected:
-		Buffer* _buffer;
-	public:
-		inline IUEventFunctionHandler(Buffer* buffer, const EventFunction& function, const std::string& method="")
-			: EventFunctionHandler(function, method), _buffer(buffer) { }
-};
-*/
-
-class IUConverter: public rsb::converter::Converter<std::string> {//{{{
-	public:
-		IUConverter();
-		std::string serialize(const rsb::AnnotatedData& data, std::string& wire);
-		rsb::AnnotatedData deserialize(const std::string& wireSchema, const std::string& wire);
-};//}}}
-
-class IUPayloadUpdate {//{{{
-	public:
-		std::string uid;
-		revision_t revision;
-		std::string writer_name;
-		bool is_delta;
-		std::map<std::string, std::string> new_items;
-		std::vector<std::string> keys_to_remove;
-	friend std::ostream& operator<<(std::ostream& os, const IUPayloadUpdate& obj);
-};//}}}
-class IUPayloadUpdateConverter: public rsb::converter::Converter<std::string> {//{{{
-	public:
-		IUPayloadUpdateConverter();
-		std::string serialize(const rsb::AnnotatedData& data, std::string& wire);
-		rsb::AnnotatedData deserialize(const std::string& wireSchema, const std::string& wire);
-};//}}}
-
-class IULinkUpdate {//{{{
-	public:
-		std::string uid;
-		revision_t revision;
-		std::string writer_name;
-		bool is_delta;
-		std::map<std::string, std::set<std::string> > new_links;
-		std::map<std::string, std::set<std::string> > links_to_remove;
-	friend std::ostream& operator<<(std::ostream& os, const IULinkUpdate& obj);
-};//}}}
-class IULinkUpdateConverter: public rsb::converter::Converter<std::string> {//{{{
-	public:
-		IULinkUpdateConverter();
-		std::string serialize(const rsb::AnnotatedData& data, std::string& wire);
-		rsb::AnnotatedData deserialize(const std::string& wireSchema, const std::string& wire);
-};//}}}
-
-void initialize_ipaaca_rsb();
-
-class PayloadEntryProxy//{{{
-{
-	protected:
-		Payload* _payload;
-		std::string _key;
-	public:
-		PayloadEntryProxy(Payload* payload, const std::string& key);
-		PayloadEntryProxy& operator=(const std::string& value);
-		operator std::string();
-		operator long();
-		operator double();
-		inline std::string to_str() { return operator std::string(); }
-		inline long to_int() { return operator long(); }
-		inline double to_float() { return operator double(); }
-};//}}}
-
-class Payload//{{{
-{
-	friend class IUInterface;
-	friend class IU;
-	friend class RemotePushIU;
-	friend class IUConverter;
-	protected:
-		std::string _owner_name;
-		std::map<std::string, std::string> _store;
-		boost::shared_ptr<IUInterface> _iu;
-	protected:
-		void initialize(boost::shared_ptr<IUInterface> iu);
-		inline void _set_owner_name(const std::string& name) { _owner_name = name; }
-	public:
-		inline const std::string& owner_name() { return _owner_name; }
-		// access
-		PayloadEntryProxy operator[](const std::string& key);
-		void set(const std::string& k, const std::string& v);
-		void remove(const std::string& k);
-		std::string get(const std::string& k);
-	typedef boost::shared_ptr<Payload> ref;
-};//}}}
-
-class IUInterface {//{{{
-	friend class IUConverter;
-	protected:
-		IUInterface();
-	public:
-		inline virtual ~IUInterface() { }
-	protected:
-		std::string _uid;
-		revision_t _revision;
-		std::string _category;
-		std::string _payload_type; // default is "MAP"
-		std::string _owner_name;
-		bool _committed;
-		IUAccessMode _access_mode;
-		bool _read_only;
-		//boost::shared_ptr<Buffer> _buffer;
-		Buffer* _buffer;
-		SmartLinkMap _links;
-	protected:
-		friend class Payload;
-		// Internal functions that perform the update logic,
-		//  e.g. sending a notification across the network
-		_IPAACA_ABSTRACT_ virtual void _modify_links(bool is_delta, const LinkMap& new_links, const LinkMap& links_to_remove, const std::string& writer_name) = 0;
-		_IPAACA_ABSTRACT_ virtual void _modify_payload(bool is_delta, const std::map<std::string, std::string>& new_items, const std::vector<std::string>& keys_to_remove, const std::string& writer_name) = 0;
-		//void _set_buffer(boost::shared_ptr<Buffer> buffer);
-		void _associate_with_buffer(Buffer* buffer);
-		void _set_buffer(Buffer* buffer);
-		void _set_uid(const std::string& uid);
-		void _set_owner_name(const std::string& owner_name);
-	protected:
-		// internal functions that do not emit update events
-		inline void _add_and_remove_links(const LinkMap& add, const LinkMap& remove) { _links._add_and_remove_links(add, remove); }
-		inline void _replace_links(const LinkMap& links) { _links._replace_links(links); }
-	public:
-		inline bool is_published() { return (_buffer != 0); }
-		inline const std::string& uid() const { return _uid; }
-		inline revision_t revision() const { return _revision; }
-		inline const std::string& category() const { return _category; }
-		inline const std::string& payload_type() const { return _payload_type; }
-		inline const std::string& owner_name() const { return _owner_name; }
-		inline bool committed() const { return _committed; }
-		inline IUAccessMode access_mode() const { return _access_mode; }
-		inline bool read_only() const { return _read_only; }
-		//inline boost::shared_ptr<Buffer> buffer() { return _buffer; }
-		inline Buffer* buffer() const { return _buffer; }
-		inline const LinkSet& get_links(std::string type) { return _links.get_links(type); }
-		inline const LinkMap& get_all_links() { return _links.get_all_links(); }
-		// Payload
-		_IPAACA_ABSTRACT_ virtual Payload& payload() = 0;
-		// setters
-		_IPAACA_ABSTRACT_ virtual void commit() = 0;
-		// functions to modify and update links:
-		void add_links(const std::string& type, const LinkSet& targets, const std::string& writer_name = "");
-		void remove_links(const std::string& type, const LinkSet& targets, const std::string& writer_name = "");
-		void modify_links(const LinkMap& add, const LinkMap& remove, const std::string& writer_name = "");
-		void set_links(const LinkMap& links, const std::string& writer_name = "");
-		//    (with cpp specific convenience functions:)
-		void add_link(const std::string& type, const std::string& target, const std::string& writer_name = "");
-		void remove_link(const std::string& type, const std::string& target, const std::string& writer_name = "");
-};//}}}
-
-class IU: public IUInterface {//{{{
-	friend class Buffer;
-	friend class InputBuffer;
-	friend class OutputBuffer;
-	public:
-		Payload _payload;
-	protected:
-		Lock _revision_lock;
-	protected:
-		inline void _increase_revision_number() { _revision++; }
-		IU(const std::string& category, IUAccessMode access_mode=IU_ACCESS_PUSH, bool read_only=false, const std::string& payload_type="MAP" );
-	public:
-		inline ~IU() {
-			IPAACA_IMPLEMENT_ME
-		}
-		static boost::shared_ptr<IU> create(const std::string& category, IUAccessMode access_mode=IU_ACCESS_PUSH, bool read_only=false, const std::string& payload_type="MAP" );
-		inline Payload& payload() { return _payload; }
-		void commit();
-	protected:
-		void _modify_links(bool is_delta, const LinkMap& new_links, const LinkMap& links_to_remove, const std::string& writer_name = "");
-		void _modify_payload(bool is_delta, const std::map<std::string, std::string>& new_items, const std::vector<std::string>& keys_to_remove, const std::string& writer_name = "");
-	protected:
-		void _internal_commit(const std::string& writer_name = "");
-	public:
-	typedef boost::shared_ptr<IU> ref;
-};//}}}
-
-class RemotePushIU: public IUInterface {//{{{
-	friend class Buffer;
-	friend class InputBuffer;
-	friend class OutputBuffer;
-	friend class IUConverter;
-	public:
-		Payload _payload;
-	protected:
-		RemotePushIU();
-		static boost::shared_ptr<RemotePushIU> create();
-	public:
-		inline ~RemotePushIU() {
-			IPAACA_IMPLEMENT_ME
-		}
-		inline Payload& payload() { return _payload; }
-		void commit();
-	protected:
-		void _modify_links(bool is_delta, const LinkMap& new_links, const LinkMap& links_to_remove, const std::string& writer_name = "");
-		void _modify_payload(bool is_delta, const std::map<std::string, std::string>& new_items, const std::vector<std::string>& keys_to_remove, const std::string& writer_name = "");
-	typedef boost::shared_ptr<RemotePushIU> ref;
-};//}}}
-
-class Exception: public std::exception//{{{
-{
-	protected:
-		std::string _description;
-		inline Exception(const std::string& description=""): _description(description) { }
-	public:
-		inline ~Exception() throw() { }
-		const char* what() const throw() {
-			return _description.c_str();
-		}
-};//}}}
-class IUPublishedError: public Exception//{{{
-{
-	public:
-		inline ~IUPublishedError() throw() { }
-		inline IUPublishedError() { //boost::shared_ptr<IU> iu) {
-			_description = "IUPublishedError";
-		}
-};//}}}
-class IUCommittedError: public Exception//{{{
-{
-	public:
-		inline ~IUCommittedError() throw() { }
-		inline IUCommittedError() { //boost::shared_ptr<IU> iu) {
-			_description = "IUCommittedError";
-		}
-};//}}}
-class IUAlreadyInABufferError: public Exception//{{{
-{
-	public:
-		inline ~IUAlreadyInABufferError() throw() { }
-		inline IUAlreadyInABufferError() { //boost::shared_ptr<IU> iu) {
-			_description = "IUAlreadyInABufferError";
-		}
-};//}}}
-class IUAlreadyHasAnUIDError: public Exception//{{{
-{
-	public:
-		inline ~IUAlreadyHasAnUIDError() throw() { }
-		inline IUAlreadyHasAnUIDError() { //boost::shared_ptr<IU> iu) {
-			_description = "IUAlreadyHasAnUIDError";
-		}
-};//}}}
-class IUAlreadyHasAnOwnerNameError: public Exception//{{{
-{
-	public:
-		inline ~IUAlreadyHasAnOwnerNameError() throw() { }
-		inline IUAlreadyHasAnOwnerNameError() { //boost::shared_ptr<IU> iu) {
-			_description = "IUAlreadyHasAnOwnerNameError";
-		}
-};//}}}
-class NotImplementedError: public Exception//{{{
-{
-	public:
-		inline ~NotImplementedError() throw() { }
-		inline NotImplementedError() { //boost::shared_ptr<IU> iu) {
-			_description = "NotImplementedError";
-		}
-};//}}}
-
-} // of namespace ipaaca
-
-#endif
-
-

docs/.gitignore

+doxygen_generated
+.*.sw?
+

docs/README-build-windows.txt

+Instructions for building ipaaca on Windows
+
+Install Visual Studio 2017 (with C++), including CMake
+Install GoW (Gnu on Windows) to have some POSIX-like utilities, or double-check the commands below
+
+Open terminal via Visual Studio's "x64 Native Tools Command Prompt", for 64-bit builds
+
+The following instructions are for Debug mode, you can use Release, too
+(replace all occurrences below).
+
+
+BUILD DEPS:
+
+protobuf (latest test with 3.9.0):
+
+cd cmake
+mkdir build
+cd build
+cmake -Dprotobuf_BUILD_TESTS=OFF -DCMAKE_INSTALL_PREFIX="C:/Libs/protobuf/x64" -G "Visual Studio 15 2017 Win64" /p:Configuration=Debug ..
+cmake --build . --target INSTALL --config Debug -- /nologo /verbosity:minimal /maxcpucount
+
+mosquitto (latest test with 1.5.4):
+mkdir build
+cd build
+# threading=off below disables a nasty library dependency, our dispatcher is threaded anyway
+cmake -DWITH_THREADING=OFF -DCMAKE_INSTALL_PREFIX=C:/Libs/mosquitto/x64 -G "Visual Studio 15 2017 Win64" /p:Configuration=Debug ..
+cmake --build . --target INSTALL --config Debug -- /nologo /verbosity:minimal /maxcpucount
+cp lib\Debug\*.lib lib\cpp\Debug\*.lib \Libs\mosquitto\x64\
+
+
+BUILD IPAACA (ipaaca4):
+
+cd ......\repo\ipaaca\ipaacalib\proto
+mkdir ..\cpp\build\ipaaca
+\Libs\protobuf\x64\bin\protoc.exe ipaaca.proto --cpp_out=..\cpp\build\ipaaca
+cd ..\cpp\build\ipaaca
+cmake -DCMAKE_INSTALL_PREFIX="C:/Libs/ipaaca/x64" -G "Visual Studio 15 2017 Win64" /p:Configuration=Debug ..
+cmake --build . --target INSTALL --config Debug -- /nologo /verbosity:minimal /maxcpucount
+
+
+SETUP FOR VISUAL STUDIO PROJECTS:
+Project -> Properties ->
+Debugging: add the runtime paths to the environment variables (Path=%Path%;C:\Libs\ipaaca\x64\bin;C:\Libs\mosquitto\x64\bin)
+C++: add the include directories (C:\Libs\ipaaca\x64\include;C:\Libs\protobuf\x64\include)
+Linker: add ipaaca.lib to the dependencies and C:\Libs\ipaaca\x64\lib to the additional lib dirs
+Also add /wd4146 to compiler options if you get errors in protobuf headers (like "unary negative on unsigned value").
+
+