Merge lp:~mandel/ubuntu-download-manager/add-client-lib into lp:ubuntu-download-manager

[Manuel de la Peña]

Adds the client library that allows apps to use the download manager without knowing the dbus api.

Adds the client library that allows apps to use the download manager without knowing the dbus api.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:190
http://jenkins.qa.ubuntu.com/job/ubuntu-download-manager-ci/269/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-download-manager-trusty-amd64-ci/158
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-download-manager-trusty-armhf-ci/158

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-download-manager-ci/269/rebuild

review: Approve (continuous-integration)

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

[Mike McCracken (mikemc)]

Looks good. I'm curious about this line:

234 +#include "moc_manager.cpp"

It seems like that shouldn't be necessary, but it's clearly intentional - there's only one other case where you do this.

Why do you have to include the moc there?

review: Approve

[Manuel de la Peña (mandel)]

> Looks good. I'm curious about this line:
>
> 234 +#include "moc_manager.cpp"
>
> It seems like that shouldn't be necessary, but it's clearly intentional -
> there's only one other case where you do this.
>
> Why do you have to include the moc there?

Correct, is on purpose, I was looking ahead, the idea is to add the moc_ file there so that the Q_PRIVATE_SLOT template works. But that is something that I knew I will have to do for ABI compatibility but the code is not there in the branch (I have a template that generates this kind of files).

=== modified file 'debian/control'
--- debian/control	2013-12-03 12:25:56 +0000
+++ debian/control	2014-01-08 10:56:59 +0000
@@ -36,7 +36,18 @@
 Description: Ubuntu Download Manager - shared library
  Ubuntu Download Manager performs downloads from a centralized location.
  .
- This package includes the shared library.
+ This package includes the private shared library.
+
+Package: ubuntu-download-manager-client1
+Section: libs
+Architecture: any
+Depends: ${misc:Depends},
+         ${shlibs:Depends},
+         ubuntu-download-manager-common1 (= ${binary:Version}),
+Description: Ubuntu Download Manager - shared library
+ Ubuntu Download Manager performs downloads from a centralized location.
+ .
+ This package includes the public shared library.
 
 Package: ubuntu-download-manager
 Section: net

=== added file 'debian/ubuntu-download-manager-client-dev.install'
--- debian/ubuntu-download-manager-client-dev.install	1970-01-01 00:00:00 +0000
+++ debian/ubuntu-download-manager-client-dev.install	2014-01-08 10:56:59 +0000
@@ -0,0 +1,3 @@
+usr/include/ubuntu/download_manager/manager.h
+usr/lib/*/libubuntu-download-manager-client.so
+usr/lib/*/pkgconfig/ubuntu-download-manager-client.pc

=== added file 'debian/ubuntu-download-manager-client1.install'
--- debian/ubuntu-download-manager-client1.install	1970-01-01 00:00:00 +0000
+++ debian/ubuntu-download-manager-client1.install	2014-01-08 10:56:59 +0000
@@ -0,0 +1,1 @@
+usr/lib/libubuntu-download-manager-client.so.*

=== modified file 'download-manager.pro'
--- download-manager.pro	2013-12-03 12:25:56 +0000
+++ download-manager.pro	2014-01-08 10:56:59 +0000
@@ -7,7 +7,8 @@
     ubuntu-download-manager-common \
     ubuntu-download-manager-priv \
     ubuntu-download-manager \
-    ubuntu-download-manager-tests
+    ubuntu-download-manager-tests \
+    ubuntu-download-manager-client
 
 ubuntu-download-manager-priv.depends = ubuntu-download-manager-common
 

