Merge lp:~marcustomlinson/unity-scopes-api/child_scopes_ordered into lp:unity-scopes-api

[Marcus Tomlinson]

* Introduced child_scopes() methods for aggregators to return their list of child scopes at runtime.
* Added missing virtual destructor to AbstractScopeBase. (LP: #1360266)
* Removed deprecated Runtime::run_scope() method.

[Michi Henning (michihenning)]

Looks right to me!

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:609
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/512/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-amd64-ci/37
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/37
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/37/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-i386-ci/37

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/512/rebuild

review: Approve (continuous-integration)

[Michi Henning (michihenning)]

Let's give it a shot.

review: Approve

[Michi Henning (michihenning)]

Cool!

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:612
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/554/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-amd64-ci/81
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/79
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/79/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-i386-ci/80

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/554/rebuild

review: Approve (continuous-integration)

[lp:~marcustomlinson/unity-scopes-api/child_scopes_ordered]

613. By Marcus Tomlinson on 2015-01-26

Merged trunk

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2015-01-21 12:46:11 +0000
+++ CMakeLists.txt	2015-01-26 17:27:30 +0000
@@ -227,7 +227,7 @@
 # API version
 set(UNITY_SCOPES_MAJOR 0)
 set(UNITY_SCOPES_MINOR 6)
-set(UNITY_SCOPES_MICRO 11)
+set(UNITY_SCOPES_MICRO 12)
 set(UNITY_SCOPES_SOVERSION 3)
 
 # Version for testing, with all symbols visible

=== modified file 'RELEASE_NOTES.md'
--- RELEASE_NOTES.md	2015-01-07 23:03:50 +0000
+++ RELEASE_NOTES.md	2015-01-26 17:27:30 +0000
@@ -1,6 +1,13 @@
 Release notes
 =============
 
+Changes in version 0.6.12
+=========================
+  - Introduced child_scopes() methods for aggregators to return their
+    list of child scopes at runtime.
+  - Added missing virtual destructor to AbstractScopeBase. (LP: #1360266)
+  - Removed deprecated Runtime::run_scope() method.
+
 Changes in version 0.6.11
 =========================
   - The JSON for a CategoryRenderer now supports a "fallback" field in the

=== modified file 'debian/changelog'
--- debian/changelog	2015-01-26 09:01:10 +0000
+++ debian/changelog	2015-01-26 17:27:30 +0000
@@ -1,3 +1,12 @@
+unity-scopes-api (0.6.12-0ubuntu1) UNRELEASED; urgency=medium
+
+  * Introduced child_scopes() methods for aggregators to return their
+    list of child scopes at runtime.
+  * Added missing virtual destructor to AbstractScopeBase. (LP: #1360266)
+  * Removed deprecated Runtime::run_scope() method.
+
+ -- Marcus Tomlinson <[e-mail]>  Tue, 20 Jan 2015 07:52:23 +0200
+
 unity-scopes-api (0.6.11+15.04.20150126-0ubuntu1) vivid; urgency=low
 
   [ Marcus Tomlinson ]

=== modified file 'debian/libunity-scopes3.symbols'
--- debian/libunity-scopes3.symbols	2015-01-21 12:46:34 +0000
+++ debian/libunity-scopes3.symbols	2015-01-26 17:27:30 +0000
@@ -93,6 +93,8 @@
  (c++)"typeinfo name for unity::scopes::TimeoutException@Base" 0.4.0+14.04.20140312.1
  (c++)"typeinfo name for unity::scopes::utility::BufferedResultForwarder@Base" 0.6.10+15.04.20141210.2
  (c++)"typeinfo name for unity::scopes::VariantBuilder@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::AbstractScopeBase::~AbstractScopeBase()@Base" 0replaceme
+ (c++)"unity::scopes::AbstractScopeBase::AbstractScopeBase()@Base" 0replaceme
  (c++)"unity::scopes::ActionMetadata::~ActionMetadata()@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::ActionMetadata::ActionMetadata(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::ActionMetadata::ActionMetadata(unity::scopes::ActionMetadata&&)@Base" 0.4.0+14.04.20140312.1
@@ -471,6 +473,7 @@
  (c++)"unity::scopes::internal::ScopeConfig::search_hint() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeConfig::version() const@Base" 0.6.9+15.04.20141129
  (c++)"unity::scopes::internal::ScopeImpl::activate(unity::scopes::Result const&, unity::scopes::ActionMetadata const&, std::shared_ptr<unity::scopes::ActivationListenerBase> const&)@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::ScopeImpl::child_scopes_ordered()@Base" 0replaceme
  (c++)"unity::scopes::internal::ScopeImpl::create(std::shared_ptr<unity::scopes::internal::MWScope> const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.6.11+15.04.20150119
  (c++)"unity::scopes::internal::ScopeImpl::fwd()@Base" 0.4.3+14.10.20140428
  (c++)"unity::scopes::internal::ScopeImpl::perform_action(unity::scopes::Result const&, unity::scopes::ActionMetadata const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::shared_ptr<unity::scopes::ActivationListenerBase> const&)@Base" 0.4.0+14.04.20140312.1
@@ -481,6 +484,7 @@
  (c++)"unity::scopes::internal::ScopeImpl::search(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, unity::scopes::FilterState const&, unity::scopes::SearchMetadata const&, std::shared_ptr<unity::scopes::SearchListenerBase> const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeImpl::search(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, unity::scopes::SearchMetadata const&, std::shared_ptr<unity::scopes::SearchListenerBase> const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeImpl::search(unity::scopes::CannedQuery const&, unity::scopes::SearchMetadata const&, std::shared_ptr<unity::scopes::SearchListenerBase> const&)@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::ScopeImpl::set_child_scopes_ordered(std::list<unity::scopes::ChildScope, std::allocator<unity::scopes::ChildScope> > const&)@Base" 0replaceme
  (c++)"unity::scopes::internal::ScopeLoader::libpath() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeLoader::load(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.6.0+14.10.20140804.1
  (c++)"unity::scopes::internal::ScopeLoader::scope_base() const@Base" 0.4.0+14.04.20140312.1
@@ -536,6 +540,7 @@
  (c++)"unity::scopes::internal::ScopeMetadataImpl::set_version(int)@Base" 0.6.9+15.04.20141129
  (c++)"unity::scopes::internal::ScopeMetadataImpl::version() const@Base" 0.6.9+15.04.20141129
  (c++)"unity::scopes::internal::ScopeObject::activate(unity::scopes::Result const&, unity::scopes::ActionMetadata const&, std::shared_ptr<unity::scopes::internal::MWReply> const&, unity::scopes::internal::InvokeInfo const&)@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::ScopeObject::child_scopes_ordered() const@Base" 0replaceme
  (c++)"unity::scopes::internal::ScopeObject::debug_mode() const@Base" 0.6.2+rtm+rtm+rtm+14.09.20140818
  (c++)"unity::scopes::internal::ScopeObject::perform_action(unity::scopes::Result const&, unity::scopes::ActionMetadata const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::shared_ptr<unity::scopes::internal::MWReply> const&, unity::scopes::internal::InvokeInfo const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeObject::preview(unity::scopes::Result const&, unity::scopes::ActionMetadata const&, std::shared_ptr<unity::scopes::internal::MWReply> const&, unity::scopes::internal::InvokeInfo const&)@Base" 0.4.0+14.04.20140312.1
@@ -543,6 +548,7 @@
  (c++)"unity::scopes::internal::ScopeObject::~ScopeObject()@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::ScopeObject::ScopeObject(unity::scopes::ScopeBase*, bool)@Base" 0.6.11+15.04.20150119
  (c++)"unity::scopes::internal::ScopeObject::search(unity::scopes::CannedQuery const&, unity::scopes::SearchMetadata const&, std::shared_ptr<unity::scopes::internal::MWReply> const&, unity::scopes::internal::InvokeInfo const&)@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::ScopeObject::set_child_scopes_ordered(std::list<unity::scopes::ChildScope, std::allocator<unity::scopes::ChildScope> > const&)@Base" 0replaceme
  (c++)"unity::scopes::internal::smartscopes::SSConfig::http_reply_timeout() const@Base" 0.4.4+14.10.20140508
  (c++)"unity::scopes::internal::smartscopes::SSConfig::reg_refresh_fail_timeout() const@Base" 0.4.4+14.10.20140508
  (c++)"unity::scopes::internal::smartscopes::SSConfig::reg_refresh_rate() const@Base" 0.4.4+14.10.20140508
@@ -564,11 +570,13 @@
  (c++)"unity::scopes::internal::smartscopes::SSRegistryObject::SSRegistryObject(std::shared_ptr<unity::scopes::internal::MiddlewareBase>, unity::scopes::internal::smartscopes::SSConfig const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, bool)@Base" 0.4.4+14.10.20140508
  (c++)"unity::scopes::internal::smartscopes::SSRegistryObject::SSSettingsDef::~SSSettingsDef()@Base" 0.5.2+14.10.20140709.2
  (c++)"unity::scopes::internal::smartscopes::SSScopeObject::activate(unity::scopes::Result const&, unity::scopes::ActionMetadata const&, std::shared_ptr<unity::scopes::internal::MWReply> const&, unity::scopes::internal::InvokeInfo const&)@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::smartscopes::SSScopeObject::child_scopes_ordered() const@Base" 0replaceme
  (c++)"unity::scopes::internal::smartscopes::SSScopeObject::debug_mode() const@Base" 0.6.2+rtm+rtm+rtm+14.09.20140818
  (c++)"unity::scopes::internal::smartscopes::SSScopeObject::perform_action(unity::scopes::Result const&, unity::scopes::ActionMetadata const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::shared_ptr<unity::scopes::internal::MWReply> const&, unity::scopes::internal::InvokeInfo const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::smartscopes::SSScopeObject::preview(unity::scopes::Result const&, unity::scopes::ActionMetadata const&, std::shared_ptr<unity::scopes::internal::MWReply> const&, unity::scopes::internal::InvokeInfo const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::smartscopes::SSScopeObject::query(unity::scopes::internal::InvokeInfo const&, std::shared_ptr<unity::scopes::internal::MWReply> const&, std::function<std::shared_ptr<unity::scopes::QueryBase> ()> const&, std::function<void (std::shared_ptr<unity::scopes::QueryBase>)> const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::smartscopes::SSScopeObject::search(unity::scopes::CannedQuery const&, unity::scopes::SearchMetadata const&, std::shared_ptr<unity::scopes::internal::MWReply> const&, unity::scopes::internal::InvokeInfo const&)@Base" 0.4.0+14.04.20140312.1
+ (c++)"unity::scopes::internal::smartscopes::SSScopeObject::set_child_scopes_ordered(std::list<unity::scopes::ChildScope, std::allocator<unity::scopes::ChildScope> > const&)@Base" 0replaceme
  (c++)"unity::scopes::internal::smartscopes::SSScopeObject::~SSScopeObject()@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::smartscopes::SSScopeObject::SSScopeObject(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::shared_ptr<unity::scopes::internal::MiddlewareBase>, std::shared_ptr<unity::scopes::internal::smartscopes::SSRegistryObject>)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::internal::StateReceiverObject::push_state(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, unity::scopes::internal::StateReceiverObject::State const&)@Base" 0.4.2+14.04.20140404.2
@@ -762,13 +770,14 @@
  (c++)"unity::scopes::Runtime::proxy_to_string(std::shared_ptr<unity::scopes::Object> const&) const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::Runtime::registry() const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::Runtime::run_scope(unity::scopes::ScopeBase*, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.4+14.10.20140508
- (c++)"unity::scopes::Runtime::run_scope(unity::scopes::ScopeBase*, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.4+14.10.20140508
  (c++)"unity::scopes::Runtime::~Runtime()@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::Runtime::Runtime(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::Runtime::string_to_proxy(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&) const@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::ScopeBase::activate(unity::scopes::Result const&, unity::scopes::ActionMetadata const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::ScopeBase::app_directory() const@Base" 0.6.9+15.04.20141129
  (c++)"unity::scopes::ScopeBase::cache_directory() const@Base" 0.6.0+14.10.20140804.1
+ (c++)"unity::scopes::ScopeBase::child_scopes() const@Base" 0replaceme
+ (c++)"unity::scopes::ScopeBase::child_scopes_ordered() const@Base" 0replaceme
  (c++)"unity::scopes::ScopeBase::perform_action(unity::scopes::Result const&, unity::scopes::ActionMetadata const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)@Base" 0.4.0+14.04.20140312.1
  (c++)"unity::scopes::ScopeBase::registry() const@Base" 0.6.0+14.10.20140804.1
  (c++)"unity::scopes::ScopeBase::run()@Base" 0.4.0+14.04.20140312.1

=== modified file 'include/unity/scopes/AbstractScopeBase.h'
--- include/unity/scopes/AbstractScopeBase.h	2015-01-15 05:23:34 +0000
+++ include/unity/scopes/AbstractScopeBase.h	2015-01-26 17:27:30 +0000
@@ -19,6 +19,7 @@
 #pragma once
 
 #include <unity/scopes/ActivationQueryBase.h>
+#include <unity/scopes/ChildScope.h>
 #include <unity/scopes/PreviewQueryBase.h>
 #include <unity/scopes/Registry.h>
 #include <unity/scopes/SearchQueryBase.h>
@@ -55,6 +56,14 @@
     virtual std::string tmp_directory() const = 0;
     virtual unity::scopes::RegistryProxy registry() const = 0;
     virtual VariantMap settings() const = 0;
+
+    virtual ~AbstractScopeBase();
+
+    virtual ChildScopeList child_scopes() const = 0;
+    virtual ChildScopeList child_scopes_ordered() const = 0;
+
+protected:
+    AbstractScopeBase();
 /// @endcond
 };
 

=== added file 'include/unity/scopes/ChildScope.h'
--- include/unity/scopes/ChildScope.h	1970-01-01 00:00:00 +0000
+++ include/unity/scopes/ChildScope.h	2015-01-26 17:27:30 +0000
@@ -0,0 +1,50 @@
+/*
+ * Copyright (C) 2014 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Marcus Tomlinson <[e-mail]>
+ */
+
+#pragma once
+
+#include <list>
+#include <string>
+
+namespace unity
+{
+
+namespace scopes
+{
+
+struct ChildScope;
+
+/**
+ \brief A list of child scopes.
+*/
+
+typedef std::list<ChildScope> ChildScopeList;
+
+/**
+ \brief A container for details about an aggregator's child scope.
+*/
+
+struct ChildScope
+{
+    std::string id; ///< The scope id of this child scope.
+    bool enabled;   ///< Holds whether this child scope is aggregated.
+};
+
+} // namespace scopes
+
+} // namespace unity

=== modified file 'include/unity/scopes/Runtime.h'
--- include/unity/scopes/Runtime.h	2014-12-04 04:33:50 +0000
+++ include/unity/scopes/Runtime.h	2015-01-26 17:27:30 +0000
@@ -114,25 +114,6 @@
     This method is intended to run a scope that can not be loaded via the scope runner, such as
     those written in languages that cannot be dynamically loaded.
 
-    \note This method is deprecated. Use
-    `void run_scope(ScopeBase *const scope_base, std::string const& scope_ini_file)` instead.
-
-    \param scope_base The scope implementation
-    \param runtime_ini_file This parameter is ignored.
-    \param scope_ini_file The full path of scope configuration file
-    */
-    /// @cond
-    // TODO: next ABI incompatible release, strip out this method.
-    __attribute__ ((deprecated))
-    /// @endcond
-    void run_scope(ScopeBase *const scope_base, std::string const& runtime_ini_file, std::string const& scope_ini_file);
-
-    /**
-    \brief Run a scope without going through the scope runner.
-
-    This method is intended to run a scope that can not be loaded via the scope runner, such as
-    those written in languages that cannot be dynamically loaded.
-
     \param scope_base The scope implementation
     \param scope_ini_file The full path of scope configuration file
     */

=== modified file 'include/unity/scopes/Scope.h'
--- include/unity/scopes/Scope.h	2014-11-03 05:31:30 +0000
+++ include/unity/scopes/Scope.h	2015-01-26 17:27:30 +0000
@@ -19,6 +19,7 @@
 #pragma once
 
 #include <unity/scopes/ActivationListenerBase.h>
+#include <unity/scopes/ChildScope.h>
 #include <unity/scopes/Object.h>
 #include <unity/scopes/PreviewListenerBase.h>
 #include <unity/scopes/QueryCtrlProxyFwd.h>
@@ -140,6 +141,21 @@
     */
     virtual ~Scope();
 
+    /**
+    \brief Returns a list of child scopes aggregated by this scope in user-defined order.
+    \return The list of child scopes aggregated by this scope in user-defined order.
+    */
+    virtual ChildScopeList child_scopes_ordered() = 0;
+
+    /**
+    \brief Sets the ordered list of child scopes aggregated by this scope.
+    \note The only time this call will return false is if the scope cannot write to its config directory.
+    This should not happen in real-world usage, but if it does, check the log for more detail.
+    \param child_scopes_ordered The ordered list of child scopes aggregated by this scope.
+    \return True if the list was successfully set.
+    */
+    virtual bool set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered) = 0;
+
 protected:
     /// @cond
     Scope();

=== modified file 'include/unity/scopes/ScopeBase.h'
--- include/unity/scopes/ScopeBase.h	2015-01-15 05:23:34 +0000
+++ include/unity/scopes/ScopeBase.h	2015-01-26 17:27:30 +0000
@@ -330,6 +330,33 @@
     */
     virtual VariantMap settings() const final;
 
+    /**
+    \brief Returns a list of child scopes aggregated by this scope.
+
+    The scope author must ensure that the list returned by this method contains all scopes
+    that this aggregator may collect results from. This list may contain scopes that are
+    not currently installed and are optional for proper functioning of this scope.
+
+    The default behaviour of this method is to simply return all available scopes on the
+    system. This translates to: "Any scope may potentially be aggregated by this scope".
+
+    \note Only aggregator scopes should implement this method.
+
+    \return The list of child scopes aggregated by this scope.
+    */
+    virtual ChildScopeList child_scopes() const;
+
+    /**
+    \brief Returns a list of child scopes aggregated by this scope in user-defined order.
+
+    An aggregator scope must push its results in the order specified by this method's
+    return value. The aggregator should also respect the "enabled" states of each child
+    scope, returning results only for the child scopes that are enabled.
+
+    \return The list of child scopes aggregated by this scope in user-defined order.
+    */
+    virtual ChildScopeList child_scopes_ordered() const final;
+
 protected:
     /// @cond
     ScopeBase();

=== added file 'include/unity/scopes/internal/ChildScopesRepository.h'
--- include/unity/scopes/internal/ChildScopesRepository.h	1970-01-01 00:00:00 +0000
+++ include/unity/scopes/internal/ChildScopesRepository.h	2015-01-26 17:27:30 +0000
@@ -0,0 +1,68 @@
+/*
+ * Copyright (C) 2014 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Marcus Tomlinson <[e-mail]>
+ */
+
+#pragma once
+
+#include <unity/scopes/ChildScope.h>
+#include <unity/scopes/internal/Logger.h>
+#include <unity/util/NonCopyable.h>
+
+#include <list>
+#include <mutex>
+#include <string>
+
+namespace unity
+{
+
+namespace scopes
+{
+
+namespace internal
+{
+
+class ChildScopesRepository
+{
+public:
+    NONCOPYABLE(ChildScopesRepository);
+
+    ChildScopesRepository(std::string const& repo_file_path,
+                          boost::log::sources::severity_channel_logger_mt<>& logger);
+
+    ChildScopeList child_scopes_ordered(ChildScopeList const& child_scopes_unordered);
+    bool set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered);
+
+private:
+    bool write_repo(ChildScopeList const& child_scopes_list);
+    ChildScopeList read_repo();
+
+    std::string list_to_json(ChildScopeList const& child_scopes_list);
+    ChildScopeList json_to_list(std::string const& child_scopes_json);
+
+    std::string const repo_file_path_;
+    boost::log::sources::severity_channel_logger_mt<>& logger_;
+
+    std::mutex mutex_;
+    ChildScopeList cached_repo_;
+    bool have_latest_cache_;
+};
+
+} // namespace internal
+
+} // namespace scopes
+
+} // namespace unity

