Merge pull request #4 from antony-jr/fix_bad_practice_on_qthread

Fix bad practice on qthread

docs/AddingToYourQtProject.md

@@ -7,10 +7,10 @@ sidebar_label: Adding QArchive to Your Qt Project
 |	    |				       |		
 |-----------|----------------------------------|
 |  Header:  | #include "QArchive/QArchive.hpp" |
-|   qmake:  | QT += core		       |
+|   qmake:  | QT += core concurrent	       |
 |   	    | LIBS += -larchive		       |
 |	    | HEADERS += QArchive/QArchive.hpp |
-|Inherits:  | [QThread](http://doc.qt.io/qt-5/qthread.html)|	
+| Inherits: | QObject			       |
 
 **QArchive** is just a header and all you have to do after installation is to add   
 it in your **.pro** file ( **Qt Project file** ).
@@ -20,7 +20,7 @@ it in your **.pro** file ( **Qt Project file** ).
 Append these **lines** to your **Qt Project file**.
 
 ```
-QT += core
+QT += core concurrent
 LIBS += -larchive
 HEADERS += QArchive/QArchive.hpp
 ```

docs/QArchiveCompressor.md

@@ -20,18 +20,16 @@ sidebar_label: QArchive::Compressor
 
 ### Slots
 
-All slots used by you are **inherited** from **[QThread](http://doc.qt.io/qt-5/qthread.html)**
-
 |               |             |
 |---------------|-------------|
 | **void**  	| start(void) |
-| **void**      | quit(void)  |
-| **void**      | wait(void)  |
+| **void**      | stop(void)  |
 
 ### Signals
 
 |                     |                                                                                 |
 |---------------------|---------------------------------------------------------------------------------|
+| **void**	      | stopped(void)								        |
 | **void**            | finished(void)                        	                                        |
 | **void**    	      | compressing(const QString& file)                                                |
 | **void**    	      | compressed(const QString& file)                                       	        |
@@ -74,12 +72,17 @@ Sets the format of the archive which is going to be created. refer the **[suppor
 #### void start(void)
 This member function is a **[SLOT]**
 
-Starts the compression of all files in the archive. Inherited from **[QThread](http://doc.qt.io/qt-5/qthread.html)**.
+Starts the compression of all files in the archive.
 
-#### void quit(void)
+#### void stop(void)
 This member function is a **[SLOT]**
 
-Quits the compressor thread. Inherited from **[QThread](http://doc.qt.io/qt-5/qthread.html)**
+Stops the compressor. **void stopped(void)** signal will be emitted if this slot is successfull.
+
+#### void stopped(void)
+This member function is a **[SIGNAL]**
+
+Emitted when **void stop(void)** is successfull.
 
 #### void finished(void)
 This member function is a **[SIGNAL]** 

docs/QArchiveExtractor.md

@@ -23,18 +23,16 @@ This class runs on a seperate thread to avoid blocking by **libarchive**.
 
 ### Slots
 
-All slots used by you are **inherited** from **[QThread](http://doc.qt.io/qt-5/qthread.html)**
-
 |               |             |
 |---------------|-------------|
 | **void**  	| start(void) |
-| **void**      | quit(void)  |
-| **void**      | wait(void)  |
+| **void**      | stop(void)  |
 
 ### Signals
 
 |                     |                                                                                 |
 |---------------------|---------------------------------------------------------------------------------|
+| **void**	      | stopped(void)								        |
 | **void**            | finished(void)                        	                                        |
 | **void**    	      | extracting(const QString& archive)                                              |
 | **void**    	      | extracted(const QString& archive)      	                                        |
@@ -84,12 +82,18 @@ Sets the destination where the archive(s) will be extracted. Default is **the pr
 #### void start(void)
 This member function is a **[SLOT]**
 
-Starts the extraction of all archives in the queue. Inherited from **[QThread](http://doc.qt.io/qt-5/qthread.html)**.
+Starts the extraction of all archives in the queue.
 
-#### void quit(void)
+#### void stop(void)
 This member function is a **[SLOT]**
 
-Quits the extraction thread. Inherited from **[QThread](http://doc.qt.io/qt-5/qthread.html)**
+Stops the extraction of all archives in the queue. This slot is **asyc** and thus you need to wait for the
+**void stopped(void)** signal , Which confirms that the stop call was successfull.
+
+#### void stopped(void)
+This member function is a **[SIGNAL]**
+
+Emitted when **void stop(void)** is successfull , i.e When the extraction is stopped successfully.
 
 #### void finished(void)
 This member function is a **[SIGNAL]** 

docs/QArchiveReader.md

@@ -16,18 +16,16 @@ sidebar_label: QArchive::Reader
 
 ### Slots
 
-All slots used by you are **inherited** from **[QThread](http://doc.qt.io/qt-5/qthread.html)**
-
 |               |             |
 |---------------|-------------|
 | **void**  	| start(void) |
-| **void**      | quit(void)  |
-| **void**      | wait(void)  |
+| **void**      | stop(void)  |
 
 ### Signals
 
 |                     |                                                                                 |
 |---------------------|---------------------------------------------------------------------------------|
+| **void**	      | stopped(void)									|
 | **void**            | archiveFiles(const QString& archive, const QStringList& files)                  |
 | **void**  	      | error(short **[errorCode](QArchiveErrorCodes.md)** , const QString& what)	    |  
 
@@ -52,12 +50,12 @@ Clears all cached **filenames** and **archive paths**
 #### void start(void)
 This member function is a **[SLOT]**
 
-Reads all files in the archive. Inherited from **[QThread](http://doc.qt.io/qt-5/qthread.html)**.
+Start reading all files in the archive.
 
-#### void quit(void)
+#### void stop(void)
 This member function is a **[SLOT]**
 
-Quits the Reader thread. Inherited from **[QThread](http://doc.qt.io/qt-5/qthread.html)**
+Stops the Reader. **void stopped(void)** signal is emitted when this is successfull.
 
 #### void archiveFiles(const QString& archive, const QStringList& files)
 This member function is a **[SIGNAL]**

docs/UsingCompressor.md

@@ -39,7 +39,6 @@ int main(int argc, char** argv)
     });
     QObject::connect(&e, &QArchive::Compressor::error, [&](short code, QString file) {
         qDebug() << "error code:: " << code << " :: " << file;
-        e.terminate();
         app.quit();
     });
     /*
@@ -59,7 +58,7 @@ int main(int argc, char** argv)
 TEMPLATE = app
 TARGET = create_archive
 
-QT += core
+QT += core concurrent
 LIBS += -larchive
 SOURCES += main.cpp
 HEADERS += QArchive/QArchive.hpp
@@ -70,7 +69,7 @@ HEADERS += QArchive/QArchive.hpp
 ```
  $ mkdir build
  $ cd build
- $ qmake ../create_archive.pro
+ $ qmake ..
  $ make -j4
  $ ./create_archive
  $ # Make sure you have files for the new archive!

docs/UsingExtractor.md

@@ -33,7 +33,6 @@ int main(int argc, char** argv)
     // emitted when all extraction is finished
     QObject::connect(&e, &QArchive::Extractor::finished, [&]() {
         qDebug() << "Finished all extraction!";
-        e.quit();
         app.quit();
     });
 
@@ -48,7 +47,6 @@ int main(int argc, char** argv)
 
     // emitted when something goes wrong
     QObject::connect(&e, &QArchive::Extractor::error, [&](short code, QString file) {
-        e.terminate();
         switch(code) {
         case QArchive::ARCHIVE_READ_ERROR:
             qDebug() << "unable to find archive :: " << file;
@@ -86,7 +84,7 @@ int main(int argc, char** argv)
 TEMPLATE = app
 TARGET = extraction
 
-QT += core
+QT += core concurrent
 LIBS += -larchive
 SOURCES += main.cpp
 HEADERS += QArchive/QArchive.hpp
@@ -97,7 +95,7 @@ HEADERS += QArchive/QArchive.hpp
 ```
  $ mkdir build
  $ cd build
- $ qmake ../extraction.pro
+ $ qmake ..
  $ make -j4
  $ ./extraction
  $ # Make sure you have test.7z file!

docs/UsingReader.md

@@ -32,7 +32,6 @@ int main(int argc, char** argv)
     QObject::connect(&e, &QArchive::Reader::archiveFiles, [&](QString archive, QStringList files) {
         qDebug() << archive << " :: ";
         qDebug() << files;
-        e.quit();
         app.quit();
     });
 
@@ -72,7 +71,7 @@ int main(int argc, char** argv)
 TEMPLATE = app
 TARGET = read_archive
 
-QT += core
+QT += core concurrent
 LIBS += -larchive
 SOURCES += main.cpp
 HEADERS += QArchive/QArchive.hpp
@@ -83,7 +82,7 @@ HEADERS += QArchive/QArchive.hpp
 ```
  $ mkdir build
  $ cd build
- $ qmake ../read_archive.pro
+ $ qmake ..
  $ make -j4
  $ ./read_archive
  $ # Make sure you have archive file!

examples/create_archive/create_archive.pro

@@ -3,7 +3,7 @@ TARGET = create_archive
 INCLUDEPATH += . ../../
 DEFINES += QT_DEPRECATED_WARNINGS
 
-QT += core
+QT += core concurrent
 LIBS += -larchive
 SOURCES += main.cpp
 HEADERS += ../../QArchive.hpp

examples/create_archive/main.cpp

@@ -26,7 +26,6 @@ int main(int argc, char** argv)
     });
     QObject::connect(&e, &QArchive::Compressor::error, [&](short code, QString file) {
         qDebug() << "error code:: " << code << " :: " << file;
-        e.terminate();
         app.quit();
     });
     /*

examples/examples.pro

@@ -0,0 +1,4 @@
+TEMPLATE = subdirs
+CONFIG  += ordered
+
+SUBDIRS = create_archive extract_interrupt extract_to extraction read_archive 

examples/extract_interrupt/extract_interrupt.pro

@@ -3,7 +3,7 @@ TARGET = extract_interrupt
 INCLUDEPATH += . ../../
 DEFINES += QT_DEPRECATED_WARNINGS
 
-QT += core
+QT += core concurrent
 LIBS += -larchive
 SOURCES += main.cpp
 HEADERS += ../../QArchive.hpp

examples/extract_interrupt/main.cpp

@@ -19,8 +19,7 @@ int main(int argc, char** argv)
     // emitted when all extraction is finished
     QObject::connect(&e, &QArchive::Extractor::finished, [&]() {
         qDebug() << "Finished all extraction!";
-        e.quit();
-        app.quit();
+	app.quit();
     });
 
     QObject::connect(&e, &QArchive::Extractor::extracting, [&](QString file) {
@@ -32,9 +31,14 @@ int main(int argc, char** argv)
         qDebug() << "Extracted:: " << file;
     });
 
+    QObject::connect(&e, &QArchive::Extractor::stopped,
+    [&](){
+    	qDebug() << "Stopped Successfully!";
+	app.quit();
+    });
+
     // emitted when something goes wrong
     QObject::connect(&e, &QArchive::Extractor::error, [&](short code, QString file) {
-        e.terminate();
         switch(code) {
         case QArchive::ARCHIVE_READ_ERROR:
             qDebug() << "unable to find archive :: " << file;
@@ -50,7 +54,6 @@ int main(int argc, char** argv)
             break;
         default:
             qDebug() << "unknown error. :: " << file;
-            e.wait();
 	    app.quit();
             break;
         }
@@ -63,8 +66,8 @@ int main(int argc, char** argv)
 
     QTimer::singleShot(1000 , &app , 
     [&](){ 
-	qDebug() << "Interruption Request!";
-	e.requestInterruption();
+	qDebug() << "Stopping extraction";
+    	e.stop();
     });
     qDebug() << "Its Non-Blocking!";
 

examples/extract_to/extract_to.pro

@@ -4,7 +4,7 @@ INCLUDEPATH += . ../../
 DEFINES += QT_DEPRECATED_WARNINGS
 
 LIBS += -larchive
-QT   += core
+QT   += core concurrent
 
 SOURCES += main.cpp
 HEADERS += ../../QArchive.hpp