Merge lp:~fcole90/ubuntu-docviewer-app/include-file-plugin into lp:ubuntu-docviewer-app/trunk

[David Planella]

Adds the file plugin to the source tree.

Adds the file plugin to the source tree.

Note: while developing, to run the app on the desktop, or on any device, it requires an argument. The only way to pass that argument is by adding it as parameter to the .desktop(.in.in) file's Exec key. E.g., here's how I run it on my desktop:

Exec=@EXEC@ /home/dpm/docviewer.txt

In the future, we will want to improve this, so that the app can be launched standalone. A workaround for now would be to ship a README.txt file that is loaded by default if no argument has been specified.

Note: autopilot tests still need to be adapted. I'll do that in this same merge proposal. In the meantime, the code changes in cmake and app+plugin can already be reviewed.

Unmerged revisions

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2014-09-24 09:46:30 +0000
+++ CMakeLists.txt	2014-10-08 07:04:22 +0000
@@ -19,6 +19,8 @@
 set(UBUNTU_MANIFEST_PATH "manifest.json.in" CACHE INTERNAL "Relative path to the manifest file")
 
 if(CLICK_MODE)
+    #adds the plugins dir only if building a click package
+    add_subdirectory(plugins)
     if(NOT DEFINED BZR_SOURCE)
         set(BZR_SOURCE "lp:ubuntu-${APP_HARDCODE}")
         message("-- Setting BZR_SOURCE to ${BZR_SOURCE}")

=== added directory 'plugins'
=== added file 'plugins/CMakeLists.txt'
--- plugins/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ plugins/CMakeLists.txt	2014-10-08 07:04:22 +0000
@@ -0,0 +1,1 @@
+add_subdirectory(file-qml-plugin)

=== added directory 'plugins/file-qml-plugin'
=== added file 'plugins/file-qml-plugin/CMakeLists.txt'
--- plugins/file-qml-plugin/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ plugins/file-qml-plugin/CMakeLists.txt	2014-10-08 07:04:22 +0000
@@ -0,0 +1,45 @@
+cmake_minimum_required(VERSION 2.8.9)
+include_directories(${CMAKE_CURRENT_SOURCE_DIR})
+
+#set cpp flags
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -fno-permissive -pedantic -Wall -Wextra -fPIC")
+
+# Standard install paths
+include(GNUInstallDirs)
+
+#add the sources to compile
+set(FILE_QML_PLUGIN_SOURCES
+	backend.cpp
+	backend.h
+	docviewerFile.cpp
+	docviewerFile.h
+	fileReader.cpp
+	fileReader.h
+	)
+
+#should be deprecated in current cmake version
+#qt5_use_modules(Qml Quick)
+
+if(CLICK_MODE)
+	#none
+else(CLICK_MODE)
+	#creates QT_IMPORTS_DIR and olds the qml plugin path
+	execute_process(
+            COMMAND qmake -query QT_INSTALL_QML
+            OUTPUT_VARIABLE QT_IMPORTS_DIR
+            OUTPUT_STRIP_TRAILING_WHITESPACE
+        )
+endif(CLICK_MODE)
+
+
+# Copy qmldir file to build dir for running in QtCreator
+if(NOT "${CMAKE_CURRENT_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}")
+add_custom_target(file-qml-plugin ALL
+    COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/qmldir ${CMAKE_CURRENT_BINARY_DIR}
+    DEPENDS ${QMLFILES}
+)
+endif(NOT "${CMAKE_CURRENT_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}")
+
+# Install plugin file under org.docviewer.file
+install(TARGETS file-qml-plugin DESTINATION ${QT_IMPORTS_DIR}/org.docviewer.file/)
+install(FILES qmldir DESTINATION ${QT_IMPORTS_DIR}/org.docviewer.file/)

