Qt: Move utils to separate utils directory

Following the move for widgets directory, moving utils
to the utils directory. Guidelines for this directory are:

 - Generic use but not a widget
 - Utility functionality used by many classes
 
 Note: additionally all includes affected by this move have been changed
 to absolute path includes, instead of relative ones.

Change-Id: I019ae4b6e6f6d06a5745a63ed195edbd36fb936b
Reviewed-on: https://code.wireshark.org/review/22602
Petri-Dish: Roland Knall <rknall@gmail.com>
Reviewed-by: Roland Knall <rknall@gmail.com>

1 files changed, 273 insertions, 0 deletions

diff --git a/ui/qt/utils/qt_ui_utils.cpp b/ui/qt/utils/qt_ui_utils.cpp
new file mode 100644
index 0000000000..46debbcd14
--- /dev/null
+++ b/ui/qt/utils/qt_ui_utils.cpp
@@ -0,0 +1,273 @@
+/* qt_ui_utils.cpp
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * Copyright 1998 Gerald Combs
+ *
+ * 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.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include <ui/qt/utils/qt_ui_utils.h>
+
+#include <epan/addr_resolv.h>
+#include <epan/range.h>
+#include <epan/to_str.h>
+#include <epan/value_string.h>
+
+#include <ui/recent.h>
+#include <ui/ui_util.h>
+
+#include <wsutil/str_util.h>
+
+#include <QAction>
+#include <QApplication>
+#include <QDateTime>
+#include <QDesktopServices>
+#include <QDesktopWidget>
+#include <QDir>
+#include <QFileInfo>
+#include <QFontDatabase>
+#include <QProcess>
+#include <QUrl>
+#include <QUuid>
+
+#if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
+// Qt::escape
+#include <QTextDocument>
+#endif
+
+/* Make the format_size_flags_e enum usable in C++ */
+format_size_flags_e operator|(format_size_flags_e lhs, format_size_flags_e rhs) {
+    return (format_size_flags_e) ((int)lhs| (int)rhs);
+}
+
+/*
+ * We might want to create our own "wsstring" class with convenience
+ * methods for handling g_malloc()ed strings, GStrings, and a shortcut
+ * to .toUtf8().constData().
+ */
+
+gchar *qstring_strdup(QString q_string) {
+    return g_strdup(q_string.toUtf8().constData());
+}
+
+QString gchar_free_to_qstring(gchar *glib_string) {
+    return QString(gchar_free_to_qbytearray(glib_string));
+}
+
+QByteArray gchar_free_to_qbytearray(gchar *glib_string)
+{
+    QByteArray qt_bytearray(glib_string);
+    g_free(glib_string);
+    return qt_bytearray;
+}
+
+QByteArray gstring_free_to_qbytearray(GString *glib_gstring)
+{
+    QByteArray qt_ba(glib_gstring->str);
+    g_string_free(glib_gstring, TRUE);
+    return qt_ba;
+}
+
+const QString int_to_qstring(qint64 value, int field_width, int base)
+{
+    // Qt deprecated QString::sprintf in Qt 5.0, then added ::asprintf in
+    // Qt 5.5. Rather than navigate a maze of QT_VERSION_CHECKs, just use
+    // QString::arg.
+    QString int_qstr;
+
+    switch (base) {
+    case 8:
+        int_qstr = "0";
+        break;
+    case 16:
+        int_qstr = "0x";
+        break;
+    default:
+        break;
+    }
+
+    int_qstr += QString("%1").arg(value, field_width, base, QChar('0'));
+    return int_qstr;
+}
+
+const QString address_to_qstring(const _address *address, bool enclose)
+{
+    QString address_qstr = QString();
+    if (address) {
+        if (enclose && address->type == AT_IPv6) address_qstr += "[";
+        gchar *address_gchar_p = address_to_str(NULL, address);
+        address_qstr += address_gchar_p;
+        wmem_free(NULL, address_gchar_p);
+        if (enclose && address->type == AT_IPv6) address_qstr += "]";
+    }
+    return address_qstr;
+}
+
+const QString address_to_display_qstring(const _address *address)
+{
+    QString address_qstr = QString();
+    if (address) {
+        gchar *address_gchar_p = address_to_display(NULL, address);
+        address_qstr = address_gchar_p;
+        wmem_free(NULL, address_gchar_p);
+    }
+    return address_qstr;
+}
+
+const QString val_to_qstring(const guint32 val, const value_string *vs, const char *fmt)
+{
+    QString val_qstr = QString();
+    gchar* gchar_p = val_to_str_wmem(NULL, val, vs, fmt);
+    val_qstr = gchar_p;
+    wmem_free(NULL, gchar_p);
+
+    return val_qstr;
+}
+
+const QString val_ext_to_qstring(const guint32 val, value_string_ext *vse, const char *fmt)
+{
+    QString val_qstr = QString();
+    gchar* gchar_p = val_to_str_ext_wmem(NULL, val, vse, fmt);
+    val_qstr = gchar_p;
+    wmem_free(NULL, gchar_p);
+
+    return val_qstr;
+}
+
+const QString range_to_qstring(const epan_range *range)
+{
+    QString range_qstr = QString();
+    if (range) {
+        gchar *range_gchar_p = range_convert_range(NULL, range);
+        range_qstr = range_gchar_p;
+        wmem_free(NULL, range_gchar_p);
+    }
+    return range_qstr;
+}
+
+const QString bits_s_to_qstring(const double bits_s)
+{
+    return gchar_free_to_qstring(
+                format_size(bits_s, format_size_unit_none|format_size_prefix_si));
+}
+
+const QString file_size_to_qstring(const gint64 size)
+{
+    return gchar_free_to_qstring(
+                format_size(size, format_size_unit_bytes|format_size_prefix_si));
+}
+
+const QString time_t_to_qstring(time_t ti_time)
+{
+    QDateTime date_time = QDateTime::fromTime_t(uint(ti_time));
+    QString time_str = date_time.toLocalTime().toString("yyyy-MM-dd hh:mm:ss");
+    return time_str;
+}
+
+QString html_escape(const QString plain_string) {
+#if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
+    return Qt::escape(plain_string);
+#else
+    return plain_string.toHtmlEscaped();
+#endif
+}
+
+
+void smooth_font_size(QFont &font) {
+    QFontDatabase fdb;
+    QList<int> size_list = fdb.smoothSizes(font.family(), font.styleName());
+
+    if (size_list.size() < 2) return;
+
+    int last_size = size_list.takeFirst();
+    foreach (int cur_size, size_list) {
+        if (font.pointSize() > last_size && font.pointSize() <= cur_size) {
+            font.setPointSize(cur_size);
+            return;
+        }
+        last_size = cur_size;
+    }
+}
+
+bool qActionLessThan(const QAction * a1, const QAction * a2) {
+    return a1->text().compare(a2->text()) < 0;
+}
+
+bool qStringCaseLessThan(const QString &s1, const QString &s2)
+{
+    return s1.compare(s2, Qt::CaseInsensitive) < 0;
+}
+
+// http://stackoverflow.com/questions/3490336/how-to-reveal-in-finder-or-show-in-explorer-with-qt
+void desktop_show_in_folder(const QString file_path)
+{
+    bool success = false;
+
+#if defined(Q_OS_WIN)
+    QString path = QDir::toNativeSeparators(file_path);
+    QString command = "explorer.exe /select," + path;
+    success = QProcess::startDetached(command);
+#elif defined(Q_OS_MAC)
+    QStringList script_args;
+    QString escaped_path = file_path;
+
+    escaped_path.replace('"', "\\\"");
+    script_args << "-e"
+               << QString("tell application \"Finder\" to reveal POSIX file \"%1\"")
+                                     .arg(escaped_path);
+    if (QProcess::execute("/usr/bin/osascript", script_args) == 0) {
+        success = true;
+        script_args.clear();
+        script_args << "-e"
+                   << "tell application \"Finder\" to activate";
+        QProcess::execute("/usr/bin/osascript", script_args);
+    }
+#else
+    // Is there a way to highlight the file using xdg-open?
+#endif
+    if (!success) { // Last resort
+        QFileInfo file_info = file_path;
+        QDesktopServices::openUrl(QUrl::fromLocalFile(file_info.dir().absolutePath()));
+    }
+}
+
+bool rect_on_screen(const QRect &rect)
+{
+    QDesktopWidget *desktop = qApp->desktop();
+    for (int i = 0; i < desktop->screenCount(); i++) {
+        if (desktop->availableGeometry(i).contains(rect))
+            return true;
+    }
+
+    return false;
+}
+
+/*
+ * Editor modelines
+ *
+ * Local Variables:
+ * c-basic-offset: 4
+ * tab-width: 8
+ * indent-tabs-mode: nil
+ * End:
+ *
+ * ex: set shiftwidth=4 tabstop=8 expandtab:
+ * :indentSize=4:tabSize=8:noTabs=true:
+ */