Merge lp:~stolowski/unity-scope-scopes/api-0.4.0 into lp:unity-scope-scopes

[Paweł Stołowski]

Updated for unity-scopes-api 0.4.0.

Updated for unity-scopes-api 0.4.0.

[lp:~stolowski/unity-scope-scopes/api-0.4.0]

26. By Paweł Stołowski on 2014-03-06

Change install location.

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2014-02-11 06:08:05 +0000
+++ CMakeLists.txt	2014-03-06 13:09:30 +0000
@@ -5,7 +5,7 @@
 find_package(Threads REQUIRED)
 
 pkg_check_modules(UNITY REQUIRED
-  "libunity-scopes >= 0.3.1"
+  "libunity-scopes >= 0.4.0"
 )
 
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wmissing-declarations -pedantic -std=c++11")

=== modified file 'debian/control'
--- debian/control	2014-02-13 16:32:07 +0000
+++ debian/control	2014-03-06 13:09:30 +0000
@@ -4,7 +4,7 @@
 Maintainer: Ubuntu Developers <[e-mail]>
 Build-Depends: cmake (>= 2.8),
                debhelper (>= 9),
-               libunity-scopes-dev (>= 0.3.1),
+               libunity-scopes-dev (>= 0.4.0),
                pkg-config,
 Standards-Version: 3.9.5
 Homepage: https://launchpad.net/unity-scope-scopes

=== modified file 'src/CMakeLists.txt'
--- src/CMakeLists.txt	2014-02-25 18:57:59 +0000
+++ src/CMakeLists.txt	2014-03-06 13:09:30 +0000
@@ -9,10 +9,10 @@
 
 install(
   TARGETS scopes
-  LIBRARY DESTINATION "${CMAKE_INSTALL_DATADIR}/unity/scopes/scopes"
+  LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}/unity-scopes/scopes"
 )
 
 install(
   FILES scopes.ini
-  DESTINATION "${CMAKE_INSTALL_DATADIR}/unity/scopes/scopes"
+  DESTINATION "${CMAKE_INSTALL_LIBDIR}/unity-scopes/scopes"
 )

=== modified file 'src/resultcollector.h'
--- src/resultcollector.h	2014-02-25 18:57:59 +0000
+++ src/resultcollector.h	2014-03-06 13:09:30 +0000
@@ -20,7 +20,7 @@
 #ifndef RESULTCOLLECTOR_H_
 #define RESULTCOLLECTOR_H_
 
-#include <unity/scopes/SearchListener.h>
+#include <unity/scopes/SearchListenerBase.h>
 #include <unity/scopes/ReplyProxyFwd.h>
 #include <unity/scopes/ListenerBase.h>
 #include <unity/scopes/CategorisedResult.h>
@@ -29,7 +29,7 @@
 #include <mutex>
 #include <condition_variable>
 
-class ResultCollector : public unity::scopes::SearchListener
+class ResultCollector : public unity::scopes::SearchListenerBase
 {
 public:
 

=== modified file 'src/scopes-scope.cpp'
--- src/scopes-scope.cpp	2014-03-04 11:45:25 +0000
+++ src/scopes-scope.cpp	2014-03-06 13:09:30 +0000
@@ -69,29 +69,29 @@
     registry.reset();
 }
 