=== modified file 'include/unity/scopes/internal/MWScope.h'
--- include/unity/scopes/internal/MWScope.h	2014-11-03 05:31:30 +0000
+++ include/unity/scopes/internal/MWScope.h	2015-01-26 17:27:30 +0000
@@ -21,8 +21,9 @@
 #include <unity/scopes/internal/MWObjectProxy.h>
 #include <unity/scopes/internal/MWReplyProxyFwd.h>
 #include <unity/scopes/internal/MWScopeProxyFwd.h>
+#include <unity/scopes/CannedQuery.h>
+#include <unity/scopes/ChildScope.h>
 #include <unity/scopes/QueryCtrlProxyFwd.h>
-#include <unity/scopes/CannedQuery.h>
 #include <unity/scopes/Variant.h>
 
 namespace unity
@@ -43,6 +44,8 @@
     virtual QueryCtrlProxy activate(VariantMap const& result, VariantMap const& hints, MWReplyProxy const& reply) = 0;
     virtual QueryCtrlProxy perform_action(VariantMap const& result, VariantMap const& hints, std::string const& widget_id, std::string const& action_id, MWReplyProxy const& reply) = 0;
     virtual QueryCtrlProxy preview(VariantMap const& result, VariantMap const& hints, MWReplyProxy const& reply) = 0;
