[Scummvm-git-logs] scummvm master -> 032904f626eec3e4942785f0b5c78baea189c097
lephilousophe
noreply at scummvm.org
Sun Oct 30 17:37:21 UTC 2022
This automated email contains information about 5 new commits which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .
Summary:
1f2c78adfe ALL: Make sure str.h is included when using String
1800117031 COMMON: Remove useless str.h inclusion
7021b938e5 COMMON: Add remove type helpers for const and volatile
f0cf08ec91 COMMON: Add move semantics helpers
032904f626 COMMON: Use forward to avoid extraneous copies
Commit: 1f2c78adfe21e352b71b4ec8b27d00f840057c28
https://github.com/scummvm/scummvm/commit/1f2c78adfe21e352b71b4ec8b27d00f840057c28
Author: Le Philousophe (lephilousophe at users.noreply.github.com)
Date: 2022-10-30T18:37:16+01:00
Commit Message:
ALL: Make sure str.h is included when using String
Fix all cases working because str.h is included in util.h
Changed paths:
R devtools/create_xeen/str.h
devtools/create_kyradat/create_kyradat.cpp
devtools/create_kyradat/pak.h
devtools/create_xeen/cc.h
engines/ags/shared/util/string.h
engines/glk/hugo/stringfn.h
engines/mutationofjb/commands/endblockcommand.h
engines/mutationofjb/commands/loadplayercommand.cpp
engines/mutationofjb/commands/loadplayercommand.h
engines/wintermute/debugger/listing.h
diff --git a/devtools/create_kyradat/create_kyradat.cpp b/devtools/create_kyradat/create_kyradat.cpp
index 513939b6ff8..927bfe2a072 100644
--- a/devtools/create_kyradat/create_kyradat.cpp
+++ b/devtools/create_kyradat/create_kyradat.cpp
@@ -23,12 +23,12 @@
#define FORBIDDEN_SYMBOL_ALLOW_ALL
#include "create_kyradat.h"
-#include "resources.h"
-#include "types.h"
+#include "md5.h"
#include "pak.h"
+#include "resources.h"
+#include "types.h"
-#include "md5.h"
#include "common/language.h"
#include "common/platform.h"
diff --git a/devtools/create_kyradat/pak.h b/devtools/create_kyradat/pak.h
index 02c58ad6959..16ec348f6fe 100644
--- a/devtools/create_kyradat/pak.h
+++ b/devtools/create_kyradat/pak.h
@@ -23,6 +23,9 @@
#define KYRA_PAK_H
#include "util.h"
+
+#include "common/str.h"
+
#include <string.h>
class PAKFile {
diff --git a/devtools/create_xeen/cc.h b/devtools/create_xeen/cc.h
index 0dff1257e4f..70a5eae1d30 100644
--- a/devtools/create_xeen/cc.h
+++ b/devtools/create_xeen/cc.h
@@ -23,8 +23,9 @@
#define CC_H
#include "file.h"
-#include "str.h"
+
#include "common/array.h"
+#include "common/str.h"
/**
* Details of a single entry in a CC file index
diff --git a/devtools/create_xeen/str.h b/devtools/create_xeen/str.h
deleted file mode 100644
index 3e73750e485..00000000000
--- a/devtools/create_xeen/str.h
+++ /dev/null
@@ -1,385 +0,0 @@
-/* ScummVM - Graphic Adventure Engine
- *
- * ScummVM is the legal property of its developers, whose names
- * are too numerous to list here. Please refer to the COPYRIGHT
- * file distributed with this source distribution.
- *
- * 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 3 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, see <http://www.gnu.org/licenses/>.
- *
- */
-
-#ifndef COMMON_STRING_H
-#define COMMON_STRING_H
-
-#include "common/scummsys.h"
-
-#include <stdarg.h>
-
-namespace Common {
-
-/**
- * Simple string class for ScummVM. Provides automatic storage managment,
- * and overloads several operators in a 'natural' fashion, mimicking
- * the std::string class. Even provides simple iterators.
- *
- * This class tries to avoid allocating lots of small blocks on the heap,
- * since that is inefficient on several platforms supported by ScummVM.
- * Instead, small strings are stored 'inside' the string object (i.e. on
- * the stack, for stack allocated objects), and only for strings exceeding
- * a certain length do we allocate a buffer on the heap.
- *
- * The presence of \0 characters in the string will cause undefined
- * behavior in some operations.
- */
-class String {
-public:
- static const uint32 npos = 0xFFFFFFFF;
-protected:
- /**
- * The size of the internal storage. Increasing this means less heap
- * allocations are needed, at the cost of more stack memory usage,
- * and of course lots of wasted memory. Empirically, 90% or more of
- * all String instances are less than 32 chars long. If a platform
- * is very short on stack space, it would be possible to lower this.
- * A value of 24 still seems acceptable, though considerably worse,
- * while 16 seems to be the lowest you want to go... Anything lower
- * than 8 makes no sense, since that's the size of member _extern
- * (on 32 bit machines; 12 bytes on systems with 64bit pointers).
- */
- static const uint32 _builtinCapacity = 32 - sizeof(uint32) - sizeof(char *);
-
- /**
- * Length of the string. Stored to avoid having to call strlen
- * a lot. Yes, we limit ourselves to strings shorter than 4GB --
- * on purpose :-).
- */
- uint32 _size;
-
- /**
- * Pointer to the actual string storage. Either points to _storage,
- * or to a block allocated on the heap via malloc.
- */
- char *_str;
-
-
- union {
- /**
- * Internal string storage.
- */
- char _storage[_builtinCapacity];
- /**
- * External string storage data -- the refcounter, and the
- * capacity of the string _str points to.
- */
- struct {
- mutable int *_refCount;
- uint32 _capacity;
- } _extern;
- };
-
- inline bool isStorageIntern() const {
- return _str == _storage;
- }
-
-public:
- /** Construct a new empty string. */
- String() : _size(0), _str(_storage) { _storage[0] = 0; }
-
- /** Construct a new string from the given NULL-terminated C string. */
- String(const char *str);
-
- /** Construct a new string containing exactly len characters read from address str. */
- String(const char *str, uint32 len);
-
- /** Construct a new string containing the characters between beginP (including) and endP (excluding). */
- String(const char *beginP, const char *endP);
-
- /** Construct a copy of the given string. */
- String(const String &str);
-
- /** Construct a string consisting of the given character. */
- explicit String(char c);
-
- ~String();
-
- String &operator=(const char *str);
- String &operator=(const String &str);
- String &operator=(char c);
- String &operator+=(const char *str);
- String &operator+=(const String &str);
- String &operator+=(char c);
-
- bool operator==(const String &x) const;
- bool operator==(const char *x) const;
- bool operator!=(const String &x) const;
- bool operator!=(const char *x) const;
-
- bool operator<(const String &x) const;
- bool operator<=(const String &x) const;
- bool operator>(const String &x) const;
- bool operator>=(const String &x) const;
-
- bool equals(const String &x) const;
- bool equalsIgnoreCase(const String &x) const;
- int compareTo(const String &x) const; // strcmp clone
- int compareToIgnoreCase(const String &x) const; // stricmp clone
-
- bool equals(const char *x) const;
- bool equalsIgnoreCase(const char *x) const;
- int compareTo(const char *x) const; // strcmp clone
- int compareToIgnoreCase(const char *x) const; // stricmp clone
-
- bool hasSuffix(const String &x) const;
- bool hasSuffix(const char *x) const;
-
- bool hasPrefix(const String &x) const;
- bool hasPrefix(const char *x) const;
-
- bool contains(const String &x) const;
- bool contains(const char *x) const;
- bool contains(char x) const;
-
- inline const char *c_str() const { return _str; }
- inline uint size() const { return _size; }
-
- inline bool empty() const { return (_size == 0); }
- char firstChar() const { return (_size > 0) ? _str[0] : 0; }
- char lastChar() const { return (_size > 0) ? _str[_size - 1] : 0; }
-
- char operator[](int idx) const {
- assert(_str && idx >= 0 && idx < (int)_size);
- return _str[idx];
- }
-
- /** Remove the last character from the string. */
- void deleteLastChar();
-
- /** Remove the character at position p from the string. */
- void deleteChar(uint32 p);
-
- /** Remove all characters from position p to the p + len. If len = String::npos, removes all characters to the end */
- void erase(uint32 p, uint32 len = npos);
-
- /** Set character c at position p, replacing the previous character there. */
- void setChar(char c, uint32 p);
-
- /** Insert character c before position p. */
- void insertChar(char c, uint32 p);
-
- /** Clears the string, making it empty. */
- void clear();
-
- /** Convert all characters in the string to lowercase. */
- void toLowercase();
-
- /** Convert all characters in the string to uppercase. */
- void toUppercase();
-
- /**
- * Removes trailing and leading whitespaces. Uses isspace() to decide
- * what is whitespace and what not.
- */
- void trim();
-
- uint hash() const;
-
- /**
- * Print formatted data into a String object. Similar to sprintf,
- * except that it stores the result in (variably sized) String
- * instead of a fixed size buffer.
- */
- static String format(const char *fmt, ...) GCC_PRINTF(1,2);
-
- /**
- * Print formatted data into a String object. Similar to vsprintf,
- * except that it stores the result in (variably sized) String
- * instead of a fixed size buffer.
- */
- static String vformat(const char *fmt, va_list args);
-
-public:
- typedef char value_type;
- /**
- * Unsigned version of the underlying type. This can be used to cast
- * individual string characters to bigger integer types without sign
- * extension happening.
- */
- typedef unsigned char unsigned_type;
- typedef char * iterator;
- typedef const char * const_iterator;
-
- iterator begin() {
- // Since the user could potentially
- // change the string via the returned
- // iterator we have to assure we are
- // pointing to a unique storage.
- makeUnique();
-
- return _str;
- }
-
- iterator end() {
- return begin() + size();
- }
-
- const_iterator begin() const {
- return _str;
- }
-
- const_iterator end() const {
- return begin() + size();
- }
-
-protected:
- void makeUnique();
- void ensureCapacity(uint32 new_size, bool keep_old);
- void incRefCount() const;
- void decRefCount(int *oldRefCount);
- void initWithCStr(const char *str, uint32 len);
-};
-
-// Append two strings to form a new (temp) string
-String operator+(const String &x, const String &y);
-
-String operator+(const char *x, const String &y);
-String operator+(const String &x, const char *y);
-
-String operator+(const String &x, char y);
-String operator+(char x, const String &y);
-
-// Some useful additional comparison operators for Strings
-bool operator==(const char *x, const String &y);
-bool operator!=(const char *x, const String &y);
-
-// Utility functions to remove leading and trailing whitespaces
-extern char *ltrim(char *t);
-extern char *rtrim(char *t);
-extern char *trim(char *t);
-
-
-/**
- * Returns the last component of a given path.
- *
- * Examples:
- * /foo/bar.txt would return 'bar.txt'
- * /foo/bar/ would return 'bar'
- * /foo/./bar// would return 'bar'
- *
- * @param path the path of which we want to know the last component
- * @param sep character used to separate path components
- * @return The last component of the path.
- */
-String lastPathComponent(const String &path, const char sep);
-
-/**
- * Normalize a given path to a canonical form. In particular:
- * - trailing separators are removed: /foo/bar/ -> /foo/bar
- * - double separators (= empty components) are removed: /foo//bar -> /foo/bar
- * - dot components are removed: /foo/./bar -> /foo/bar
- *
- * @todo remove double dot components: /foo/baz/../bar -> /foo/bar
- *
- * @param path the path to normalize
- * @param sep the separator token (usually '/' on Unix-style systems, or '\\' on Windows based stuff)
- * @return the normalized path
- */
-String normalizePath(const String &path, const char sep);
-
-
-/**
- * Simple DOS-style pattern matching function (understands * and ? like used in DOS).
- * Taken from exult/files/listfiles.cc
- *
- * Token meaning:
- * "*": any character, any amount of times.
- * "?": any character, only once.
- * "#": any decimal digit, only once.
- *
- * Example strings/patterns:
- * String: monkey.s01 Pattern: monkey.s?? => true
- * String: monkey.s101 Pattern: monkey.s?? => false
- * String: monkey.s99 Pattern: monkey.s?1 => false
- * String: monkey.s101 Pattern: monkey.s* => true
- * String: monkey.s99 Pattern: monkey.s*1 => false
- * String: monkey.s01 Pattern: monkey.s## => true
- * String: monkey.s01 Pattern: monkey.### => false
- *
- * @param str Text to be matched against the given pattern.
- * @param pat Glob pattern.
- * @param ignoreCase Whether to ignore the case when doing pattern match
- * @param pathMode Whether to use path mode, i.e., whether slashes must be matched explicitly.
- *
- * @return true if str matches the pattern, false otherwise.
- */
-bool matchString(const char *str, const char *pat, bool ignoreCase = false, bool pathMode = false);
-
-
-/**
- * Take a 32 bit value and turn it into a four character string, where each of
- * the four bytes is turned into one character. Most significant byte is printed
- * first.
- */
-String tag2string(uint32 tag);
-
-/**
- * Copy up to size - 1 characters from src to dst and also zero terminate the
- * result. Note that src must be a zero terminated string.
- *
- * In case size is zero this function just returns the length of the source
- * string.
- *
- * @note This is modeled after OpenBSD's strlcpy. See the manpage here:
- * https://man.openbsd.org/strlcpy
- *
- * @param dst The destination buffer.
- * @param src The source string.
- * @param size The size of the destination buffer.
- * @return The length of the (non-truncated) result, i.e. strlen(src).
- */
-size_t strlcpy(char *dst, const char *src, size_t size);
-
-/**
- * Append the string src to the string dst. Note that both src and dst must be
- * zero terminated. The result will be zero terminated. At most
- * "size - strlen(dst) - 1" bytes will be appended.
- *
- * In case the dst string does not contain a zero within the first "size" bytes
- * the dst string will not be changed and size + strlen(src) is returned.
- *
- * @note This is modeled after OpenBSD's strlcat. See the manpage here:
- * https://man.openbsd.org/strlcat
- *
- * @param dst The string the source string should be appended to.
- * @param src The source string.
- * @param size The (total) size of the destination buffer.
- * @return The length of the (non-truncated) result. That is
- * strlen(dst) + strlen(src). In case strlen(dst) > size
- * size + strlen(src) is returned.
- */
-size_t strlcat(char *dst, const char *src, size_t size);
-
-/**
- * Convenience wrapper for tag2string which "returns" a C string.
- * Note: It is *NOT* safe to do anything with the return value other than directly
- * copying or printing it.
- */
-#define tag2str(x) Common::tag2string(x).c_str()
-
-
-} // End of namespace Common
-
-extern int scumm_stricmp(const char *s1, const char *s2);
-extern int scumm_strnicmp(const char *s1, const char *s2, uint n);
-
-#endif
diff --git a/engines/ags/shared/util/string.h b/engines/ags/shared/util/string.h
index 726597f1d98..c83ca59dac9 100644
--- a/engines/ags/shared/util/string.h
+++ b/engines/ags/shared/util/string.h
@@ -46,6 +46,9 @@
#define AGS_SHARED_UTIL_STRING_H
//include <stdarg.h>
+
+#include "common/str.h"
+
#include "ags/lib/std/vector.h"
#include "ags/shared/core/platform.h"
#include "ags/shared/core/types.h"
diff --git a/engines/glk/hugo/stringfn.h b/engines/glk/hugo/stringfn.h
index 031a0b9df33..e83fe3a63a8 100644
--- a/engines/glk/hugo/stringfn.h
+++ b/engines/glk/hugo/stringfn.h
@@ -23,6 +23,7 @@
#define GLK_HUGO_STRINGFN
#include "common/algorithm.h"
+#include "common/str.h"
namespace Glk {
namespace Hugo {
diff --git a/engines/mutationofjb/commands/endblockcommand.h b/engines/mutationofjb/commands/endblockcommand.h
index 6f927c7d2de..9a63124a323 100644
--- a/engines/mutationofjb/commands/endblockcommand.h
+++ b/engines/mutationofjb/commands/endblockcommand.h
@@ -23,8 +23,10 @@
#define MUTATIONOFJB_ENDBLOCKCOMMAND_H
#include "mutationofjb/commands/command.h"
+
#include "common/scummsys.h"
#include "common/array.h"
+#include "common/str.h"
namespace MutationOfJB {
diff --git a/engines/mutationofjb/commands/loadplayercommand.cpp b/engines/mutationofjb/commands/loadplayercommand.cpp
index fe96463a491..e0c8fda8d4e 100644
--- a/engines/mutationofjb/commands/loadplayercommand.cpp
+++ b/engines/mutationofjb/commands/loadplayercommand.cpp
@@ -25,8 +25,6 @@
#include "mutationofjb/gamedata.h"
#include "mutationofjb/script.h"
-#include "common/str.h"
-
/** @file
* "RABLOAD " <apkFrameFirst> " " <apkFrameLast> " " <playerFrameFirst> " " <palIndexFirst> " " <apkFilename>
*
diff --git a/engines/mutationofjb/commands/loadplayercommand.h b/engines/mutationofjb/commands/loadplayercommand.h
index daafea112f3..cc0d3c4cf7d 100644
--- a/engines/mutationofjb/commands/loadplayercommand.h
+++ b/engines/mutationofjb/commands/loadplayercommand.h
@@ -23,9 +23,11 @@
#define MUTATIONOFJB_LOADPLAYERCOMMAND_H
#include "mutationofjb/commands/seqcommand.h"
-#include "common/scummsys.h"
#include "mutationofjb/tasks/task.h"
+#include "common/scummsys.h"
+#include "common/str.h"
+
namespace MutationOfJB {
class ConversationTask;
diff --git a/engines/wintermute/debugger/listing.h b/engines/wintermute/debugger/listing.h
index f5105983930..43c1dc9b4b6 100644
--- a/engines/wintermute/debugger/listing.h
+++ b/engines/wintermute/debugger/listing.h
@@ -23,13 +23,7 @@
#define LISTING_H_
#include "common/array.h"
-
-
-namespace Common {
-
-class String;
-
-}
+#include "common/str.h"
namespace Wintermute {
Commit: 1800117031391afff0c1738918dd5f192fc6a5c1
https://github.com/scummvm/scummvm/commit/1800117031391afff0c1738918dd5f192fc6a5c1
Author: Le Philousophe (lephilousophe at users.noreply.github.com)
Date: 2022-10-30T18:37:16+01:00
Commit Message:
COMMON: Remove useless str.h inclusion
The util.h header must not include str.h as it will get used in it
(inclusion loop).
Changed paths:
common/util.h
diff --git a/common/util.h b/common/util.h
index 4eceaa84996..c098504a552 100644
--- a/common/util.h
+++ b/common/util.h
@@ -23,7 +23,6 @@
#define COMMON_UTIL_H
#include "common/scummsys.h"
-#include "common/str.h"
/**
* @defgroup common_util Util
@@ -123,6 +122,9 @@ template<typename T, size_t N> inline void ARRAYCLEAR(T (&array) [N], const T &v
namespace Common {
+class String;
+class U32String;
+
/**
* @addtogroup common_util
* @{
Commit: 7021b938e58938b515791c1720dc269aceb30528
https://github.com/scummvm/scummvm/commit/7021b938e58938b515791c1720dc269aceb30528
Author: Le Philousophe (lephilousophe at users.noreply.github.com)
Date: 2022-10-30T18:37:16+01:00
Commit Message:
COMMON: Add remove type helpers for const and volatile
Changed paths:
common/util.h
diff --git a/common/util.h b/common/util.h
index c098504a552..f8f0bebcb41 100644
--- a/common/util.h
+++ b/common/util.h
@@ -144,6 +144,47 @@ struct Pair {
}
};
+/**
+ * A set of templates which remove const and/or volatile specifiers.
+ * Use the remove_*_t<T> variants.
+ */
+template<class T> struct remove_cv {
+ typedef T type;
+};
+template<class T> struct remove_cv<const T> {
+ typedef T type;
+};
+template<class T> struct remove_cv<volatile T> {
+ typedef T type;
+};
+template<class T> struct remove_cv<const volatile T> {
+ typedef T type;
+};
+
+template<class T> struct remove_const {
+ typedef T type;
+};
+template<class T> struct remove_const<const T> {
+ typedef T type;
+};
+
+template<class T> struct remove_volatile {
+ typedef T type;
+};
+template<class T> struct remove_volatile<volatile T> {
+ typedef T type;
+};
+
+template<class T>
+using remove_cv_t = typename remove_cv<T>::type;
+template<class T>
+using remove_const_t = typename remove_const<T>::type;
+template<class T>
+using remove_volatile_t = typename remove_volatile<T>::type;
+
+template<class T>
+using remove_reference_t = typename remove_reference<T>::type;
+
/**
* Print a hexdump of the data passed in. The number of bytes per line is
* customizable.
Commit: f0cf08ec914bd65809a361ae7409b6f9cf012c41
https://github.com/scummvm/scummvm/commit/f0cf08ec914bd65809a361ae7409b6f9cf012c41
Author: Le Philousophe (lephilousophe at users.noreply.github.com)
Date: 2022-10-30T18:37:16+01:00
Commit Message:
COMMON: Add move semantics helpers
Changed paths:
common/util.h
diff --git a/common/util.h b/common/util.h
index f8f0bebcb41..60f606a4be0 100644
--- a/common/util.h
+++ b/common/util.h
@@ -175,6 +175,23 @@ template<class T> struct remove_volatile<volatile T> {
typedef T type;
};
+/**
+ * A set of templates which removes the reference over types.
+ * Use remove_reference_t<T> for this.
+ */
+template<class T>
+struct remove_reference {
+ typedef T type;
+};
+template<class T>
+struct remove_reference<T &> {
+ typedef T type;
+};
+template<class T>
+struct remove_reference<T &&> {
+ typedef T type;
+};
+
template<class T>
using remove_cv_t = typename remove_cv<T>::type;
template<class T>
@@ -185,6 +202,19 @@ using remove_volatile_t = typename remove_volatile<T>::type;
template<class T>
using remove_reference_t = typename remove_reference<T>::type;
+/**
+ * A reimplementation of std::move.
+ */
+template<class T>
+constexpr remove_reference_t<T> &&move(T &&t) noexcept {
+ return static_cast<remove_reference_t<T> &&>(t);
+}
+
+template<class T>
+constexpr T&& forward(remove_reference_t<T> &t) noexcept {
+ return static_cast<T &&>(t);
+}
+
/**
* Print a hexdump of the data passed in. The number of bytes per line is
* customizable.
Commit: 032904f626eec3e4942785f0b5c78baea189c097
https://github.com/scummvm/scummvm/commit/032904f626eec3e4942785f0b5c78baea189c097
Author: Le Philousophe (lephilousophe at users.noreply.github.com)
Date: 2022-10-30T18:37:16+01:00
Commit Message:
COMMON: Use forward to avoid extraneous copies
This is more a test than really useful as printf doesn't take objects
with move semantics
Changed paths:
common/ustr.h
diff --git a/common/ustr.h b/common/ustr.h
index 75be1856a99..b6cf316ef4e 100644
--- a/common/ustr.h
+++ b/common/ustr.h
@@ -23,6 +23,7 @@
#define COMMON_USTR_H
#include "common/scummsys.h"
+#include "common/util.h"
#include "common/str-enc.h"
#include "common/base-str.h"
@@ -206,7 +207,7 @@ private:
template<class... TParam>
inline U32String U32String::format(const U32String &fmt, TParam... param) {
- return formatInternal(&fmt, param...);
+ return formatInternal(&fmt, Common::forward<TParam>(param)...);
}
/** Concatenate strings @p x and @p y. */
More information about the Scummvm-git-logs
mailing list