=== added directory 'ubuntu-download-manager-client'
=== added directory 'ubuntu-download-manager-client/ubuntu'
=== added file 'ubuntu-download-manager-client/ubuntu-download-manager-client.pc.in'
--- ubuntu-download-manager-client/ubuntu-download-manager-client.pc.in	1970-01-01 00:00:00 +0000
+++ ubuntu-download-manager-client/ubuntu-download-manager-client.pc.in	2014-01-08 10:56:59 +0000
@@ -0,0 +1,12 @@
+prefix=$$INSTALL_PREFIX
+exec_prefix=${prefix}
+libdir=$$INSTALL_LIBDIR
+includedir=${prefix}/include/ubuntu/download_manager
+
+Name: ubuntu-download-manager-client
+Description: Client Ubuntu Download Manager lib
+Version: $$PROJECT_VERSION
+Libs: -L${libdir} -lubuntu-download-manager-client
+Requires: Qt5Core Qt5DBus
+Cflags:  -I${includedir}
+

=== added file 'ubuntu-download-manager-client/ubuntu-download-manager-client.pro'
--- ubuntu-download-manager-client/ubuntu-download-manager-client.pro	1970-01-01 00:00:00 +0000
+++ ubuntu-download-manager-client/ubuntu-download-manager-client.pro	2014-01-08 10:56:59 +0000
@@ -0,0 +1,38 @@
+include(../common-project-config.pri)
+include(../common-vars.pri)
+
+QT       += dbus
+QT       -= gui
+
+TARGET = ubuntu-download-manager-client
+TEMPLATE = lib
+
+DEFINES += UBUNTUDOWNLOADMANAGERCLIENT_LIBRARY
+
+SOURCES += ubuntu/download_manager/manager.cpp
+
+public_headers = \
+    ubuntu/download_manager/manager.h
+
+private_headers = \
+    ubuntu-download-manager-client_global.h
+
+HEADERS +=\
+    $$public_headers \
+    $$private_headers
+
+OTHER_FILES += \
+    ubuntu-download-manager-client.pc.in
+
+headers.files = $$public_headers
+
+include(../common-installs-config.pri)
+
+pkgconfig.files = ubuntu-download-manager-client.pc
+include(../common-pkgconfig.pri)
+INSTALLS += pkgconfig
+
+LIBS += -L$$OUT_PWD/../ubuntu-download-manager-common/ -lubuntu-download-manager-common
+
+INCLUDEPATH += $$PWD/../ubuntu-download-manager-common
+DEPENDPATH += $$PWD/../ubuntu-download-manager-common

=== added file 'ubuntu-download-manager-client/ubuntu-download-manager-client_global.h'
--- ubuntu-download-manager-client/ubuntu-download-manager-client_global.h	1970-01-01 00:00:00 +0000
+++ ubuntu-download-manager-client/ubuntu-download-manager-client_global.h	2014-01-08 10:56:59 +0000
@@ -0,0 +1,12 @@
+#ifndef UBUNTUDOWNLOADMANAGERCLIENT_GLOBAL_H
+#define UBUNTUDOWNLOADMANAGERCLIENT_GLOBAL_H
+
+#include <QtCore/qglobal.h>
+
+#if defined(UBUNTUDOWNLOADMANAGERCLIENT_LIBRARY)
+#  define UBUNTUDOWNLOADMANAGERCLIENTSHARED_EXPORT Q_DECL_EXPORT
+#else
+#  define UBUNTUDOWNLOADMANAGERCLIENTSHARED_EXPORT Q_DECL_IMPORT
+#endif
+
+#endif // UBUNTUDOWNLOADMANAGERCLIENT_GLOBAL_H