=== added file 'plugins/file-qml-plugin/backend.cpp'
--- plugins/file-qml-plugin/backend.cpp	1970-01-01 00:00:00 +0000
+++ plugins/file-qml-plugin/backend.cpp	2014-10-08 07:04:22 +0000
@@ -0,0 +1,22 @@
+#include <QtQml>
+#include <QtQml/QQmlContext>
+
+#include "backend.h"
+#include "docviewerFile.h"
+#include "fileReader.h"
+
+void BackendPlugin::registerTypes(const char *uri)
+{
+    Q_ASSERT(uri == QLatin1String("org.docviewer.file"));
+    
+    //@uri org.docviewer.file
+
+    qmlRegisterType<DocviewerFile>(uri, 1, 0, "File");
+    qmlRegisterType<FileReader>(uri, 1, 0, "FileReader");    
+
+}
+
+void BackendPlugin::initializeEngine(QQmlEngine *engine, const char *uri)
+{
+    QQmlExtensionPlugin::initializeEngine(engine, uri);
+}

=== added file 'plugins/file-qml-plugin/backend.h'
--- plugins/file-qml-plugin/backend.h	1970-01-01 00:00:00 +0000
+++ plugins/file-qml-plugin/backend.h	2014-10-08 07:04:22 +0000
@@ -0,0 +1,43 @@
+#ifndef BACKEND_PLUGIN_H
+#define BACKEND_PLUGIN_H
+
+#include <QtQml/QQmlEngine>
+#include <QtQml/QQmlExtensionPlugin>
+
+/*
+ ----8<-----
+ 
+ import org.docviewer.file 1.0
+ 
+ Rectangle {
+   width: 200
+   height: 200
+   
+   File {
+      id: file
+      path: the/path/of/file
+
+      onMimetypeChanged: {
+        do.something(mimetype);
+      }
+   }
+   
+   Text {
+     anchors.centerIn: parent
+     text: helloType.helloworld
+   }
+ }
+ 
+ -----8<------
+*/
+class BackendPlugin : public QQmlExtensionPlugin
+{
+    Q_OBJECT
+    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QQmlExtensionInterface")
+    
+public:
+    void registerTypes(const char *uri);
+    void initializeEngine(QQmlEngine *engine, const char *uri);
+};
+#endif // BACKEND_PLUGIN_H
+

=== added file 'plugins/file-qml-plugin/docviewerFile.cpp'
--- plugins/file-qml-plugin/docviewerFile.cpp	1970-01-01 00:00:00 +0000
+++ plugins/file-qml-plugin/docviewerFile.cpp	2014-10-08 07:04:22 +0000
@@ -0,0 +1,105 @@
+#include <QProcess>
+#include <QObject>
+#include <QDebug>
+#include <QFileInfo>
+
+#include "docviewerFile.h"
+
+/*
+ ----8<-----
+
+ import org.docviewer.file 1.0
+
+ Rectangle {
+   width: 200
+   height: 200
+
+   File {
+      id: file
+      path: "the/path/of/file"
+
+      onMimetypeChanged: {
+        do.something(mimetype);
+      }
+   }
+
+   Text {
+     anchors.centerIn: parent
+     text: helloType.helloworld
+   }
+ }
+
+ -----8<------
+*/
+
+DocviewerFile::DocviewerFile(QObject *parent) :
+    QObject(parent),
+    path("")
+{
+}
+DocviewerFile::~DocviewerFile() {
+    
+}
+
+void DocviewerFile::setPath(QString p) {
+    if (p.isEmpty()) {
+        this->path = "";
+    }
+    else {
+        this->path = p;
+    }
+
+    this->open();
+
+    emit pathChanged();
+}
+
+void DocviewerFile::open() {
+    if (!path.isEmpty())
+    {
+        QFileInfo file(path);
+
+        if (file.exists()) {
+
+            /**Get info of the file**/
+            size = file.size();
+            emit sizeChanged();
+
+            lastmodified = file.lastModified();
+            emit lastmodifiedChanged();
+
+            /**Get mimetype**/
+            QStringList mimeTypeCommand;
+            mimeTypeCommand << "-ib" << path;
+
+            mimeTypeProcess = new QProcess();
+
+            this->connect(mimeTypeProcess, SIGNAL(readyReadStandardOutput()), SLOT(s_readMimeType()));
+            this->connect(mimeTypeProcess, SIGNAL(finished(int)), SLOT(s_finished(int)));
+
+            mimeTypeProcess->start("file", mimeTypeCommand);
+
+        }
+        else {
+            error = -1;
+            emit errorChanged();
+        }
+    }
+
+
+}
+
+/****SLOT****/
+
+void DocviewerFile::s_readMimeType()
+{
+    mimetype = mimeTypeProcess->readAllStandardOutput();
+    mimetype = mimetype.left(mimetype.size()-1);
+}
+
+void DocviewerFile::s_finished(int exitCode)
+{
+    if (exitCode != 0)
+        mimetype = "Unknow";
+    emit mimetypeChanged();
+}

