OpenSearch review

- file headers fix
- clean up code
- import engine files

1 files changed, 73 insertions, 49 deletions

diff --git a/src/search/opensearchwriter.cpp b/src/search/opensearchwriter.cpp
index a18ce0e2..81ce022c 100644
--- a/src/search/opensearchwriter.cpp
+++ b/src/search/opensearchwriter.cpp
@@ -1,29 +1,44 @@
-/*
- * Copyright 2009 Jakub Wieczorek <faw217@gmail.com>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * 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 General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor,
- * Boston, MA  02110-1301  USA
- */
-
+/* ============================================================
+*
+* This file is a part of the rekonq project
+*
+* Copyright (C) 2009 by Jakub Wieczorek <faw217@gmail.com>
+* Copyright (C) 2010 by Lionel Chauvin <megabigbug@yahoo.fr>
+* Copyright (C) 2010 by Andrea Diamantini <adjam7 at gmail dot com>
+*
+*
+* This program is free software; you can redistribute it and/or
+* modify it under the terms of the GNU General Public License as
+* published by the Free Software Foundation; either version 2 of
+* the License or (at your option) version 3 or any later version
+* accepted by the membership of KDE e.V. (or its successor approved
+* by the membership of KDE e.V.), which shall act as a proxy
+* defined in Section 14 of version 3 of the license.
+*
+* 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 General Public License
+* along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*
+* ============================================================ */
+
+
+// Self Includes
 #include "opensearchwriter.h"
 
+// Local Includes
 #include "opensearchengine.h"
 
+// KDE Includes
+#include <KDebug>
+
+// Qt Includes
 #include <QtCore/QIODevice>
 
-#include <KDebug>
+
 
 OpenSearchWriter::OpenSearchWriter()
     : QXmlStreamWriter()
@@ -31,6 +46,7 @@ OpenSearchWriter::OpenSearchWriter()
     setAutoFormatting(true);
 }
 
+
 bool OpenSearchWriter::write(QIODevice *device, OpenSearchEngine *engine)
 {
     if (!engine)
@@ -44,34 +60,40 @@ bool OpenSearchWriter::write(QIODevice *device, OpenSearchEngine *engine)
     return true;
 }
 
+
 void OpenSearchWriter::write(OpenSearchEngine *engine)
 {
     writeStartDocument();
-    writeStartElement(QLatin1String("OpenSearchDescription"));
-    writeDefaultNamespace(QLatin1String("http://a9.com/-/spec/opensearch/1.1/"));
+    writeStartElement(QL1S("OpenSearchDescription"));
+    writeDefaultNamespace(QL1S("http://a9.com/-/spec/opensearch/1.1/"));
 
-    if (!engine->name().isEmpty()) {
-        writeTextElement(QLatin1String("ShortName"), engine->name());
+    if (!engine->name().isEmpty()) 
+    {
+        writeTextElement(QL1S("ShortName"), engine->name());
     }
 
-    if (!engine->description().isEmpty()) {
-        writeTextElement(QLatin1String("Description"), engine->description());
+    if (!engine->description().isEmpty()) 
+    {
+        writeTextElement(QL1S("Description"), engine->description());
     }
 
-    if (!engine->searchUrlTemplate().isEmpty()) {
-        writeStartElement(QLatin1String("Url"));
-        writeAttribute(QLatin1String("method"), QLatin1String("get"));
-        writeAttribute(QLatin1String("template"), engine->searchUrlTemplate());
+    if (!engine->searchUrlTemplate().isEmpty()) 
+    {
+        writeStartElement(QL1S("Url"));
+        writeAttribute(QL1S("method"), QL1S("get"));
+        writeAttribute(QL1S("template"), engine->searchUrlTemplate());
 
-        if (!engine->searchParameters().empty()) {
-            writeNamespace(QLatin1String("http://a9.com/-/spec/opensearch/extensions/parameters/1.0/"), QLatin1String("p"));
+        if (!engine->searchParameters().empty()) 
+        {
+            writeNamespace(QL1S("http://a9.com/-/spec/opensearch/extensions/parameters/1.0/"), QL1S("p"));
 
             QList<OpenSearchEngine::Parameter>::const_iterator end = engine->searchParameters().constEnd();
             QList<OpenSearchEngine::Parameter>::const_iterator i = engine->searchParameters().constBegin();
-            for (; i != end; ++i) {
-                writeStartElement(QLatin1String("p:Parameter"));
-                writeAttribute(QLatin1String("name"), i->first);
-                writeAttribute(QLatin1String("value"), i->second);
+            for (; i != end; ++i) 
+            {
+                writeStartElement(QL1S("p:Parameter"));
+                writeAttribute(QL1S("name"), i->first);
+                writeAttribute(QL1S("value"), i->second);
                 writeEndElement();
             }
         }
@@ -79,21 +101,24 @@ void OpenSearchWriter::write(OpenSearchEngine *engine)
         writeEndElement();
     }
 
-    if (!engine->suggestionsUrlTemplate().isEmpty()) {
-        writeStartElement(QLatin1String("Url"));
-        writeAttribute(QLatin1String("method"), QLatin1String("get"));
-        writeAttribute(QLatin1String("type"), QLatin1String("application/x-suggestions+json"));
-        writeAttribute(QLatin1String("template"), engine->suggestionsUrlTemplate());
+    if (!engine->suggestionsUrlTemplate().isEmpty()) 
+    {
+        writeStartElement(QL1S("Url"));
+        writeAttribute(QL1S("method"), QL1S("get"));
+        writeAttribute(QL1S("type"), QL1S("application/x-suggestions+json"));
+        writeAttribute(QL1S("template"), engine->suggestionsUrlTemplate());
 
-        if (!engine->suggestionsParameters().empty()) {
-            writeNamespace(QLatin1String("http://a9.com/-/spec/opensearch/extensions/parameters/1.0/"), QLatin1String("p"));
+        if (!engine->suggestionsParameters().empty()) 
+        {
+            writeNamespace(QL1S("http://a9.com/-/spec/opensearch/extensions/parameters/1.0/"), QL1S("p"));
 
             QList<OpenSearchEngine::Parameter>::const_iterator end = engine->suggestionsParameters().constEnd();
             QList<OpenSearchEngine::Parameter>::const_iterator i = engine->suggestionsParameters().constBegin();
-            for (; i != end; ++i) {
-                writeStartElement(QLatin1String("p:Parameter"));
-                writeAttribute(QLatin1String("name"), i->first);
-                writeAttribute(QLatin1String("value"), i->second);
+            for (; i != end; ++i) 
+            {
+                writeStartElement(QL1S("p:Parameter"));
+                writeAttribute(QL1S("name"), i->first);
+                writeAttribute(QL1S("value"), i->second);
                 writeEndElement();
             }
         }
@@ -102,9 +127,8 @@ void OpenSearchWriter::write(OpenSearchEngine *engine)
     }
 
     if (!engine->imageUrl().isEmpty())
-        writeTextElement(QLatin1String("Image"), engine->imageUrl());
+        writeTextElement(QL1S("Image"), engine->imageUrl());
 
     writeEndElement();
     writeEndDocument();
 }
-