-QueryBase::UPtr ScopesScope::create_query(Query const &q,
+SearchQueryBase::UPtr ScopesScope::search(CannedQuery const &q,
                                           SearchMetadata const &hints) {
-    QueryBase::UPtr query(new ScopesQuery(*this, q));
+    SearchQueryBase::UPtr query(new ScopesQuery(*this, q));
     return query;
 }
 
-QueryBase::UPtr ScopesScope::preview(Result const &result,
+PreviewQueryBase::UPtr ScopesScope::preview(Result const &result,
                                      ActionMetadata const &hints) {
-    QueryBase::UPtr previewer(new ScopesPreview(*this, result));
+    PreviewQueryBase::UPtr previewer(new ScopesPreview(*this, result));
     return previewer;
 }
 
-ActivationBase::UPtr ScopesScope::activate(Result const &result, ActionMetadata const& hints) {
-    ActivationBase::UPtr activation(new ScopesActivation(result));
-    return activation;
-}
-
-ActivationBase::UPtr ScopesScope::perform_action(Result const &result, ActionMetadata const& hints, std::string const &widget_id, std::string const &action_id) {
-    ActivationBase::UPtr activation(new ScopesActivation(result));
-    return activation;
-}
-
-ScopesQuery::ScopesQuery(ScopesScope &scope, Query const &query)
+ActivationQueryBase::UPtr ScopesScope::activate(Result const &result, ActionMetadata const& hints) {
+    ActivationQueryBase::UPtr activation(new ScopesActivation(result));
+    return activation;
+}
+
+ActivationQueryBase::UPtr ScopesScope::perform_action(Result const &result, ActionMetadata const& hints, std::string const &widget_id, std::string const &action_id) {
+    ActivationQueryBase::UPtr activation(new ScopesActivation(result));
+    return activation;
+}
+
+ScopesQuery::ScopesQuery(ScopesScope &scope, CannedQuery const &query)
     : scope(scope), query(query) {
 }
 
@@ -132,12 +132,12 @@
 static bool compareMetadata(ScopeMetadata const &item1, ScopeMetadata const &item2) {
     ScopeCategory cat1, cat2;
     try {
-        cat1 = category_mapping.at(item1.scope_name());
+        cat1 = category_mapping.at(item1.scope_id());
     } catch (std::out_of_range &e) {
         cat1 = CAT_OTHER;
     }
     try {
-        cat2 = category_mapping.at(item2.scope_name());
+        cat2 = category_mapping.at(item2.scope_id());
     } catch (std::out_of_range &e) {
         cat2 = CAT_OTHER;
     }
@@ -151,12 +151,12 @@
     try {
         name1 = item1.display_name();
     } catch (NotFoundException &e) {
-        name1 = item1.scope_name();
+        name1 = item1.scope_id();
     }
     try {
         name2 = item2.display_name();
     } catch (NotFoundException &e) {
-        name2 = item2.scope_name();
+        name2 = item2.scope_id();
     }
 
     return name1 < name2;
@@ -180,7 +180,7 @@
     if (scope.online_scope && !query.query_string().empty()) {
         online_query.reset(new ResultCollector);
         try {
-            create_subquery(scope.online_scope, query.query_string(), online_query);
+            subsearch(scope.online_scope, query.query_string(), online_query);
             // give the server a second before we display the results
             bool finished = online_query->wait_until_finished(1000);
             online_results = online_query->take_results();
@@ -226,7 +226,7 @@
         }
         if (display_name.find(term) != std::string::npos ||
             description.find(term) != std::string::npos ||
-            recommended_scopes.find(item.scope_name()) != recommended_scopes.end()) {
+            recommended_scopes.find(item.scope_id()) != recommended_scopes.end()) {
             scopes.push_back(item);
         }
     }
@@ -236,19 +236,19 @@
 
     for (const auto &item : scopes) {
         // don't display ourselves
-        if (item.scope_name() == "scopes") continue;
+        if (item.scope_id() == "scopes") continue;
 
         // TODO: categorisation of scopes should come from the
         // metadata rather than being hard coded.
         Category::SCPtr category;
         try {
-            ScopeCategory cat_id = category_mapping.at(item.scope_name());
+            ScopeCategory cat_id = category_mapping.at(item.scope_id());
             category = categories[cat_id];
         } catch (std::out_of_range &e) {
             category = categories[CAT_OTHER];
         }
-        auto it = recommended_scopes.find(item.scope_name());
-        pushed_scope_ids.insert(item.scope_name());
+        auto it = recommended_scopes.find(item.scope_id());
+        pushed_scope_ids.insert(item.scope_id());
         std::string search_string = it != recommended_scopes.end() ? it->second : "";
         push_scope_result(reply, item, category, search_string);
     }
@@ -286,13 +286,13 @@
             // push more results
             Category::SCPtr category;
             try {
-                ScopeCategory cat_id = category_mapping.at(item.scope_name());
+                ScopeCategory cat_id = category_mapping.at(item.scope_id());
                 category = categories[cat_id];
             } catch (std::out_of_range &e) {
                 category = categories[CAT_OTHER];
             }
-            auto it = recommended_scopes.find(item.scope_name());
-            pushed_scope_ids.insert(item.scope_name());
+            auto it = recommended_scopes.find(item.scope_id());
+            pushed_scope_ids.insert(item.scope_id());
             std::string search_string = it != recommended_scopes.end() ? it->second : "";
             push_scope_result(reply, item, category, search_string);
         }
@@ -301,7 +301,7 @@
 
 void ScopesQuery::push_scope_result(SearchReplyProxy const &reply, ScopeMetadata const& item, Category::SCPtr const& category, std::string const& search_string)
 {
-    std::string uri = "scope://" + item.scope_name();
+    std::string uri = "scope://" + item.scope_id();
     CategorisedResult result(category);
     // Tell the shell to ask us to activate results.
     result.set_intercept_activation();
@@ -309,14 +309,14 @@
     try {
         result.set_title(item.display_name());
     } catch (NotFoundException &e) {
-        result.set_title(item.scope_name());
+        result.set_title(item.scope_id());
     }
     try {
         result.set_art(item.art());
     } catch (NotFoundException &e) {
     }
     result.set_dnd_uri(uri);
-    result["scope_name"] = item.scope_name();
+    result["scope_name"] = item.scope_id();
     // FIXME: this should be provided by the scope metadata
     result["author"] = "Canonical Ltd";
     result["description"] = item.description();
@@ -332,7 +332,7 @@
         result["icon"] = icon;
     }
     try {
-        result["background"] = background_mapping.at(item.scope_name());
+        result["background"] = background_mapping.at(item.scope_id());
     } catch (std::out_of_range &e) {
     }
     reply->push(result);
@@ -358,15 +358,15 @@
     reply->register_layout({layout1col, layout2col, layout3col});
 
     PreviewWidget header("header", "header");
-    header.add_component("title", "title");
-    header.add_component("subtitle", "author");
-    header.add_component("mascot", "icon");
+    header.add_attribute_mapping("title", "title");
+    header.add_attribute_mapping("subtitle", "author");
+    header.add_attribute_mapping("mascot", "icon");
 
     PreviewWidget art("art", "image");
-    art.add_component("source", "art");
+    art.add_attribute_mapping("source", "art");
 
     PreviewWidget description("description", "text");
-    description.add_component("text", "description");
+    description.add_attribute_mapping("text", "description");
 
     PreviewWidget actions("actions", "actions");
     {
@@ -375,7 +375,7 @@
                 {"id", Variant("search")},
                 {"label", Variant("Search")}
             });
-        actions.add_attribute("actions", builder.end());
+        actions.add_attribute_value("actions", builder.end());
     }
 
     reply->push({art, header, actions, description});