+    virtual ChildScopeList child_scopes_ordered() = 0;
+    virtual bool set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered) = 0;
     virtual bool debug_mode() = 0;
 
 protected:

=== modified file 'include/unity/scopes/internal/ScopeBaseImpl.h'
--- include/unity/scopes/internal/ScopeBaseImpl.h	2014-11-13 02:31:13 +0000
+++ include/unity/scopes/internal/ScopeBaseImpl.h	2015-01-26 17:27:30 +0000
@@ -18,6 +18,7 @@
 
 #pragma once
 
+#include <unity/scopes/ChildScope.h>
 #include <unity/scopes/RegistryProxyFwd.h>
 #include <unity/scopes/Variant.h>
 
@@ -33,6 +34,7 @@
 namespace internal
 {
 
+class ChildScopesRepository;
 class SettingsDB;
 
 class ScopeBaseImpl final
@@ -60,6 +62,12 @@
     void set_settings_db(std::shared_ptr<unity::scopes::internal::SettingsDB> const& db);
     unity::scopes::VariantMap settings() const;
 
+    void set_child_scopes_repo(std::shared_ptr<ChildScopesRepository> const& child_scopes_repo);
+
+    ChildScopeList child_scopes() const;
+    ChildScopeList child_scopes_ordered(ChildScopeList const& unordered_child_scopes) const;
+    bool set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered);
+
 private:
     std::string scope_directory_;
     bool scope_dir_initialized_;
@@ -79,6 +87,9 @@
     std::shared_ptr<unity::scopes::internal::SettingsDB> db_;
     bool settings_db_initialized_;
 
+    std::shared_ptr<ChildScopesRepository> child_scopes_repo_;
+    bool child_scopes_repo_initialized_;
+
     mutable std::mutex mutex_;
 };
 

=== modified file 'include/unity/scopes/internal/ScopeImpl.h'
--- include/unity/scopes/internal/ScopeImpl.h	2015-01-09 03:16:51 +0000
+++ include/unity/scopes/internal/ScopeImpl.h	2015-01-26 17:27:30 +0000
@@ -81,6 +81,9 @@
                                    ActionMetadata const& hints,
                                    PreviewListenerBase::SPtr const& reply) override;
 
+    virtual ChildScopeList child_scopes_ordered() override;
+    virtual bool set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered) override;
+
     static ScopeProxy create(MWScopeProxy const& mw_proxy, std::string const& scope_id);
 
 private:

=== modified file 'include/unity/scopes/internal/ScopeObject.h'
--- include/unity/scopes/internal/ScopeObject.h	2015-01-09 03:47:02 +0000
+++ include/unity/scopes/internal/ScopeObject.h	2015-01-26 17:27:30 +0000
@@ -76,6 +76,9 @@
                                      MWReplyProxy const& reply,
                                      InvokeInfo const& info) override;
 
+    virtual ChildScopeList child_scopes_ordered() const override;
+    virtual bool set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered) override;
+
     virtual bool debug_mode() const override;
 
 private:

=== modified file 'include/unity/scopes/internal/ScopeObjectBase.h'
--- include/unity/scopes/internal/ScopeObjectBase.h	2015-01-09 00:14:14 +0000
+++ include/unity/scopes/internal/ScopeObjectBase.h	2015-01-26 17:27:30 +0000
@@ -21,6 +21,7 @@
 #include <unity/scopes/internal/AbstractObject.h>
 #include <unity/scopes/internal/MWQueryCtrlProxyFwd.h>
 #include <unity/scopes/internal/MWReplyProxyFwd.h>
+#include <unity/scopes/ChildScope.h>
 #include <unity/scopes/Result.h>
 #include <unity/scopes/Variant.h>
 
@@ -67,6 +68,9 @@
                                      MWReplyProxy const& reply,
                                      InvokeInfo const& info) = 0;
 
+    virtual ChildScopeList child_scopes_ordered() const = 0;
+    virtual bool set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered) = 0;
+
     virtual bool debug_mode() const = 0;
 };
 

=== modified file 'include/unity/scopes/internal/smartscopes/SSScopeObject.h'
--- include/unity/scopes/internal/smartscopes/SSScopeObject.h	2015-01-20 04:14:26 +0000
+++ include/unity/scopes/internal/smartscopes/SSScopeObject.h	2015-01-26 17:27:30 +0000
@@ -73,6 +73,9 @@
                              MWReplyProxy const& reply,
                              InvokeInfo const& info) override;
 
+    ChildScopeList child_scopes_ordered() const override;
+    bool set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered) override;
+
     bool debug_mode() const override;
 
 private:

