summaryrefslogtreecommitdiffstats
path: root/depends/util/include
diff options
context:
space:
mode:
authorPetr Mrázek <peterix@gmail.com>2013-11-04 02:53:05 +0100
committerPetr Mrázek <peterix@gmail.com>2013-11-04 02:53:05 +0100
commitbb7e8985f6d189de0acac6a1c3033cb16378c1fb (patch)
tree7c2e88c7184a7f5acf5e7a03be5c5f0bf6904113 /depends/util/include
parentd6e4fb29713d6ce55b092c0e22412f6121e7f516 (diff)
downloadMultiMC-bb7e8985f6d189de0acac6a1c3033cb16378c1fb.tar
MultiMC-bb7e8985f6d189de0acac6a1c3033cb16378c1fb.tar.gz
MultiMC-bb7e8985f6d189de0acac6a1c3033cb16378c1fb.tar.lz
MultiMC-bb7e8985f6d189de0acac6a1c3033cb16378c1fb.tar.xz
MultiMC-bb7e8985f6d189de0acac6a1c3033cb16378c1fb.zip
Reformat and (slightly) decruft all the things.
Diffstat (limited to 'depends/util/include')
-rw-r--r--depends/util/include/apputils.h21
-rw-r--r--depends/util/include/cmdutils.h77
-rw-r--r--depends/util/include/libutil_config.h15
-rw-r--r--depends/util/include/osutils.h11
-rw-r--r--depends/util/include/pathutils.h15
-rw-r--r--depends/util/include/siglist.h129
-rw-r--r--depends/util/include/siglist_impl.h156
-rw-r--r--depends/util/include/userutils.h8
8 files changed, 59 insertions, 373 deletions
diff --git a/depends/util/include/apputils.h b/depends/util/include/apputils.h
deleted file mode 100644
index a64adc50..00000000
--- a/depends/util/include/apputils.h
+++ /dev/null
@@ -1,21 +0,0 @@
-/* Copyright 2013 MultiMC Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#ifndef APPUTILS_H
-#define APPUTILS_H
-
-#define STR_VAL(val) # val
-
-#endif // APPUTILS_H
diff --git a/depends/util/include/cmdutils.h b/depends/util/include/cmdutils.h
index bab5a9fa..4705f3ca 100644
--- a/depends/util/include/cmdutils.h
+++ b/depends/util/include/cmdutils.h
@@ -15,8 +15,7 @@
* limitations under the License.
*/
-#ifndef CMDUTILS_H
-#define CMDUTILS_H
+#pragma once
#include <exception>
#include <stdexcept>
@@ -33,8 +32,10 @@
* @brief commandline parsing and processing utilities
*/
-namespace Util {
-namespace Commandline {
+namespace Util
+{
+namespace Commandline
+{
/**
* @brief split a string into argv items like a shell would do
@@ -52,13 +53,13 @@ namespace FlagStyle
{
enum Enum
{
- GNU, /**< --option and -o (GNU Style) */
- Unix, /**< -option and -o (Unix Style) */
+ GNU, /**< --option and -o (GNU Style) */
+ Unix, /**< -option and -o (Unix Style) */
Windows, /**< /option and /o (Windows Style) */
#ifdef Q_OS_WIN32
Default = Windows
#else
- Default = GNU
+ Default = GNU
#endif
};
}
@@ -66,17 +67,17 @@ enum Enum
/**
* @brief The ArgumentStyle enum
*/
-namespace ArgumentStyle
+namespace ArgumentStyle
{
enum Enum
{
- Space, /**< --option=value */
- Equals, /**< --option value */
+ Space, /**< --option=value */
+ Equals, /**< --option value */
SpaceAndEquals, /**< --option[= ]value */
#ifdef Q_OS_WIN32
Default = Equals
#else
- Default = SpaceAndEquals
+ Default = SpaceAndEquals
#endif
};
}
@@ -101,47 +102,47 @@ public:
* @param flagStyle the FlagStyle to use in this Parser
* @param argStyle the ArgumentStyle to use in this Parser
*/
- Parser(FlagStyle::Enum flagStyle = FlagStyle::Default,
+ Parser(FlagStyle::Enum flagStyle = FlagStyle::Default,
ArgumentStyle::Enum argStyle = ArgumentStyle::Default);
-
+
/**
* @brief set the flag style
* @param style
*/
void setFlagStyle(FlagStyle::Enum style);
-
+
/**
* @brief get the flag style
* @return
*/
FlagStyle::Enum flagStyle();
-
+
/**
* @brief set the argument style
* @param style
*/
void setArgumentStyle(ArgumentStyle::Enum style);
-
+
/**
* @brief get the argument style
* @return
*/
ArgumentStyle::Enum argumentStyle();
-
+
/**
* @brief define a boolean switch
* @param name the parameter name
* @param def the default value
*/
void addSwitch(QString name, bool def = false);
-
+
/**
* @brief define an option that takes an additional argument
* @param name the parameter name
* @param def the default value
*/
void addOption(QString name, QVariant def = QVariant());
-
+
/**
* @brief define a positional argument
* @param name the parameter name
@@ -149,7 +150,7 @@ public:
* @param def the default value
*/
void addArgument(QString name, bool required = true, QVariant def = QVariant());
-
+
/**
* @brief adds a flag to an existing parameter
* @param name the (existing) parameter name
@@ -158,7 +159,7 @@ public:
* Note: any one parameter can only have one flag
*/
void addShortOpt(QString name, QChar flag);
-
+
/**
* @brief adds documentation to a Parameter
* @param name the parameter name
@@ -168,7 +169,7 @@ public:
* on options , metavar replaces the value placeholder
*/
void addDocumentation(QString name, QString doc, QString metavar = QString());
-
+
/**
* @brief generate a help message
* @param progName the program name to use in the help message
@@ -177,7 +178,7 @@ public:
* @return a help message
*/
QString compileHelp(QString progName, int helpIndent = 22, bool flagsInUsage = true);
-
+
/**
* @brief generate a short usage message
* @param progName the program name to use in the usage message
@@ -185,21 +186,21 @@ public:
* @return a usage message
*/
QString compileUsage(QString progName, bool useFlags = true);
-
+
/**
* @brief parse
* @param argv a QStringList containing the program ARGV
* @return a QHash mapping argument names to their values
*/
QHash<QString, QVariant> parse(QStringList argv);
-
+
/**
* @brief clear all definitions
*/
void clear();
-
+
~Parser();
-
+
private:
FlagStyle::Enum m_flagStyle;
ArgumentStyle::Enum m_argStyle;
@@ -209,16 +210,18 @@ private:
otSwitch,
otOption
};
-
+
// Important: the common part MUST BE COMMON ON ALL THREE structs
- struct CommonDef {
+ struct CommonDef
+ {
QString name;
QString doc;
QString metavar;
QVariant def;
};
-
- struct OptionDef {
+
+ struct OptionDef
+ {
// common
QString name;
QString doc;
@@ -228,8 +231,9 @@ private:
OptionType type;
QChar flag;
};
-
- struct PositionalDef {
+
+ struct PositionalDef
+ {
// common
QString name;
QString doc;
@@ -238,17 +242,14 @@ private:
// positional
bool required;
};
-
+
QHash<QString, OptionDef *> m_options;
QHash<QChar, OptionDef *> m_flags;
QHash<QString, CommonDef *> m_params;
QList<PositionalDef *> m_positionals;
QList<OptionDef *> m_optionList;
-
+
void getPrefix(QString &opt, QString &flag);
};
-
}
}
-
-#endif // CMDUTILS_H
diff --git a/depends/util/include/libutil_config.h b/depends/util/include/libutil_config.h
index 914337ed..56b33b74 100644
--- a/depends/util/include/libutil_config.h
+++ b/depends/util/include/libutil_config.h
@@ -3,7 +3,7 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
@@ -18,12 +18,11 @@
#include <QtCore/QtGlobal>
#ifdef LIBUTIL_STATIC
- #define LIBUTIL_EXPORT
+#define LIBUTIL_EXPORT
+#else
+#ifdef LIBUTIL_LIBRARY
+#define LIBUTIL_EXPORT Q_DECL_EXPORT
#else
- #ifdef LIBUTIL_LIBRARY
- #define LIBUTIL_EXPORT Q_DECL_EXPORT
- #else
- #define LIBUTIL_EXPORT Q_DECL_IMPORT
- #endif
+#define LIBUTIL_EXPORT Q_DECL_IMPORT
+#endif
#endif
-
diff --git a/depends/util/include/osutils.h b/depends/util/include/osutils.h
index c5d4bb61..d615d31f 100644
--- a/depends/util/include/osutils.h
+++ b/depends/util/include/osutils.h
@@ -3,7 +3,7 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
@@ -13,17 +13,14 @@
* limitations under the License.
*/
-#ifndef OSUTILS_H
-#define OSUTILS_H
+#pragma once
#include <QString>
#if defined _WIN32 | defined _WIN64
-#define WINDOWS 1
-#elif __APPLE__ & __MACH__
+#define WINDOWS 1
+#elif __APPLE__ &__MACH__
#define OSX 1
#elif __linux__
#define LINUX 1
#endif
-
-#endif // OSUTILS_H
diff --git a/depends/util/include/pathutils.h b/depends/util/include/pathutils.h
index c892c115..45c2a6de 100644
--- a/depends/util/include/pathutils.h
+++ b/depends/util/include/pathutils.h
@@ -3,7 +3,7 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
@@ -13,8 +13,7 @@
* limitations under the License.
*/
-#ifndef PATHUTILS_H
-#define PATHUTILS_H
+#pragma once
#include <QString>
@@ -27,10 +26,10 @@ LIBUTIL_EXPORT QString AbsolutePath(QString path);
/**
* Normalize path
- *
+ *
* Any paths inside the current directory will be normalized to relative paths (to current)
* Other paths will be made absolute
- *
+ *
* Returns false if the path logic somehow filed (and normalizedPath in invalid)
*/
QString NormalizePath(QString path);
@@ -54,9 +53,7 @@ LIBUTIL_EXPORT bool ensureFolderPathExists(QString filenamepath);
LIBUTIL_EXPORT bool copyPath(QString src, QString dst);
/// Opens the given file in the default application.
-LIBUTIL_EXPORT void openFileInDefaultProgram ( QString filename );
+LIBUTIL_EXPORT void openFileInDefaultProgram(QString filename);
/// Opens the given directory in the default application.
-LIBUTIL_EXPORT void openDirInDefaultProgram ( QString dirpath, bool ensureExists = false );
-
-#endif // PATHUTILS_H
+LIBUTIL_EXPORT void openDirInDefaultProgram(QString dirpath, bool ensureExists = false);
diff --git a/depends/util/include/siglist.h b/depends/util/include/siglist.h
deleted file mode 100644
index 24b1a889..00000000
--- a/depends/util/include/siglist.h
+++ /dev/null
@@ -1,129 +0,0 @@
-/* Copyright 2013 MultiMC Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#ifndef SIGLIST_H
-#define SIGLIST_H
-
-#include <QObject>
-#include <QList>
-
-// A QList that allows emitting signals when the list changes.
-// Since QObject doesn't support templates, to use this class with a
-// certain type, you should create a class deriving from SigList<T> and then
-// call the DEFINE_SIGLIST_SIGNALS(T) and SETUP_SIGLIST_SIGNALS(T) macros.
-template <typename T>
-class SigList : public QList<T>
-{
-public:
- explicit SigList() : QList<T>() {}
-
- virtual void append(const T &value);
- virtual void append(const QList<T> &other);
-
- virtual void clear();
-
- virtual void erase(typename QList<T>::iterator pos);
- virtual void erase(typename QList<T>::iterator first, typename QList<T>::iterator last);
-
- virtual void insert(int i, const T &t);
- virtual void insert(typename QList<T>::iterator before, const T &t);
-
- virtual void move(int from, int to);
-
- virtual void pop_back() { takeLast(); }
- virtual void pop_front() { takeFirst(); }
-
- virtual void push_back(const T &t) { append(t); }
- virtual void push_front(const T &t) { prepend(t); }
-
- virtual void prepend(const T &t);
-
- virtual int removeAll(const T &t);
- virtual bool removeOne(const T &t);
-
- virtual void removeAt(int i) { takeAt(i); }
- virtual void removeFirst() { takeFirst(); }
- virtual void removeLast() { takeLast(); }
-
- virtual void swap(QList<T> &other);
- virtual void swap(int i, int j);
-
- virtual T takeAt(int i);
- virtual T takeFirst();
- virtual T takeLast();
-
- virtual QList<T> &operator +=(const QList<T> &other) { append(other); return *this; }
- virtual QList<T> &operator +=(const T &value) { append(value); return *this; }
- virtual QList<T> &operator <<(const QList<T> &other) { append(other); return *this; }
- virtual QList<T> &operator <<(const T &value) { append(value); return *this; }
-
- virtual QList<T> &operator =(const QList<T> &other);
-
-protected:
- // Signal emitted after an item is added to the list.
- // Contains a reference to item and the item's new index.
- virtual void onItemAdded(const T &item, int index) = 0;
-
- // Signal emitted after multiple items are added to the list at once.
- // The items parameter is a const reference to a QList of the items that
- // were added.
- // The firstIndex parameter is the new index of the first item added.
- virtual void onItemsAdded(const QList<T> &items, int firstIndex) = 0;
-
- // Signal emitted after an item is removed to the list.
- // Contains a reference to the item and the item's old index.
- virtual void onItemRemoved(const T &item, int index) = 0;
-
- // Signal emitted after multiple items are removed from the list at once.
- // The items parameter is a const reference to a QList of the items that
- // were added.
- // The firstIndex parameter is the new index of the first item added.
- virtual void onItemsRemoved(const QList<T> &items, int firstIndex) = 0;
-
- // Signal emitted after an item is moved to another index.
- // Contains the item, the old index, and the new index.
- virtual void onItemMoved(const T &item, int oldIndex, int newIndex) = 0;
-
- // Signal emitted after an operation that changes the whole list occurs.
- // This signal should be treated as if all data in the entire list was cleared
- // and new data added in its place.
- virtual void onInvalidated() = 0;
-};
-
-// Defines the signals for a SigList
-#define DEFINE_SIGLIST_SIGNALS(TYPE) \
- Q_SIGNAL void itemAdded(TYPE const &item, int index);\
- Q_SIGNAL void itemsAdded(const QList<TYPE> &items, int firstIndex);\
- Q_SIGNAL void itemRemoved(TYPE const &item, int index);\
- Q_SIGNAL void itemsRemoved(const QList<TYPE> &items, int firstIndex);\
- Q_SIGNAL void itemMoved(TYPE const &item, int oldIndex, int newIndex);\
- Q_SIGNAL void invalidated();
-
-// Overrides the onItem* functions and causes them to emit their corresponding
-// signals.
-#define SETUP_SIGLIST_SIGNALS(TYPE) \
- virtual void onItemAdded(TYPE const &item, int index)\
- { emit itemAdded(item, index); }\
- virtual void onItemsAdded(const QList<TYPE> &items, int firstIndex)\
- { emit itemsAdded(items, firstIndex); }\
- virtual void onItemRemoved(TYPE const &item, int index)\
- { emit itemRemoved(item, index); }\
- virtual void onItemsRemoved(const QList<TYPE> &items, int firstIndex)\
- { emit itemsRemoved(items, firstIndex); }\
- virtual void onItemMoved(TYPE const &item, int oldIndex, int newIndex)\
- { emit itemMoved(item, oldIndex, newIndex); }\
- virtual void onInvalidated() { emit invalidated(); }
-
-#endif // SIGLIST_H
diff --git a/depends/util/include/siglist_impl.h b/depends/util/include/siglist_impl.h
deleted file mode 100644
index 5cdc632a..00000000
--- a/depends/util/include/siglist_impl.h
+++ /dev/null
@@ -1,156 +0,0 @@
-/* Copyright 2013 MultiMC Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#include "siglist.h"
-
-template <typename T>
-void SigList<T>::append(const T &value)
-{
- QList<T>::append(value);
- onItemAdded(value, QList<T>::length() - 1);
-}
-
-template <typename T>
-void SigList<T>::prepend(const T &value)
-{
- QList<T>::prepend(value);
- onItemAdded(value, 0);
-}
-
-template <typename T>
-void SigList<T>::append(const QList<T> &other)
-{
- int index = QList<T>::length();
- QList<T>::append(other);
- onItemsAdded(other, index);
-}
-
-template <typename T>
-void SigList<T>::clear()
-{
- QList<T>::clear();
- onInvalidated();
-}
-
-template <typename T>
-void SigList<T>::erase(typename QList<T>::iterator pos)
-{
- T value = *pos;
- int index = QList<T>::indexOf(*pos);
- QList<T>::erase(pos);
- onItemRemoved(value, index);
-}
-
-template <typename T>
-void SigList<T>::erase(typename QList<T>::iterator first, typename QList<T>::iterator last)
-{
- QList<T> removedValues;
- int firstIndex = QList<T>::indexOf(*first);
-
- for (auto iter = first; iter < last; iter++)
- {
- removedValues << *iter;
- QList<T>::erase(iter);
- }
-
- onItemsRemoved(removedValues, firstIndex);
-}
-
-template <typename T>
-void SigList<T>::insert(int i, const T &t)
-{
- QList<T>::insert(i, t);
- onItemAdded(t, i);
-}
-
-template <typename T>
-void SigList<T>::insert(typename QList<T>::iterator before, const T &t)
-{
- QList<T>::insert(before, t);
- onItemAdded(t, QList<T>::indexOf(t));
-}
-
-template <typename T>
-void SigList<T>::move(int from, int to)
-{
- const T &item = QList<T>::at(from);
- QList<T>::move(from, to);
- onItemMoved(item, from, to);
-}
-
-template <typename T>
-int SigList<T>::removeAll(const T &t)
-{
- int retVal = QList<T>::removeAll(t);
- onInvalidated();
- return retVal;
-}
-
-template <typename T>
-bool SigList<T>::removeOne(const T &t)
-{
- int index = QList<T>::indexOf(t);
- if (QList<T>::removeOne(t))
- {
- onItemRemoved(t, index);
- return true;
- }
- return false;
-}
-
-template <typename T>
-void SigList<T>::swap(QList<T> &other)
-{
- QList<T>::swap(other);
- onInvalidated();
-}
-
-template <typename T>
-void SigList<T>::swap(int i, int j)
-{
- const T &item1 = QList<T>::at(i);
- const T &item2 = QList<T>::at(j);
- QList<T>::swap(i, j);
- onItemMoved(item1, i, j);
- onItemMoved(item2, j, i);
-}
-
-template <typename T>
-T SigList<T>::takeAt(int i)
-{
- T val = QList<T>::takeAt(i);
- onItemRemoved(val, i);
- return val;
-}
-
-template <typename T>
-T SigList<T>::takeFirst()
-{
- return takeAt(0);
-}
-
-template <typename T>
-T SigList<T>::takeLast()
-{
- return takeAt(QList<T>::length() - 1);
-}
-
-template <typename T>
-QList<T> &SigList<T>::operator =(const QList<T> &other)
-{
- QList<T>::operator =(other);
- onInvalidated();
- return *this;
-}
diff --git a/depends/util/include/userutils.h b/depends/util/include/userutils.h
index 4f2760b1..6ce08bce 100644
--- a/depends/util/include/userutils.h
+++ b/depends/util/include/userutils.h
@@ -1,5 +1,4 @@
-#ifndef USERUTILS_H
-#define USERUTILS_H
+#pragma once
#include <QString>
@@ -13,7 +12,6 @@ LIBUTIL_EXPORT QString getDesktopDir();
// Create a shortcut at *location*, pointing to *dest* called with the arguments *args*
// call it *name* and assign it the icon *icon*
// return true if operation succeeded
-LIBUTIL_EXPORT bool createShortCut(QString location, QString dest, QStringList args, QString name, QString iconLocation);
+LIBUTIL_EXPORT bool createShortCut(QString location, QString dest, QStringList args,
+ QString name, QString iconLocation);
}
-
-#endif // USERUTILS_H