@@ -386,7 +386,7 @@
 }
 
 ActivationResponse ScopesActivation::activate() {
-    Query query(result["scope_name"].get_string(), result["search_string"].get_string(), "");
+    CannedQuery query(result["scope_name"].get_string(), result["search_string"].get_string(), "");
     return ActivationResponse(query);
 }
 

=== modified file 'src/scopes-scope.h'
--- src/scopes-scope.h	2014-02-25 18:57:59 +0000
+++ src/scopes-scope.h	2014-03-06 13:09:30 +0000
@@ -31,11 +31,11 @@
     virtual int start(std::string const&, unity::scopes::RegistryProxy const&) override;
     virtual void stop() override;
 
-    virtual unity::scopes::QueryBase::UPtr create_query(unity::scopes::Query const &q, unity::scopes::SearchMetadata const& hints) override;
-    virtual unity::scopes::QueryBase::UPtr preview(unity::scopes::Result const& result, unity::scopes::ActionMetadata const& hints) override;
+    virtual unity::scopes::SearchQueryBase::UPtr search(unity::scopes::CannedQuery const &q, unity::scopes::SearchMetadata const& hints) override;
+    virtual unity::scopes::PreviewQueryBase::UPtr preview(unity::scopes::Result const& result, unity::scopes::ActionMetadata const& hints) override;
 
-    virtual unity::scopes::ActivationBase::UPtr activate(unity::scopes::Result const &result, unity::scopes::ActionMetadata const& hints) override;
-    virtual unity::scopes::ActivationBase::UPtr perform_action(unity::scopes::Result const &result, unity::scopes::ActionMetadata const& hints, std::string const &widget_id, std::string const &action_id) override;
+    virtual unity::scopes::ActivationQueryBase::UPtr activate(unity::scopes::Result const &result, unity::scopes::ActionMetadata const& hints) override;
+    virtual unity::scopes::ActivationQueryBase::UPtr perform_action(unity::scopes::Result const &result, unity::scopes::ActionMetadata const& hints, std::string const &widget_id, std::string const &action_id) override;
 
 private:
     unity::scopes::RegistryProxy registry;
@@ -43,10 +43,10 @@
     unity::scopes::ScopeProxy online_scope;
 };
 
-class ScopesQuery : public unity::scopes::SearchQuery
+class ScopesQuery : public unity::scopes::SearchQueryBase
 {
 public:
-    ScopesQuery(ScopesScope &scope, unity::scopes::Query const& query);
+    ScopesQuery(ScopesScope &scope, unity::scopes::CannedQuery const& query);
     virtual void cancelled() override;
     virtual void run(unity::scopes::SearchReplyProxy const&reply) override;
 
@@ -54,10 +54,10 @@
     void push_scope_result(unity::scopes::SearchReplyProxy const &reply, unity::scopes::ScopeMetadata const& item, unity::scopes::Category::SCPtr const& category, std::string const& search_string);
 
     const ScopesScope &scope;
-    const unity::scopes::Query query;
+    const unity::scopes::CannedQuery query;
 };
 
-class ScopesPreview : public unity::scopes::PreviewQuery
+class ScopesPreview : public unity::scopes::PreviewQueryBase
 {
 public:
     ScopesPreview(ScopesScope &scope, unity::scopes::Result const& result);
@@ -69,7 +69,7 @@
     const unity::scopes::Result result;
 };
 
-class ScopesActivation : public unity::scopes::ActivationBase
+class ScopesActivation : public unity::scopes::ActivationQueryBase
 {
 public:
     ScopesActivation(unity::scopes::Result const &result);

=== modified file 'src/scopes.ini'
--- src/scopes.ini	2014-03-04 11:45:17 +0000
+++ src/scopes.ini	2014-03-06 13:09:30 +0000
@@ -4,4 +4,5 @@
 Description = This is an Ubuntu search plugin that enables information from available search plugins to be searched and displayed in the Dash underneath the Dash plugins header. If you do not wish to search this content source, you can disable this search plugin.
 SearchHint = Search for scopes
 HotKey =
+Author = Canonical Ltd.
 Invisible = true