=== added file 'plugins/file-qml-plugin/docviewerFile.h'
--- plugins/file-qml-plugin/docviewerFile.h	1970-01-01 00:00:00 +0000
+++ plugins/file-qml-plugin/docviewerFile.h	2014-10-08 07:04:22 +0000
@@ -0,0 +1,56 @@
+#ifndef DOCVIEWERFILE_H
+#define DOCVIEWERFILE_H
+
+#include <QString>
+#include <QObject>
+#include <QProcess>
+#include <QDateTime>
+
+class DocviewerFile : public QObject
+{
+    Q_OBJECT
+    Q_PROPERTY( QString path READ getPath WRITE setPath NOTIFY pathChanged )
+    Q_PROPERTY( QString mimetype READ getMimetype NOTIFY mimetypeChanged )
+    Q_PROPERTY( qint64 size READ getSize NOTIFY sizeChanged )
+    Q_PROPERTY( QDateTime lastModified READ getLastmodified NOTIFY lastmodifiedChanged )
+    Q_PROPERTY( int error READ getError NOTIFY errorChanged )
+    
+public:
+    explicit DocviewerFile(QObject *parent = 0);
+    ~DocviewerFile();
+    
+protected:
+    QString getPath() { return path; }
+    void setPath(QString p);
+
+    QString getMimetype() { return mimetype; }
+
+    qint64 getSize() { return size; }
+
+    QDateTime getLastmodified() { return lastmodified; }
+
+    int getError() { return error; }
+    
+    QString path;
+    QString mimetype;
+    qint64 size;
+    QDateTime lastmodified;
+    int error;
+
+private:
+    void open();
+    QProcess *mimeTypeProcess;
+
+public slots:
+    void s_readMimeType();
+    void s_finished(int exitCode);
+
+Q_SIGNALS:
+    void pathChanged();
+    void mimetypeChanged();
+    void sizeChanged();
+    void lastmodifiedChanged();
+    void errorChanged();
+};
+
+#endif // DOCVIEWERFILE_H