=== modified file 'include/unity/scopes/internal/zmq_middleware/ScopeI.h'
--- include/unity/scopes/internal/zmq_middleware/ScopeI.h	2014-11-03 05:31:30 +0000
+++ include/unity/scopes/internal/zmq_middleware/ScopeI.h	2015-01-26 17:27:30 +0000
@@ -53,6 +53,12 @@
     virtual void preview_(Current const& current,
                           capnp::AnyPointer::Reader& in_params,
                           capnproto::Response::Builder& r);
+    virtual void child_scopes_ordered_(Current const& current,
+                          capnp::AnyPointer::Reader& in_params,
+                          capnproto::Response::Builder& r);
+    virtual void set_child_scopes_ordered_(Current const& current,
+                          capnp::AnyPointer::Reader& in_params,
+                          capnproto::Response::Builder& r);
     virtual void debug_mode_(Current const& current,
                              capnp::AnyPointer::Reader& in_params,
                              capnproto::Response::Builder& r);

=== modified file 'include/unity/scopes/internal/zmq_middleware/ZmqScope.h'
--- include/unity/scopes/internal/zmq_middleware/ZmqScope.h	2014-11-03 05:31:30 +0000
+++ include/unity/scopes/internal/zmq_middleware/ZmqScope.h	2015-01-26 17:27:30 +0000
@@ -62,6 +62,9 @@
                                    VariantMap const& hints,
                                    MWReplyProxy const& reply) override;
 
+    virtual ChildScopeList child_scopes_ordered() override;
+    virtual bool set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered) override;
+
     virtual bool debug_mode() override;
 
 private:

=== modified file 'include/unity/scopes/testing/MockScope.h'
--- include/unity/scopes/testing/MockScope.h	2014-11-03 05:31:30 +0000
+++ include/unity/scopes/testing/MockScope.h	2015-01-26 17:27:30 +0000
@@ -63,6 +63,10 @@
     MOCK_METHOD3(preview, QueryCtrlProxy(unity::scopes::Result const&,
                                          ActionMetadata const&,
                                          PreviewListenerBase::SPtr const&));
+
+    MOCK_METHOD0(child_scopes_ordered, ChildScopeList());
+
+    MOCK_METHOD1(set_child_scopes_ordered, bool(ChildScopeList const&));
 };
 
 /// @endcond

=== added file 'src/scopes/AbstractScopeBase.cpp'
--- src/scopes/AbstractScopeBase.cpp	1970-01-01 00:00:00 +0000
+++ src/scopes/AbstractScopeBase.cpp	2015-01-26 17:27:30 +0000
@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2015 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Marcus Tomlinson <[e-mail]>
+ */
+
+#include <unity/scopes/AbstractScopeBase.h>
+
+namespace unity
+{
+
+namespace scopes
+{
+
+//! @cond
+
+AbstractScopeBase::AbstractScopeBase() = default;
+
+AbstractScopeBase::~AbstractScopeBase() = default;
+
+//! @endcond
+
+} // namespace scopes
+
+} // namespace unity

=== modified file 'src/scopes/CMakeLists.txt'
--- src/scopes/CMakeLists.txt	2014-11-07 15:19:47 +0000
+++ src/scopes/CMakeLists.txt	2015-01-26 17:27:30 +0000
@@ -5,6 +5,7 @@
 set(CAPNPROTO_FILES ${CAPNPROTO_FILES} PARENT_SCOPE)
 
 set(SRC
+    ${CMAKE_CURRENT_SOURCE_DIR}/AbstractScopeBase.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/ActionMetadata.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/ActivationListenerBase.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/ActivationQueryBase.cpp

=== modified file 'src/scopes/Runtime.cpp'
--- src/scopes/Runtime.cpp	2014-12-04 04:33:50 +0000
+++ src/scopes/Runtime.cpp	2015-01-26 17:27:30 +0000
@@ -67,11 +67,6 @@
     p->run_scope(scope_base, scope_ini_file);
 }
 
-void Runtime::run_scope(ScopeBase* const scope_base, std::string const&, std::string const& scope_ini_file)
-{
-    p->run_scope(scope_base, scope_ini_file);
-}
-
 ObjectProxy Runtime::string_to_proxy(string const& s) const
 {
     return p->string_to_proxy(s);

=== modified file 'src/scopes/ScopeBase.cpp'
--- src/scopes/ScopeBase.cpp	2014-11-13 02:47:29 +0000
+++ src/scopes/ScopeBase.cpp	2015-01-26 17:27:30 +0000
@@ -102,6 +102,16 @@
     return p->settings();
 }
 
+ChildScopeList ScopeBase::child_scopes() const
+{
+    return p->child_scopes();
+}
+
+ChildScopeList ScopeBase::child_scopes_ordered() const
+{
+    return p->child_scopes_ordered(child_scopes());
+}
+
 } // namespace scopes
 
 } // namespace unity

=== modified file 'src/scopes/internal/CMakeLists.txt'
--- src/scopes/internal/CMakeLists.txt	2014-12-01 14:12:24 +0000
+++ src/scopes/internal/CMakeLists.txt	2015-01-26 17:27:30 +0000
@@ -16,6 +16,7 @@
     ${CMAKE_CURRENT_SOURCE_DIR}/CategoryImpl.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CategoryRegistry.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CategoryRendererImpl.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/ChildScopesRepository.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/ColumnLayoutImpl.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/CompletionDetailsImpl.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/ConfigBase.cpp