=== added directory 'ubuntu-download-manager-client/ubuntu/download_manager'
=== added file 'ubuntu-download-manager-client/ubuntu/download_manager/manager.cpp'
--- ubuntu-download-manager-client/ubuntu/download_manager/manager.cpp	1970-01-01 00:00:00 +0000
+++ ubuntu-download-manager-client/ubuntu/download_manager/manager.cpp	2014-01-08 10:56:59 +0000
@@ -0,0 +1,98 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of version 3 of the GNU Lesser General Public
+ * License 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
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#include "manager.h"
+
+
+namespace Ubuntu {
+
+namespace DownloadManager {
+
+/*
+ * PRIVATE IMPLEMENTATION
+ */
+
+class ManagerPrivate {
+    Q_DECLARE_PUBLIC(Manager)
+
+ public:
+    explicit ManagerPrivate(Manager* parent)
+        : q_ptr(parent) {
+    }
+
+    Download* createDownload(DownloadStruct downStruct) {
+        Q_UNUSED(downStruct);
+        return NULL;
+    }
+
+    void createDownload(DownloadStruct downStruct, DownloadCreationCb cb) {
+        Q_UNUSED(downStruct);
+        Q_UNUSED(cb);
+    }
+
+    GroupDownload* createDownload(GroupDownloadStruct groupStruct) {
+        Q_UNUSED(groupStruct);
+        return NULL;
+    }
+
+    void createDownload(GroupDownloadStruct groupStruct, GroupCreationCb cb) {
+        Q_UNUSED(groupStruct);
+        Q_UNUSED(cb);
+    }
+
+ private:
+    Manager* q_ptr;
+};
+
+/*
+ * PUBLIC IMPLEMENTATION
+ */
+
+Manager::Manager(QObject* parent)
+    : QObject(parent){
+}
+
+Download*
+Manager::createDownload(DownloadStruct downStruct) {
+    Q_D(Manager);
+    return d->createDownload(downStruct);
+}
+
+void
+Manager::createDownload(DownloadStruct downStruct, DownloadCreationCb cb) {
+    Q_D(Manager);
+    d->createDownload(downStruct, cb);
+}
+
+GroupDownload*
+Manager::createDownload(GroupDownloadStruct  groupStruct) {
+    Q_D(Manager);
+    return d->createDownload(groupStruct);
+}
+
+void
+Manager::createDownload(GroupDownloadStruct  groupStruct, GroupCreationCb cb) {
+    Q_D(Manager);
+    d->createDownload(groupStruct, cb);
+}
+
+}  // DownloadManager
+
+}  // Ubuntu
+
+#include "moc_manager.cpp"

=== added file 'ubuntu-download-manager-client/ubuntu/download_manager/manager.h'
--- ubuntu-download-manager-client/ubuntu/download_manager/manager.h	1970-01-01 00:00:00 +0000
+++ ubuntu-download-manager-client/ubuntu/download_manager/manager.h	2014-01-08 10:56:59 +0000
@@ -0,0 +1,64 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of version 3 of the GNU Lesser General Public
+ * License 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
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef UBUNTU_DOWNLOADMANAGER_CLIENT_MANAGER_H
+#define UBUNTU_DOWNLOADMANAGER_CLIENT_MANAGER_H
+
+#include <functional>
+#include <QObject>
+#include <ubuntu/download_manager/download_struct.h>
+#include <ubuntu/download_manager/group_download_struct.h>
+#include "ubuntu-download-manager-client_global.h"
+
+namespace Ubuntu {
+
+namespace DownloadManager {
+
+class Download;
+class GroupDownload;
+
+typedef std::function<void(Download*)> DownloadCreationCb;
+typedef std::function<void(GroupDownload*)> GroupCreationCb;
+
+class ManagerPrivate;
+class UBUNTUDOWNLOADMANAGERCLIENTSHARED_EXPORT Manager : public QObject {
+    Q_DECLARE_PRIVATE(Manager)
+    Q_OBJECT
+
+ public:
+    explicit Manager(QObject* parent);
+
+    virtual Download* createDownload(DownloadStruct downStruct);
+    virtual void createDownload(DownloadStruct downStruct, DownloadCreationCb cb);
+    virtual GroupDownload* createDownload(GroupDownloadStruct groupStruct);
+    virtual void createDownload(GroupDownloadStruct groupStruct, GroupCreationCb cb);
+
+ signals:
+    void downloadCreated(Download* down);
+    void groupCreated(GroupDownload* down);
+
+ private:
+    // use pimpl pattern so that users do not have to be recompiled
+    ManagerPrivate* d_ptr;
+};
+
+}  // DownloadManager
+
+}  // Ubuntu
+
+#endif  // UBUNTU_DOWNLOADMANAGER_CLIENT_MANAGER_H