=== added file 'plugins/file-qml-plugin/fileReader.cpp'
--- plugins/file-qml-plugin/fileReader.cpp	1970-01-01 00:00:00 +0000
+++ plugins/file-qml-plugin/fileReader.cpp	2014-10-08 07:04:22 +0000
@@ -0,0 +1,82 @@
+#include <QFile>
+#include <QObject>
+#include <QDebug>
+#include <QTextStream>
+
+#include "fileReader.h"
+
+/*
+ ----8<-----
+
+ import org.docviewer.file 1.0
+
+ Rectangle {
+   width: 200
+   height: 200
+
+   FileReader {
+      id: readFile
+      path: "/path/of/file"
+   }
+
+   Text {
+     anchors.centerIn: parent
+     text: readFile.fileString
+   }
+ }
+
+ -----8<------
+*/
+
+FileReader::FileReader(QObject *parent) :
+    QObject(parent),
+    path("")
+{
+
+}
+
+FileReader::~FileReader() {
+
+}
+
+void FileReader::setPath(QString p) {
+    if (p.isEmpty())
+    {
+        this->path = "";
+    }
+    else
+    {
+        this->path = p;
+    }
+
+    this->readString();
+
+    emit pathChanged();
+}
+
+void FileReader::readString() {
+    if (!path.isEmpty()) {
+
+        QFile mfile(path);
+
+        if (!mfile.open(QFile::ReadOnly | QFile::Text))
+        {
+            qDebug() << "Could not open file for reading";
+            error = -1;
+            emit errorChanged();
+            return;
+        }
+
+        QTextStream in(&mfile);
+        fileString = in.readAll();
+        emit fileStringChanged();
+
+        mfile.flush();
+        mfile.close();
+    }
+    else
+    {
+        error = -1;
+        emit errorChanged();
+    }
+}

=== added file 'plugins/file-qml-plugin/fileReader.h'
--- plugins/file-qml-plugin/fileReader.h	1970-01-01 00:00:00 +0000
+++ plugins/file-qml-plugin/fileReader.h	2014-10-08 07:04:22 +0000
@@ -0,0 +1,39 @@
+#ifndef FILEREADER_H
+#define FILEREADER_H
+
+#include <QObject>
+#include <QString>
+
+class FileReader: public QObject
+{
+    Q_OBJECT
+    Q_PROPERTY(QString path READ getPath WRITE setPath NOTIFY pathChanged)
+    Q_PROPERTY(QString fileString READ getfileString NOTIFY fileStringChanged)
+    Q_PROPERTY(int error READ getError NOTIFY errorChanged)
+
+public:
+    explicit FileReader(QObject *parent = 0);
+    ~FileReader();
+
+protected:
+    QString getPath() { return path; }
+    void setPath(QString p);
+
+    QString getfileString() { return fileString; }
+
+    int getError() { return error; }
+
+    QString path;
+    QString fileString;
+    int error;
+
+private:
+    void readString();
+
+Q_SIGNALS:
+    void pathChanged();
+    void fileStringChanged();
+    void errorChanged();
+};
+
+#endif // FILEREADER_H

=== added file 'plugins/file-qml-plugin/main.pro'
--- plugins/file-qml-plugin/main.pro	1970-01-01 00:00:00 +0000
+++ plugins/file-qml-plugin/main.pro	2014-10-08 07:04:22 +0000
@@ -0,0 +1,38 @@
+TEMPLATE = lib
+TARGET = filePlugin
+QT += qml quick
+CONFIG += qt plugin
+
+#comment in the following line to disable traces
+DEFINES += QT_NO_DEBUG_OUTPUT
+
+TARGET = $$qtLibraryTarget($$TARGET)
+uri = org.docviewer.file
+
+INCLUDEPATH += .
+
+# Input
+HEADERS += backend.h \
+    docviewerFile.h \
+    fileReader.h
+SOURCES += backend.cpp \
+    docviewerFile.cpp \
+    fileReader.cpp
+
+# Install path for the plugin
+installPath = $$[QT_INSTALL_QML]/$$replace(uri, \\., /)
+target.path = $$installPath
+INSTALLS += target
+
+# find files
+QMLDIR_FILE = qmldir
+
+# make visible to qt creator
+OTHER_FILES += $$QMLDIR_FILE 
+
+# create install targets for files
+qmldir.path = $$installPath
+qmldir.files = $$QMLDIR_FILE
+
+INSTALLS += qmldir
+

=== added file 'plugins/file-qml-plugin/qmldir'
--- plugins/file-qml-plugin/qmldir	1970-01-01 00:00:00 +0000
+++ plugins/file-qml-plugin/qmldir	2014-10-08 07:04:22 +0000
@@ -0,0 +1,1 @@
+plugin filePlugin