=== added file 'src/scopes/internal/ChildScopesRepository.cpp'
--- src/scopes/internal/ChildScopesRepository.cpp	1970-01-01 00:00:00 +0000
+++ src/scopes/internal/ChildScopesRepository.cpp	2015-01-26 17:27:30 +0000
@@ -0,0 +1,243 @@
+/*
+ * Copyright (C) 2014 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Marcus Tomlinson <[e-mail]>
+ */
+
+#include <unity/scopes/internal/ChildScopesRepository.h>
+#include <unity/scopes/internal/JsonCppNode.h>
+
+#include <fstream>
+#include <set>
+#include <sstream>
+
+using namespace unity::scopes;
+using namespace unity::scopes::internal;
+
+ChildScopesRepository::ChildScopesRepository(std::string const& repo_file_path,
+                                             boost::log::sources::severity_channel_logger_mt<>& logger)
+    : repo_file_path_(repo_file_path)
+    , logger_(logger)
+    , have_latest_cache_(false)
+{
+}
+
+ChildScopeList ChildScopesRepository::child_scopes_ordered(ChildScopeList const& child_scopes_unordered)
+{
+    std::lock_guard<std::mutex> lock(mutex_);
+
+    // unordered_set and ordered_set will act as masks for child_scopes_unordered and
+    // child_scopes_ordered respectively when creating our resultant child scope list
+    std::set<std::string> unordered_set;
+    std::set<std::string> ordered_set;
+
+    // fill unordered_set
+    for (auto const& child : child_scopes_unordered)
+    {
+        unordered_set.insert(child.id);
+    }
+
+    // fill ordered_set
+    ChildScopeList child_scopes_ordered = read_repo();
+    for (auto const& child : child_scopes_ordered)
+    {
+        // scopes in child_scopes_ordered that are also in child_scopes_unordered should be removed
+        // from unordered_set (to avoid duplicates in our resultant child scope list)
+        if (unordered_set.erase(child.id) > 0)
+        {
+            // only the scopes from child_scopes_ordered that appear in child_scopes_unordered
+            // should be added to ordered_set (a scope not found in child_scopes_unordered was
+            // probably uninstalled since the repo was last written)
+            ordered_set.insert(child.id);
+        }
+    }
+
+    // has anything changed since the repo was last written?
+    if (child_scopes_ordered.size() == ordered_set.size() && // if no scopes have been removed
+        unordered_set.size() == 0)                           // and no scopes have been added
+    {
+        return child_scopes_ordered; // return the repo list as is
+    }
+
+    // now create a new list by first adding child_scopes_ordered then child_scopes_unordered,
+    // using each set as a mask to determine whether or not a scope should be included
+    ChildScopeList new_child_scopes_ordered;
+    {
+        // add child_scopes_ordered to new_child_scopes_ordered
+        if (child_scopes_ordered.size() == ordered_set.size())
+        {
+            new_child_scopes_ordered = child_scopes_ordered;
+        }
+        else if (!ordered_set.empty())
+        {
+            // use ordered_set as a mask
+            for (auto const& child : child_scopes_ordered)
+            {
+                if (ordered_set.find(child.id) != ordered_set.end())
+                {
+                    new_child_scopes_ordered.push_back(child);
+                }
+            }
+        }
+
+        // add child_scopes_unordered to new_child_scopes_ordered
+        if (child_scopes_unordered.size() == unordered_set.size())
+        {
+            new_child_scopes_ordered.insert(new_child_scopes_ordered.end(),
+                                            child_scopes_unordered.begin(),
+                                            child_scopes_unordered.end());
+        }
+        else if (!unordered_set.empty())
+        {
+            // use unordered_set as a mask
+            for (auto const& child : child_scopes_unordered)
+            {
+                if (unordered_set.find(child.id) != unordered_set.end())
+                {
+                    new_child_scopes_ordered.push_back(child);
+                }
+            }
+        }
+    }
+
+    // write the new ordered list to file
+    write_repo(new_child_scopes_ordered);
+    return new_child_scopes_ordered;
+}
+
+bool ChildScopesRepository::set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered)
+{
+    // simply write child_scopes_ordered to file
+    std::lock_guard<std::mutex> lock(mutex_);
+    return write_repo(child_scopes_ordered);
+}
+
+bool ChildScopesRepository::write_repo(ChildScopeList const& child_scopes_list)
+{
+    assert(!mutex_.try_lock());
+
+    // open repository for output
+    std::ofstream repo_file(repo_file_path_);
+    if (repo_file.fail())
+    {
+        BOOST_LOG_SEV(logger_, Logger::Error) << "ChildScopesRepository::write_repo(): "
+                                              << "Failed to open file: \"" << repo_file_path_
+                                              << "\"";
+        return false;
+    }
+
+    repo_file << list_to_json(child_scopes_list);
+    repo_file.close();
+
+    cached_repo_ = child_scopes_list;
+    have_latest_cache_ = true;
+    return true;
+}
+
+ChildScopeList ChildScopesRepository::read_repo()
+{
+    // if we already have the latest cache of the repo, simply return it
+    if (have_latest_cache_)
+    {
+        return cached_repo_;
+    }
+
+    // open repository for input
+    std::ifstream repo_file(repo_file_path_);
+    if (repo_file.fail())
+    {
+        BOOST_LOG_SEV(logger_, Logger::Info) << "ChildScopesRepository::read_repo(): "
+                                             << "Failed to open file: \"" << repo_file_path_
+                                             << "\"";
+        return ChildScopeList();
+    }
+
+    cached_repo_ = json_to_list(std::string((std::istreambuf_iterator<char>(repo_file)),
+                                            std::istreambuf_iterator<char>()));
+    repo_file.close();
+
+    have_latest_cache_ = true;
+    return cached_repo_;
+}
+
+std::string ChildScopesRepository::list_to_json(ChildScopeList const& child_scopes_list)
+{
+    std::ostringstream child_scopes_json;
+    child_scopes_json << "[";
+    for (auto const& child_scope : child_scopes_list)
+    {
+        child_scopes_json << (child_scopes_json.tellp() == 1 ? "{" : ",{");
+        child_scopes_json << "\"id\":\"" << child_scope.id << "\"";
+        child_scopes_json << ",";
+        child_scopes_json << "\"enabled\":" << (child_scope.enabled ? "true" : "false");
+        child_scopes_json << "}";
+    }
+    child_scopes_json << "]";
+    return child_scopes_json.str();
+}
+
+ChildScopeList ChildScopesRepository::json_to_list(std::string const& child_scopes_json)
+{
+    JsonCppNode json_node;
+    try
+    {
+        json_node.read_json(child_scopes_json);
+    }
+    catch (std::exception const& e)
+    {
+        BOOST_LOG_SEV(logger_, Logger::Error) << "ChildScopesRepository::json_to_list(): "
+                                              << "Exception thrown while reading json string: "
+                                              << e.what();
+        return ChildScopeList();
+    }
+    if (json_node.type() != JsonCppNode::Array)
+    {
+        BOOST_LOG_SEV(logger_, Logger::Error) << "ChildScopesRepository::json_to_list(): "
+                                              << "Root node of json string is not an array:"
+                                              << std::endl << child_scopes_json;
+        return ChildScopeList();
+    }
+
+    ChildScopeList return_list;
+    for (int i = 0; i < json_node.size(); ++i)
+    {
+        auto child_node = json_node.get_node(i);
+
+        if (!child_node->has_node("id") ||
+            !child_node->has_node("enabled"))
+        {
+            BOOST_LOG_SEV(logger_, Logger::Error) << "ChildScopesRepository::json_to_list(): "
+                                                  << "Child node is missing a required field. "
+                                                  << "Skipping child node:" << std::endl
+                                                  << child_node->to_json_string();
+            continue;
+        }
+        auto id_node = child_node->get_node("id");
+        auto enabled_node = child_node->get_node("enabled");
+
+        if (id_node->type() != JsonCppNode::String ||
+            enabled_node->type() != JsonCppNode::Bool)
+        {
+            BOOST_LOG_SEV(logger_, Logger::Error) << "ChildScopesRepository::json_to_list(): "
+                                                  << "Child node contains an invalid value type. "
+                                                  << "Skipping child node:" << std::endl
+                                                  << child_node->to_json_string();
+            continue;
+        }
+        return_list.push_back( ChildScope{id_node->as_string(),
+                                          enabled_node->as_bool()} );
+    }
+    return return_list;
+}

=== modified file 'src/scopes/internal/RuntimeImpl.cpp'
--- src/scopes/internal/RuntimeImpl.cpp	2015-01-18 23:48:55 +0000
+++ src/scopes/internal/RuntimeImpl.cpp	2015-01-26 17:27:30 +0000
@@ -18,6 +18,7 @@
 
 #include <unity/scopes/internal/RuntimeImpl.h>
 
+#include <unity/scopes/internal/ChildScopesRepository.h>
 #include <unity/scopes/internal/DfltConfig.h>
 #include <unity/scopes/internal/Logger.h>
 #include <unity/scopes/internal/MWStateReceiver.h>
@@ -388,6 +389,12 @@
         {
             scope_base->p->set_settings_db(nullptr);
         }
+
+        // Configure the child scopes repository
+        string child_scopes_repo = config_dir + "/child-scopes.json";
+
+        auto repo = make_shared<ChildScopesRepository>(child_scopes_repo, logger());
+        scope_base->p->set_child_scopes_repo(repo);
     }
 
     scope_base->p->set_registry(registry_);

=== modified file 'src/scopes/internal/ScopeBaseImpl.cpp'
--- src/scopes/internal/ScopeBaseImpl.cpp	2015-01-14 02:19:17 +0000
+++ src/scopes/internal/ScopeBaseImpl.cpp	2015-01-26 17:27:30 +0000
@@ -19,7 +19,9 @@
 #include <unity/scopes/internal/ScopeBaseImpl.h>
 
 #include <unity/UnityExceptions.h>
+#include <unity/scopes/internal/ChildScopesRepository.h>
 #include <unity/scopes/internal/SettingsDB.h>
+#include <unity/scopes/Registry.h>
 #include <unity/scopes/ScopeExceptions.h>
 
 using namespace unity;
@@ -42,6 +44,7 @@
     , tmp_dir_initialized_(false)
     , registry_initialized_(false)
     , settings_db_initialized_(false)
+    , child_scopes_repo_initialized_(false)
 {
 }
 
@@ -171,6 +174,53 @@
     return db_ ? db_->settings() : VariantMap();
 }
 
+void ScopeBaseImpl::set_child_scopes_repo(std::shared_ptr<ChildScopesRepository> const& child_scopes_repo)
+{
+    lock_guard<mutex> lock(mutex_);
+    child_scopes_repo_ = child_scopes_repo;
+    child_scopes_repo_initialized_ = true;
+}
+
+ChildScopeList ScopeBaseImpl::child_scopes() const
+{
+    // Get a copy of the registry proxy
+    RegistryProxy reg = registry();
+    if (!reg)
+    {
+        return ChildScopeList();
+    }
+
+    // The default behaviour of this method is to simply return all available scopes on the system.
+    ChildScopeList return_list;
+    auto all_scopes = reg->list();
+    for (auto const& scope : all_scopes)
+    {
+        // New scopes are added disabled by default
+        return_list.push_back( ChildScope{scope.first, false} );
+    }
+    return return_list;
+}
+
+ChildScopeList ScopeBaseImpl::child_scopes_ordered(ChildScopeList const& child_scopes_unordered) const
+{
+    lock_guard<mutex> lock(mutex_);
+    if (!child_scopes_repo_initialized_)
+    {
+        throw LogicException("ScopeBase::child_scopes_ordered() cannot be called from constructor");
+    }
+    return child_scopes_repo_ ? child_scopes_repo_->child_scopes_ordered(child_scopes_unordered) : ChildScopeList();
+}
+
+bool ScopeBaseImpl::set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered)
+{
+    lock_guard<mutex> lock(mutex_);
+    if (!child_scopes_repo_initialized_)
+    {
+        throw LogicException("ScopeBase::set_child_scopes_ordered() cannot be called from constructor");
+    }
+    return child_scopes_repo_ ? child_scopes_repo_->set_child_scopes_ordered(child_scopes_ordered) : false;
+}
+
 } // namespace internal
 
 } // namespace scopes

=== modified file 'src/scopes/internal/ScopeImpl.cpp'
--- src/scopes/internal/ScopeImpl.cpp	2015-01-09 03:16:51 +0000
+++ src/scopes/internal/ScopeImpl.cpp	2015-01-26 17:27:30 +0000
@@ -283,6 +283,16 @@
     return ctrl;
 }
 
+ChildScopeList ScopeImpl::child_scopes_ordered()
+{
+    return fwd()->child_scopes_ordered();
+}
+
+bool ScopeImpl::set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered)
+{
+    return fwd()->set_child_scopes_ordered(child_scopes_ordered);
+}
+
 ScopeProxy ScopeImpl::create(MWScopeProxy const& mw_proxy, std::string const& scope_id)
 {
     return make_shared<ScopeImpl>(mw_proxy, scope_id);

=== modified file 'src/scopes/internal/ScopeObject.cpp'
--- src/scopes/internal/ScopeObject.cpp	2015-01-09 03:47:02 +0000
+++ src/scopes/internal/ScopeObject.cpp	2015-01-26 17:27:30 +0000
@@ -213,6 +213,16 @@
     );
 }
 
+ChildScopeList ScopeObject::child_scopes_ordered() const
+{
+    return scope_base_->child_scopes_ordered();
+}
+
+bool ScopeObject::set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered)
+{
+    return scope_base_->p->set_child_scopes_ordered(child_scopes_ordered);
+}
+
 bool ScopeObject::debug_mode() const
 {
     return debug_mode_;

=== modified file 'src/scopes/internal/smartscopes/SSScopeObject.cpp'
--- src/scopes/internal/smartscopes/SSScopeObject.cpp	2015-01-09 03:16:51 +0000
+++ src/scopes/internal/smartscopes/SSScopeObject.cpp	2015-01-26 17:27:30 +0000
@@ -191,6 +191,16 @@
     return info.mw->create_query_ctrl_proxy(reply->identity() + ".c", info.mw->get_query_ctrl_endpoint());
 }
 
+ChildScopeList SSScopeObject::child_scopes_ordered() const
+{
+    return ChildScopeList();
+}
+
+bool SSScopeObject::set_child_scopes_ordered(ChildScopeList const&)
+{
+    return false;
+}
+
 bool SSScopeObject::debug_mode() const
 {
     return false;

=== modified file 'src/scopes/internal/zmq_middleware/ScopeI.cpp'
--- src/scopes/internal/zmq_middleware/ScopeI.cpp	2014-11-18 07:04:04 +0000
+++ src/scopes/internal/zmq_middleware/ScopeI.cpp	2015-01-26 17:27:30 +0000
@@ -60,6 +60,8 @@
     QueryCtrl* preview(ValueDict result, ValueDict hints, Reply* replyProxy);
     QueryCtrl* perform_action(ValueDict result, ValueDict hints, string action_id, Reply* replyProxy);
     QueryCtrl* activate(ValueDict result, ValueDict hints, Reply* replyProxy);
+    ChildScopeList child_scopes_ordered();
+    bool set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered);
     bool debug_mode();
 };
 
@@ -73,6 +75,8 @@
                       { "preview", bind(&ScopeI::preview_, this, ph::_1, ph::_2, ph::_3) },
                       { "activate", bind(&ScopeI::activate_, this, ph::_1, ph::_2, ph::_3) },
                       { "perform_action", bind(&ScopeI::perform_action_, this, ph::_1, ph::_2, ph::_3) },
+                      { "child_scopes_ordered", bind(&ScopeI::child_scopes_ordered_, this, ph::_1, ph::_2, ph::_3) },
+                      { "set_child_scopes_ordered", bind(&ScopeI::set_child_scopes_ordered_, this, ph::_1, ph::_2, ph::_3) },
                       { "debug_mode", bind(&ScopeI::debug_mode_, this, ph::_1, ph::_2, ph::_3) }
     })
 {
@@ -194,6 +198,51 @@
     p.setCategory(ctrl_proxy->target_category().c_str());
 }
 
+void ScopeI::child_scopes_ordered_(Current const&,
+                      capnp::AnyPointer::Reader&,
+                      capnproto::Response::Builder& r)
+{
+    auto delegate = dynamic_pointer_cast<ScopeObjectBase>(del());
+    assert(delegate);
+
+    auto child_scopes_ordered = delegate->child_scopes_ordered();
+
+    r.setStatus(capnproto::ResponseStatus::SUCCESS);
+    auto list_response = r.initPayload().getAs<capnproto::Scope::ChildScopesOrderedResponse>();
+    auto list = list_response.initReturnValue(child_scopes_ordered.size());
+
+    int i = 0;
+    for (auto const& child_scope : child_scopes_ordered)
+    {
+        list[i].setId(child_scope.id);
+        list[i].setEnabled(child_scope.enabled);
+        ++i;
+    }
+}
+
+void ScopeI::set_child_scopes_ordered_(Current const&,
+                      capnp::AnyPointer::Reader& in_params,
+                      capnproto::Response::Builder& r)
+{
+    auto delegate = std::dynamic_pointer_cast<ScopeObjectBase>(del());
+    assert(delegate);
+
+    auto list = in_params.getAs<capnproto::Scope::SetChildScopesOrderedRequest>().getChildScopesOrdered();
+
+    ChildScopeList child_scope_list;
+    for (size_t i = 0; i < list.size(); ++i)
+    {
+        string id = list[i].getId();
+        bool enabled = list[i].getEnabled();
+        child_scope_list.push_back( ChildScope{id, enabled} );
+    }
+
+    bool result = delegate->set_child_scopes_ordered(child_scope_list);
+    r.setStatus(capnproto::ResponseStatus::SUCCESS);
+    auto response = r.initPayload().getAs<capnproto::Scope::SetChildScopesOrderedResponse>();
+    response.setReturnValue(result);
+}
+
 void ScopeI::debug_mode_(Current const&,
                          capnp::AnyPointer::Reader&,
                          capnproto::Response::Builder& r)

=== modified file 'src/scopes/internal/zmq_middleware/ZmqScope.cpp'
--- src/scopes/internal/zmq_middleware/ZmqScope.cpp	2015-01-09 03:16:51 +0000
+++ src/scopes/internal/zmq_middleware/ZmqScope.cpp	2015-01-26 17:27:30 +0000
@@ -56,6 +56,8 @@
     QueryCtrl* activate(string query, ValueDict hints, Reply* replyProxy);
     QueryCtrl* perform_action(string query, ValueDict hints, string action_id, Reply* replyProxy);
     QueryCtrl* preview(string query, ValueDict hints, Reply* replyProxy);
+    ChildScopeList child_scopes_ordered();
+    bool set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered);
     bool debug_mode();
 };
 
@@ -200,6 +202,54 @@
     return make_shared<QueryCtrlImpl>(p, reply_proxy);
 }
 
+ChildScopeList ZmqScope::child_scopes_ordered()
+{
+    capnp::MallocMessageBuilder request_builder;
+    make_request_(request_builder, "child_scopes_ordered");
+
+    auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_scope_(request_builder); });
+
+    auto out_params = future.get();
+    auto response = out_params.reader->getRoot<capnproto::Response>();
+    throw_if_runtime_exception(response);
+
+    auto list = response.getPayload().getAs<capnproto::Scope::ChildScopesOrderedResponse>().getReturnValue();
+
+    ChildScopeList child_scope_list;
+    for (size_t i = 0; i < list.size(); ++i)
+    {
+        string id = list[i].getId();
+        bool enabled = list[i].getEnabled();
+        child_scope_list.push_back( ChildScope{id, enabled} );
+    }
+    return child_scope_list;
+}
+
+bool ZmqScope::set_child_scopes_ordered(ChildScopeList const& child_scopes_ordered)
+{
+    capnp::MallocMessageBuilder request_builder;
+    auto request = make_request_(request_builder, "set_child_scopes_ordered");
+
+    auto in_params = request.initInParams().getAs<capnproto::Scope::SetChildScopesOrderedRequest>();
+    auto list = in_params.initChildScopesOrdered(child_scopes_ordered.size());
+
+    int i = 0;
+    for (auto const& child_scope : child_scopes_ordered)
+    {
+        list[i].setId(child_scope.id);
+        list[i].setEnabled(child_scope.enabled);
+        ++i;
+    }
+
+    auto future = mw_base()->twoway_pool()->submit([&] { return this->invoke_scope_(request_builder); });
+    auto out_params = future.get();
+    auto r = out_params.reader->getRoot<capnproto::Response>();
+    throw_if_runtime_exception(r);
+
+    auto response = r.getPayload().getAs<capnproto::Scope::SetChildScopesOrderedResponse>();
+    return response.getReturnValue();
+}
+
 bool ZmqScope::debug_mode()
 {
     lock_guard<std::mutex> lock(debug_mode_mutex_);

=== modified file 'src/scopes/internal/zmq_middleware/capnproto/Scope.capnp'
--- src/scopes/internal/zmq_middleware/capnproto/Scope.capnp	2014-08-12 13:26:35 +0000
+++ src/scopes/internal/zmq_middleware/capnproto/Scope.capnp	2015-01-26 17:27:30 +0000
@@ -76,6 +76,27 @@
     replyProxy @2 : Proxy.Proxy;
 }
 
+struct ChildScope
+{
+    id      @0 : Text;
+    enabled @1 : Bool;
+}
+
+struct ChildScopesOrderedResponse
+{
+    returnValue @0 : List(ChildScope);
+}
+
+struct SetChildScopesOrderedRequest
+{
+    childScopesOrdered @0 : List(ChildScope);
+}
+
+struct SetChildScopesOrderedResponse
+{
+    returnValue @0 : Bool;
+}
+
 struct DebugModeResponse
 {
     returnValue @0 : Bool;

=== modified file 'test/gtest/scopes/CMakeLists.txt'
--- test/gtest/scopes/CMakeLists.txt	2014-12-01 01:51:38 +0000
+++ test/gtest/scopes/CMakeLists.txt	2015-01-26 17:27:30 +0000
@@ -13,6 +13,7 @@
 add_subdirectory(CategorisedResult)
 add_subdirectory(Category)
 add_subdirectory(CategoryRenderer)
+add_subdirectory(ChildScopes)
 add_subdirectory(ColumnLayout)
 add_subdirectory(Department)
 add_subdirectory(Filters)

=== added directory 'test/gtest/scopes/ChildScopes'
=== added file 'test/gtest/scopes/ChildScopes/CMakeLists.txt'
--- test/gtest/scopes/ChildScopes/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/ChildScopes/CMakeLists.txt	2015-01-26 17:27:30 +0000
@@ -0,0 +1,10 @@
+configure_file(Registry.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Registry.ini)
+configure_file(Runtime.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Runtime.ini)
+configure_file(Zmq.ini.in ${CMAKE_CURRENT_BINARY_DIR}/Zmq.ini)
+
+add_definitions(-DTEST_BIN_DIR="${CMAKE_CURRENT_BINARY_DIR}")
+
+add_executable(ChildScopes_test ChildScopes_test.cpp)
+target_link_libraries(ChildScopes_test ${TESTLIBS})
+
+add_test(ChildScopes ChildScopes_test)

=== added file 'test/gtest/scopes/ChildScopes/ChildScopes_test.cpp'
--- test/gtest/scopes/ChildScopes/ChildScopes_test.cpp	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/ChildScopes/ChildScopes_test.cpp	2015-01-26 17:27:30 +0000
@@ -0,0 +1,325 @@
+/*
+ * Copyright (C) 2014 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Marcus Tomlinson <[e-mail]>
+ */
+
+#include <unity/scopes/ChildScope.h>
+
+#include <unity/scopes/internal/RegistryObject.h>
+#include <unity/scopes/internal/ScopeImpl.h>
+
+#include "TestScope.h"
+
+#include <boost/filesystem/operations.hpp>
+#include <fstream>
+#include <gtest/gtest.h>
+
+using namespace boost;
+using namespace testing;
+using namespace unity::scopes;
+using namespace unity::scopes::internal;
+
+std::shared_ptr<core::posix::SignalTrap> trap(core::posix::trap_signals_for_all_subsequent_threads({core::posix::Signal::sig_chld}));
+std::unique_ptr<core::posix::ChildProcess::DeathObserver> death_observer(core::posix::ChildProcess::DeathObserver::create_once_with_signal_trap(trap));
+
+class ChildScopesTest : public Test
+{
+public:
+    ChildScopesTest()
+    {
+        // Run a test registry
+        reg_rt_ = RuntimeImpl::create("TestRegistry", "Runtime.ini");
+        auto reg_mw = reg_rt_->factory()->create("TestRegistry", "Zmq", "Zmq.ini");
+        auto reg_obj(std::make_shared<RegistryObject>(*death_observer, std::make_shared<Executor>(), reg_mw));
+        reg_mw->add_registry_object("TestRegistry", reg_obj);
+
+        // Create a proxy to TestScope
+        proxy_rt_ = RuntimeImpl::create("", "Runtime.ini");
+        auto scope_mw = proxy_rt_->factory()->create("TestScope", "Zmq", "Zmq.ini");
+        scope_mw->start();
+        auto proxy = scope_mw->create_scope_proxy("TestScope");
+        test_scope = ScopeImpl::create(proxy, "TestScope");
+    }
+
+    ~ChildScopesTest()
+    {
+        stop_test_scope();
+    }
+
+    void create_config_dir()
+    {
+        // Create an empty config directory for TestScope
+        system::error_code ec;
+        filesystem::create_directory(TEST_BIN_DIR "/TestScope", ec);
+    }
+
+    void remove_config_dir()
+    {
+        // Remove the config directory for TestScope
+        system::error_code ec;
+        filesystem::remove_all(TEST_BIN_DIR "/TestScope", ec);
+    }
+
+    void write_empty_config()
+    {
+        // open repository for output
+        std::ofstream repo_file(TEST_BIN_DIR "/TestScope/child-scopes.json");
+        repo_file << "";
+        repo_file.close();
+    }
+
+    void write_corrupt_config()
+    {
+        // open repository for output
+        std::ofstream repo_file(TEST_BIN_DIR "/TestScope/child-scopes.json");
+        repo_file << "ag;hasd;glasd;glkasdhg;klasdf;k;";
+        repo_file.close();
+    }
+
+    void write_partially_corrupt_config()
+    {
+        // open repository for output
+        std::ofstream repo_file(TEST_BIN_DIR "/TestScope/child-scopes.json");
+        repo_file << R"([{"id":"ScopeB","enabled":true},{"id":"ScopeB"},{"id":"ScopeC","enabled":"false"}])";
+        repo_file.close();
+    }
+
+    void start_test_scope()
+    {
+        // Run TestScope in a separate thread
+        scope_rt_ = Runtime::create_scope_runtime("TestScope", "Runtime.ini");
+        scope_t_ = std::thread([this]
+        {
+            TestScope scope;
+            scope_rt_->run_scope(&scope, "");
+        });
+
+        // Give the scope some time to bind to its endpoint
+        std::this_thread::sleep_for(std::chrono::milliseconds(500));
+    }
+
+    void stop_test_scope()
+    {
+        if (scope_rt_)
+        {
+            scope_rt_->destroy();
+        }
+        if (scope_t_.joinable())
+        {
+            scope_t_.join();
+        }
+    }
+
+protected:
+    ScopeProxy test_scope;
+
+private:
+    RuntimeImpl::UPtr reg_rt_;
+    RuntimeImpl::UPtr proxy_rt_;
+    Runtime::UPtr scope_rt_;
+    std::thread scope_t_;
+};
+
+TEST_F(ChildScopesTest, get_set_ordered_list)
+{
+    // Create an empty config directory for TestScope
+    remove_config_dir();
+    create_config_dir();
+
+    // Start TestScope
+    start_test_scope();
+
+    // 1st TestScope::child_scopes() returns: "A,B,C"
+    // No order has been set yet, so we should just get: "A,B,C"
+    ChildScopeList return_list = test_scope->child_scopes_ordered();
+    EXPECT_EQ(3, return_list.size());
+    EXPECT_EQ("ScopeA", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeB", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeC", return_list.front().id);
+    EXPECT_TRUE(return_list.front().enabled);
+
+    // Set order to: "B,E,A"
+    ChildScopeList list;
+    list.push_back({"ScopeB", false});
+    list.push_back({"ScopeE", false});
+    list.push_back({"ScopeA", true});
+    EXPECT_TRUE(test_scope->set_child_scopes_ordered(list));
+
+    // 2nd TestScope::child_scopes() returns: "D,A,B,C,E"
+    // with order: "B,E,A", we should get: "B,E,A,D,C"
+    return_list = test_scope->child_scopes_ordered();
+    EXPECT_EQ(5, return_list.size());
+    EXPECT_EQ("ScopeB", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeE", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeA", return_list.front().id);
+    EXPECT_TRUE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeD", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeC", return_list.front().id);
+    EXPECT_TRUE(return_list.front().enabled);
+
+    // 3rd+ TestScope::child_scopes() returns: "D,A,B"
+    // with order: "B,E,A,D,C", we should get: "B,A,D"
+    return_list = test_scope->child_scopes_ordered();
+    EXPECT_EQ(3, return_list.size());
+    EXPECT_EQ("ScopeB", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeA", return_list.front().id);
+    EXPECT_TRUE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeD", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+
+    // Set order to: "B,D,X,A"
+    list.clear();
+    list.push_back({"ScopeB", false});
+    list.push_back({"ScopeD", true});
+    list.push_back({"ScopeX", true});
+    list.push_back({"ScopeA", false});
+    EXPECT_TRUE(test_scope->set_child_scopes_ordered(list));
+
+    // 3rd+ TestScope::child_scopes() returns: "D,A,B"
+    // with order: "B,D,X,A", we should get: "B,D,A"
+    return_list = test_scope->child_scopes_ordered();
+    return_list = test_scope->child_scopes_ordered();
+    EXPECT_EQ(3, return_list.size());
+    EXPECT_EQ("ScopeB", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeD", return_list.front().id);
+    EXPECT_TRUE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeA", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+}
+
+TEST_F(ChildScopesTest, existing_config)
+{
+    // Use config from previous test
+    // Start TestScope
+    start_test_scope();
+
+    // 1st TestScope::child_scopes() returns: "A,B,C"
+    // with order: "B,D,A" (from previous test), we should get: "B,A,C"
+    ChildScopeList return_list = test_scope->child_scopes_ordered();
+    EXPECT_EQ(3, return_list.size());
+    EXPECT_EQ("ScopeB", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeA", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeC", return_list.front().id);
+    EXPECT_TRUE(return_list.front().enabled);
+}
+
+TEST_F(ChildScopesTest, no_config_dir)
+{
+    // Remove the config directory for TestScope
+    remove_config_dir();
+
+    // Start TestScope
+    start_test_scope();
+
+    // Set order to: "B,A,C" (should fail)
+    ChildScopeList list;
+    list.push_back({"ScopeB", false});
+    list.push_back({"ScopeA", false});
+    list.push_back({"ScopeC", true});
+    EXPECT_FALSE(test_scope->set_child_scopes_ordered(list));
+
+    // 1st TestScope::child_scopes() returns: "A,B,C"
+    // No order was set, so we should just get: "A,B,C"
+    ChildScopeList return_list = test_scope->child_scopes_ordered();
+    EXPECT_EQ(3, return_list.size());
+    EXPECT_EQ("ScopeA", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeB", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeC", return_list.front().id);
+    EXPECT_TRUE(return_list.front().enabled);
+}
+
+TEST_F(ChildScopesTest, corrupted_config)
+{
+    // Create an empty config directory for TestScope
+    remove_config_dir();
+    create_config_dir();
+
+    // Partially corrupt config (Sets order to: "B")
+    write_partially_corrupt_config();
+    start_test_scope();
+
+    // 1st TestScope::child_scopes() returns: "A,B,C"
+    // with partial order: "B", we should get: "B,A,C"
+    ChildScopeList return_list = test_scope->child_scopes_ordered();
+    EXPECT_EQ(3, return_list.size());
+    EXPECT_EQ("ScopeB", return_list.front().id);
+    EXPECT_TRUE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeA", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeC", return_list.front().id);
+    EXPECT_TRUE(return_list.front().enabled);
+
+    // Empty config
+    write_empty_config();
+    stop_test_scope();
+    start_test_scope();
+
+    // Check that nothing crashes and we simply get the list from the scope as is
+    return_list = test_scope->child_scopes_ordered();
+    EXPECT_EQ(3, return_list.size());
+    EXPECT_EQ("ScopeA", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeB", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeC", return_list.front().id);
+    EXPECT_TRUE(return_list.front().enabled);
+
+    // Corrupt config
+    write_corrupt_config();
+    stop_test_scope();
+    start_test_scope();
+
+    // Check that nothing crashes and we simply get the list from the scope as is
+    return_list = test_scope->child_scopes_ordered();
+    EXPECT_EQ(3, return_list.size());
+    EXPECT_EQ("ScopeA", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeB", return_list.front().id);
+    EXPECT_FALSE(return_list.front().enabled);
+    return_list.pop_front();
+    EXPECT_EQ("ScopeC", return_list.front().id);
+    EXPECT_TRUE(return_list.front().enabled);
+}

=== added file 'test/gtest/scopes/ChildScopes/Registry.ini.in'
--- test/gtest/scopes/ChildScopes/Registry.ini.in	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/ChildScopes/Registry.ini.in	2015-01-26 17:27:30 +0000
@@ -0,0 +1,6 @@
+[Registry]
+Middleware = Zmq
+Zmq.ConfigFile = Zmq.ini
+Scope.InstallDir = /unused
+Click.InstallDir = /unused
+Scoperunner.Path = /unused

=== added file 'test/gtest/scopes/ChildScopes/Runtime.ini.in'
--- test/gtest/scopes/ChildScopes/Runtime.ini.in	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/ChildScopes/Runtime.ini.in	2015-01-26 17:27:30 +0000
@@ -0,0 +1,6 @@
+[Runtime]
+Registry.Identity = TestRegistry
+Registry.ConfigFile = Registry.ini
+Default.Middleware = Zmq
+Zmq.ConfigFile = Zmq.ini
+ConfigDir = @CMAKE_CURRENT_BINARY_DIR@

=== added file 'test/gtest/scopes/ChildScopes/TestScope.h'
--- test/gtest/scopes/ChildScopes/TestScope.h	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/ChildScopes/TestScope.h	2015-01-26 17:27:30 +0000
@@ -0,0 +1,83 @@
+/*
+ * Copyright (C) 2014 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Marcus Tomlinson <[e-mail]>
+ */
+
+#pragma once
+
+#include <unity/scopes/ScopeBase.h>
+
+namespace unity
+{
+
+namespace scopes
+{
+
+class TestScope : public ScopeBase
+{
+public:
+    SearchQueryBase::UPtr search(CannedQuery const&, SearchMetadata const&) override
+    {
+        return nullptr;
+    }
+
+    PreviewQueryBase::UPtr preview(Result const&, ActionMetadata const&) override
+    {
+        return nullptr;
+    }
+
+    ChildScopeList child_scopes() const override
+    {
+        // 1st TestScope::child_scopes() returns: "A,B,C"
+        if (i == 0)
+        {
+            ChildScopeList list;
+            list.push_back({"ScopeA", false});
+            list.push_back({"ScopeB", false});
+            list.push_back({"ScopeC", true});
+            ++i;
+            return list;
+        }
+        // 2nd TestScope::child_scopes() returns: "D,A,B,C,E"
+        else if (i == 1)
+        {
+            ChildScopeList list;
+            list.push_back({"ScopeD", false});
+            list.push_back({"ScopeA", false});
+            list.push_back({"ScopeB", false});
+            list.push_back({"ScopeC", true});
+            list.push_back({"ScopeE", true});
+            ++i;
+            return list;
+        }
+        // 3rd+ TestScope::child_scopes() returns: D,A,B
+        else
+        {
+            ChildScopeList list;
+            list.push_back({"ScopeD", true});
+            list.push_back({"ScopeA", false});
+            list.push_back({"ScopeB", false});
+            return list;
+        }
+    }
+
+private:
+    mutable int i = 0;
+};
+
+} // namespace scopes
+
+} // namespace unity

=== added file 'test/gtest/scopes/ChildScopes/Zmq.ini.in'
--- test/gtest/scopes/ChildScopes/Zmq.ini.in	1970-01-01 00:00:00 +0000
+++ test/gtest/scopes/ChildScopes/Zmq.ini.in	2015-01-26 17:27:30 +0000
@@ -0,0 +1,2 @@
+[Zmq]
+EndpointDir = /tmp

=== modified file 'test/gtest/scopes/internal/RegistryObject/RegistryObject_test.cpp'
--- test/gtest/scopes/internal/RegistryObject/RegistryObject_test.cpp	2014-12-02 15:31:29 +0000
+++ test/gtest/scopes/internal/RegistryObject/RegistryObject_test.cpp	2015-01-26 17:27:30 +0000
@@ -91,6 +91,10 @@
     MOCK_METHOD3(preview, QueryCtrlProxy(Result const&,
                     ActionMetadata const&,
                     PreviewListenerBase::SPtr const&));
+
+    MOCK_METHOD0(child_scopes_ordered, ChildScopeList());
+
+    MOCK_METHOD1(set_child_scopes_ordered, bool(ChildScopeList const&));
 };
 
 

=== modified file 'test/gtest/scopes/internal/zmq_middleware/ZmqMiddleware/ZmqMiddleware_test.cpp'
--- test/gtest/scopes/internal/zmq_middleware/ZmqMiddleware/ZmqMiddleware_test.cpp	2014-08-12 13:26:35 +0000
+++ test/gtest/scopes/internal/zmq_middleware/ZmqMiddleware/ZmqMiddleware_test.cpp	2015-01-26 17:27:30 +0000
@@ -453,6 +453,16 @@
         return nullptr;
     }
 
+    virtual ChildScopeList child_scopes_ordered() const override
+    {
+        return ChildScopeList();
+    }
+
+    virtual bool set_child_scopes_ordered(ChildScopeList const&) override
+    {
+        return false;
+    }
+
     virtual bool debug_mode() const override
     {
         return false;